第 47 章 配置 API 组件 Maven 插件

API 组件 Maven 插件 camel-api-component-maven-plugin 的主要目的是生成 API 映射类，它实现端点 URI 和 API 方法调用之间的映射。通过编辑 API 组件 Maven 插件的配置，您可以自定义 API 映射的各个方面。

API 组件 Maven 插件生成的 API 映射类放在以下位置，默认放在以下位置：

ProjectName-component/target/generated-sources/camel-component

API 组件 Maven 插件的主要输入是 Java API 类和 Javadoc 元数据。通过声明为常规 Maven 依赖项（应使用提供的范围声明 Javadoc Maven 依赖项），使这些插件 提供给 插件。

设置 API 组件 Maven 插件的建议方法是使用 API 组件 archetype 生成起点代码。这会在 ProjectName-component/pom.xml 文件中生成默认插件配置，然后您可以自定义该项目。插件设置的主要方面是，如下所示：

以下 POM 文件提取显示 API 组件 Maven 插件的基本配置，如使用 API 组件 archetype 生成代码时，在 Maven 插件管理 范围内定义：

<?xml version="1.0" encoding="UTF-8"?>
<project ...>
  ...
  <build>
    ...
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.camel</groupId>
          <artifactId>camel-api-component-maven-plugin</artifactId>
          <version>2.21.0.fuse-770013-redhat-00001</version>
          <configuration>
            <scheme>${schemeName}</scheme>
            <componentName>${componentName}</componentName>
            <componentPackage>${componentPackage}</componentPackage>
            <outPackage>${outPackage}</outPackage>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
    ...
  </build>
  ...
</project

pluginManagement 范围中指定的配置提供了插件的默认设置。它并不实际创建插件的实例，但其默认设置将供任何 API 组件插件实例使用。

除了指定插件版本（在 version 元素中），前面的基本配置还指定以下配置属性：

以下 POM 文件提取显示 API 组件 Maven 插件的示例实例，该插件配置为在 Maven 构建过程中生成 API 映射：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  ...
  <build>
    <defaultGoal>install</defaultGoal>

    <plugins>
      ...
      <!-- generate Component source and test source -->
      <plugin>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-api-component-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>generate-test-component-classes</id>
            <goals>
              <goal>fromApis</goal>
            </goals>
            <configuration>
              <apis>
                <api>
                  <apiName>hello-file</apiName>
                  <proxyClass>org.jboss.fuse.example.api.ExampleFileHello</proxyClass>
                  <fromSignatureFile>signatures/file-sig-api.txt</fromSignatureFile>
                </api>
                <api>
                  <apiName>hello-javadoc</apiName>
                  <proxyClass>org.jboss.fuse.example.api.ExampleJavadocHello</proxyClass>
                  <fromJavadoc/>
                </api>
              </apis>
            </configuration>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

该插件由 configuration 元素配置，它包含单个 apis 子元素来配置 Java API 的类。每个 API 类都由 api 元素配置，如下所示：

API 映射的以下方面可以通过配置插件来自定义：

可以过滤 Javadoc 元数据来忽略或显式包含某些内容。有关如何进行此操作的详情，请参考 第 47.2 节 “javadoc 选项”。

如果没有 Javadoc 可用，您可以利用签名文件来提供所需的映射元数据。fromSignatureFile 用于指定对应签名文件的位置。它没有特殊选项。