45.2. 프레임워크 사용 방법

API 프레임워크를 사용하여 구성 요소를 구현하는 절차에는 자동화된 코드 생성이 혼합되어 Java 코드를 구현하고, Maven POM 파일을 편집하여 빌드를 사용자 정의하는 작업이 포함됩니다. 다음 그림은 이 개발 프로세스에 대한 개요를 제공합니다.

그림 45.1. API 구성 요소 프레임워크 사용

API 구성 요소의 시작점은 항상 Java API입니다. 일반적으로 Camel의 컨텍스트에서는 일반적으로 원격 서버 엔드포인트에 연결하는 Java 클라이언트 API를 의미합니다. 첫 번째 질문은 Java API가 어디에서 발생합니까? 다음은 몇 가지 옵션입니다.

Javadoc 형태로 Java API에 대한 메타데이터를 제공하는 옵션이 있습니다(API 구성 요소 프레임워크에서 코드를 생성하는 데 필요합니다). Maven 리포지토리에서 타사 Java API를 사용하는 경우 일반적으로 Javadoc이 Maven 아티팩트에 이미 제공되어 있음을 알 수 있습니다. 그러나 Javadoc이 제공되지 않는 경우에도 maven-javadoc-plugin Maven 플러그인을 사용하여 쉽게 생성할 수 있습니다.

어떤 이유로 Java API 메타데이터를 Javadoc 형식으로 제공하는 것이 편리하지 않으면 서명 파일 형식으로 메타데이터를 제공할 수 있습니다. 서명 파일은 메서드 서명 목록(행당 하나의 메서드 서명)으로 구성됩니다. 이러한 파일은 수동으로 생성할 수 있으며 빌드 시에만 필요합니다.

다음에서는 서명 파일에 대해 설명합니다.

다음은 서명 파일의 간단한 예제를 보여줍니다.

public String sayHi();
public String greetMe(String name);
public String greetUs(String name1, String name2);

API 구성 요소 개발을 시작하는 가장 쉬운 방법은 camel-archetype-api-component Maven archetype을 사용하여 초기 Maven 프로젝트를 생성하는 것입니다. archetype을 실행하는 방법에 대한 자세한 내용은 46.1절. “Maven Archetype을 사용하여 코드 생성” 을 참조하십시오.

Maven archetype을 실행하면 생성된 ProjectName 디렉터리에 두 개의 하위 프로젝트가 있습니다.

ProjectName-component 에서 스케일톤 코드를 편집하여 고유한 구성 요소 구현을 개발할 수 있습니다. 다음과 같은 생성된 클래스는 스케일톤 구현의 핵심을 구성합니다.

ComponentNameComponent
ComponentNameEndpoint
ComponentNameConsumer
ComponentNameProducer
ComponentNameConfiguration

또한 Maven POM 파일을 편집하여 빌드를 사용자 지정하고 camel-api-component-maven-plugin Maven 플러그인을 구성해야 합니다.

POM 파일을 구성하는 가장 중요한 측면은 camel-api-component-maven-plugin Maven 플러그인의 구성입니다. 이 플러그인은 API 메서드와 끝점 URI 간 매핑을 생성하고 플러그인 구성을 편집하여 매핑을 사용자 지정할 수 있습니다.

예를 들어 ProjectName-component/pom.xml 파일에서 다음 camel-api-component-maven-plugin 플러그인 구성은 ExampleJavadocHello 라는 API 클래스에 대한 최소 구성을 보여줍니다.

<configuration>
  <apis>
    <api>
      <apiName>hello-javadoc</apiName>
      <proxyClass>org.jboss.fuse.example.api.ExampleJavadocHello</proxyClass>
      <fromJavadoc/>
    </api>
  </apis>
</configuration>

이 예제에서 hello-javadoc API 이름은 ExampleJavadocHello 클래스에 매핑됩니다. 즉, 양식의 URI를 사용하여 이 클래스에서 메서드를 호출할 수 있습니다. 스키마://hello-javadoc/끝점. fromJavadoc 요소의 존재는 ExampleJavadocHello 클래스가 Javadoc에서 메타데이터를 가져오는 것을 나타냅니다.

구성 요소 하위 프로젝트의 샘플 POM, ProjectName-component/pom.xml 은 구성 요소를 OSGi 번들로 패키징하도록 구성되어 있습니다. 구성 요소 POM에는 maven-bundle-plugin 의 샘플 구성이 포함되어 있습니다. Maven이 구성 요소에 맞게 올바르게 구성된 OSGi 번들을 생성하도록 maven-bundle-plugin 플러그인의 구성을 사용자 지정해야 합니다.

Maven(예: mvn clean package을 사용하여) 구성 요소를 빌드할 때 camel-api-component-maven-plugin 플러그인은 API 매핑 클래스(Java API와 엔드포인트 URI 구문 간의 매핑을 정의함)를 자동으로 생성하며 대상/클래스 프로젝트 하위 디렉터리에 배치합니다. 크고 복잡한 Java API를 처리할 때 이 생성된 코드는 실제로 많은 구성 요소 소스 코드를 구성합니다.

Maven 빌드가 완료되면 컴파일된 코드와 리소스는 OSGi 번들로 패키지화되어 로컬 Maven 리포지토리에 Maven 아티팩트로 저장됩니다.