46.2. 生成的 API 子项目
概述
假设您生成了新的 Maven 项目,如 第 46.1 节 “使用 Maven Archetype 生成代码” 所述,您现在可以找到 Maven 子项目,用于将 Java API 打包到 camel-api-example/camel-api-example-api
项目目录中。在本节中,我们仔细查看生成的示例代码,并描述它的工作原理。
Java API 示例
生成的示例代码包含一个示例 Java API,其示例 API 组件基于它。示例 Java API 相对简单,它由两个 Hello World 类组成: ExampleJavadocHello
和 ExampleFileHello
。
JavadocHello 类示例
例 46.1 “JavadocHello 类示例” 显示示例 Java API 中的 ExampleJavadocHello
类。作为类名称建议,此特定类用于显示如何提供 Javadoc 中的映射元数据。
例 46.1. JavadocHello 类示例
// 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 构建期间自动执行这个步骤。