46.2. 生成的 API 子项目
概述
假设您在 第 46.1 节 “使用 Maven Archetype 生成代码” 中生成了新的 Maven 项目,您现在可以找到用于在 camel-api-example/camel-api-example-api
项目目录下打包 Java API 的 Maven 子项目。在本节中,我们会仔细查看生成的示例代码,并描述其工作原理。
Java API 示例
生成的示例代码包含了一个 Java API 示例,它基于该示例 API 组件。示例 Java API 相对简单,仅包含两个 Hello World 类: ExampleJavadocHello
和 ExampleFileHello
。
ExampleJavadocHello 类
例 46.1 “ExampleJavadocHello 类” 显示示例 Java API 中的 ExampleJavadocHello
类。根据课程的名称,此特定类用于显示如何从 Javadoc 提供映射元数据。
例 46.1. ExampleJavadocHello 类
// Java package org.jboss.fuse.example.api; /** * Sample API used by Example Component whose method signatures are read from Javadoc. */ public class ExampleJavadocHello { public String sayHi() { return "Hello!"; } public String greetMe(String name) { return "Hello " + name; } public String greetUs(String name1, String name2) { return "Hello " + name1 + ", " + name2; } }
ExampleFileHello class
例 46.2 “ExampleFileHello class” 显示示例 Java API 中的 ExampleFileHello
类。根据分类的名称,此特定类用于显示如何从签名文件中提供映射元数据。
例 46.2. ExampleFileHello class
// Java package org.jboss.fuse.example.api; /** * Sample API used by Example Component whose method signatures are read from File. */ public class ExampleFileHello { public String sayHi() { return "Hello!"; } public String greetMe(String name) { return "Hello " + name; } public String greetUs(String name1, String name2) { return "Hello " + name1 + ", " + name2; } }
为 ExampleJavadocHello 生成 Javadoc 元数据
由于 ExampleJavadocHello
的元数据已作为 Javadoc 提供,因此需要为示例 Java API 生成 Javadoc,并将它安装到 camel-api-example-api
Maven 工件中。API POM 文件( camel-api-example-api/pom.xml
)配置 maven-javadoc-plugin
,以在 Maven 构建过程中自动执行此步骤。