44.2. cxf-codegen-plugin

다음 POM 추출은 myService.wsdl WSDL 파일을 처리하기 위해 Maven cxf-codegen-plugin 을 구성하는 방법에 대한 간단한 예를 보여줍니다.

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-codegen-plugin</artifactId>
  <version>3.3.6.fuse-7_10_0-00020-redhat-00001</version>
  <executions>
    <execution>
      <id>generate-sources</id>
      <phase>generate-sources</phase>
      <configuration>
        <sourceRoot>target/generated/src/main/java</sourceRoot>
        <wsdlOptions>
          <wsdlOption>
            <wsdl>src/main/resources/wsdl/myService.wsdl</wsdl>
          </wsdlOption>
        </wsdlOptions>
      </configuration>
      <goals>
        <goal>wsdl2java</goal>
      </goals>
    </execution>
  </executions>
</plugin>

이전 예제에서는 다음 구성 설정을 사용자 지정할 수 있습니다.

wsdl2java 작업은 WSDL 문서를 가져와서 서비스를 구현할 완전히 주석이 달린 Java 코드를 생성합니다. WSDL 문서에는 유효한 portType 요소가 있어야 하지만 바인딩 요소 또는 서비스 요소를 포함할 필요는 없습니다. 선택적 인수를 사용하여 생성된 코드를 사용자 지정할 수 있습니다.

플러그인을 구성하려면 하나 이상의 wsdlOptions 요소가 필요합니다. wsdlOptions 요소의 wsdl 자식이 필요하며 플러그인에서 처리할 WSDL 문서를 지정합니다. wsdl 요소 외에도 wsdl Options 요소는 WSDL 문서가 처리되는 방법을 사용자 지정할 수 있는 여러 개의 자식을 사용할 수 있습니다.

두 개 이상의 wsdlOptions 요소를 플러그인 구성에 나열할 수 있습니다. 각 요소는 처리를 위한 단일 WSDL 문서를 구성합니다.

defaultOptions 요소는 선택적 요소입니다. 지정된 WSDL 문서 모두에 사용되는 옵션을 설정하는 데 사용할 수 있습니다.

일반 코드 생성 옵션( Apache CXF wsdl2java 명령줄 툴에서 지원하는 스위치에 연결)을 지정하려면 추가args 요소를 wsdlOption 요소의 자식으로 추가할 수 있습니다. 예를 들어 다음과 같이 -impl 옵션과 -verbose 옵션을 추가할 수 있습니다.

...
<configuration>
  <sourceRoot>target/generated/src/main/java</sourceRoot>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <!-- you can set the options of wsdl2java command by using the <extraargs> -->
      <extraargs>
        <extraarg>-impl</extraarg>
        <extraarg>-verbose</extraarg>
      </extraargs>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

스위치에서 인수를 사용하는 경우 후속 extraarg 요소를 사용하여 이러한 인수를 지정할 수 있습니다. 예를 들어 jibx 데이터 바인딩을 지정하려면 다음과 같이 플러그인을 구성할 수 있습니다.

...
<configuration>
  <sourceRoot>target/generated/src/main/java</sourceRoot>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <extraargs>
        <extraarg>-databinding</extraarg>
        <extraarg>jibx</extraarg>
      </extraargs>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

하나 이상의 JAX-WS 바인딩 파일의 위치를 지정하려면 bindingFiles 요소를 wsdlOption의 자식으로 추가할 수 있습니다.

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <bindingFiles>
        <bindingFile>${basedir}/src/main/resources/wsdl/async_binding.xml</bindingFile>
      </bindingFiles>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

코드를 생성할 WSDL 서비스의 이름을 지정하려면 serviceName 요소를 wsdlOption 의 자식(기본 동작은 WSDL 문서의 모든 서비스에 대한 코드를 생성하는 것입니다)으로 추가할 수 있습니다.

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <serviceName>MyWSDLService</serviceName>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

여러 WSDL 파일에 대한 코드를 생성하려면 WSDL 파일에 대한 wsdlOption 요소를 추가로 삽입하기만 하면 됩니다. 모든 WSDL 파일에 적용되는 몇 가지 일반적인 옵션을 지정하려면 공통 옵션을 defaultOptions 요소에 추가합니다.

<configuration>
  <defaultOptions>
      <bindingFiles>
          <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
      </bindingFiles>
      <noAddressBinding>true</noAddressBinding>
  </defaultOptions>
  <wsdlOptions>
      <wsdlOption>
          <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
          <serviceName>MyWSDLService</serviceName>
      </wsdlOption>
      <wsdlOption>
          <wsdl>${basedir}/src/main/resources/wsdl/myOtherService.wsdl</wsdl>
          <serviceName>MyOtherWSDLService</serviceName>
      </wsdlOption>
  </wsdlOptions>
</configuration>

와일드카드 일치를 사용하여 여러 WSDL 파일을 지정할 수도 있습니다. 이 경우 wsdlRoot 요소를 사용하여 WSDL 파일이 포함된 디렉터리를 지정한 다음 * 문자와 함께 와일드카드를 지원하는 include 요소를 사용하여 필요한 WSDL 파일을 선택합니다. 예를 들어, src/main/resources/wsdl 루트 디렉토리에서 Service.wsdl 로 끝나는 모든 WSDL 파일을 선택하려면 다음과 같이 플러그인을 구성할 수 있습니다.

<configuration>
  <defaultOptions>
      <bindingFiles>
          <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
      </bindingFiles>
      <noAddressBinding>true</noAddressBinding>
  </defaultOptions>
  <wsdlRoot>${basedir}/src/main/resources/wsdl</wsdlRoot>
  <includes>
      <include>*Service.wsdl</include>
  </includes>
</configuration>

Maven 리포지토리에서 직접 WSDL 파일을 다운로드하려면 wsdlArtifact 요소를 wsdlOption 요소의 자식으로 추가하고 다음과 같이 Maven 아티팩트의 좌표를 지정합니다.

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdlArtifact>
        <groupId>org.apache.pizza</groupId>
        <artifactId>PizzaService</artifactId>
        <version>1.0.0</version>
      </wsdlArtifact>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

(requires JAXB 2.2) 생성된 Java 파일에 사용되는 문자 인코딩(Charset)을 지정하려면 다음과 같이 encoding 요소를 구성 요소의 자식으로 추가합니다.

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
    </wsdlOption>
  </wsdlOptions>
  <encoding>UTF-8</encoding>
</configuration>
...

fork 요소를 구성 요소의 자식으로 추가하여 코드 생성을 위해 별도의 JVM을 분기하도록 codegen 플러그인을 구성할 수 있습니다. fork 요소는 다음 값 중 하나로 설정할 수 있습니다.

코드gen 플러그인이 별도의 JVM을 포크하도록 구성된 경우(즉, fork 옵션이 false 이외의 값으로 설정되어 있음) additional JVM 인수를 additionalJvmArgs 요소를 통해 forked JVM에 지정할 수 있습니다. 예를 들어, 다음 조각은 로컬 파일 시스템에서만 XML 스키마에 액세스하도록 ( javax.xml.accessExternalSchema 시스템 속성)에서 XML 스키마에 액세스하도록 제한되는 단일 JVM을 분기하도록 codegen 플러그인을 구성합니다.

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
    </wsdlOption>
  </wsdlOptions>
  <fork>once</fork>
  <additionalJvmArgs>-Djavax.xml.accessExternalSchema=jar:file,file</additionalJvmArgs>
</configuration>
...

코드 생성 프로세스를 관리하는 데 사용되는 옵션은 다음 표에서 검토합니다.