47장. API 구성 요소 Maven 플러그인 구성

API 구성 요소 Maven 플러그인의 주요 용도인 camel-api-component-maven-plugin 은 엔드포인트 URI와 API 메서드 호출 간의 매핑을 구현하는 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 구성 요소 archetype을 사용하여 코드가 생성될 때 Maven 플러그인에 정의된 API 구성 요소 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-760027-redhat-00001</version>
          <configuration>
            <scheme>${schemeName}</scheme>
            <componentName>${componentName}</componentName>
            <componentPackage>${componentPackage}</componentPackage>
            <outPackage>${outPackage}</outPackage>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
    ...
  </build>
  ...
</project

pluginManagement 범위에 지정된 구성은 플러그인에 대한 기본 설정을 제공합니다. 실제로 플러그인 인스턴스를 생성하지 않지만 모든 API 구성 요소 플러그인 인스턴스에서 기본 설정을 사용합니다.

플러그인 버전( 버전 요소)을 지정하는 것 외에도 이전 기본 구성은 다음과 같은 구성 속성을 지정합니다.

다음 POM 파일 추출은 Maven 빌드 중에 API 매핑을 생성하도록 구성된 API 구성 요소 Maven 플러그인의 샘플 인스턴스를 보여줍니다.

<?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>

플러그인은 Java API의 클래스를 구성하는 단일 apis 하위 요소가 포함된 구성 요소로 구성됩니다. 각 API 클래스는 다음과 같이 api 요소에 의해 구성됩니다.

API 매핑의 다음 측면은 플러그인을 구성하여 사용자 지정할 수 있습니다.

특정 콘텐츠를 무시하거나 명시적으로 포함하도록 Javadoc 메타데이터를 필터링할 수 있습니다. 이 작업을 수행하는 방법에 대한 자세한 내용은 47.2절. “Javadoc 옵션” 을 참조하십시오.

Javadoc을 사용할 수 없는 경우 파일에 서명하여 필요한 매핑 메타데이터를 제공할 수 있습니다. fromSignatureFile 은 해당 서명 파일의 위치를 지정하는 데 사용됩니다. 특별한 옵션은 없습니다.