검색

44.2. cxf-codegen-plugin

download PDF

초록

WSDL 문서에서 JAX-WS 호환 Java 코드 생성

44.2.1. 개요

44.2.2. 기본 예

다음 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_11_1-00015-redhat-00002</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>

44.2.3. 기본 구성 설정

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

configuration/sourceRoot
생성된 Java 파일이 저장될 디렉터리를 지정합니다. 기본값은 target/generated-sources/cxf 입니다.
configuration/wsdlOptions/wsdlOption/wsdl
WSDL 파일의 위치를 지정합니다.

44.2.4. 설명

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

44.2.5. WSDL 옵션

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

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

44.2.6. 기본 옵션

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

중요

옵션이 wsdlOptions 요소에서 중복되는 경우 wsdlOptions 요소의 값은 앞에 추가됩니다.

44.2.7. 코드 생성 옵션 지정

일반 코드 생성 옵션( 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>
...

44.2.8. 바인딩 파일 지정

하나 이상의 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>
...

44.2.9. 특정 WSDL 서비스에 대한 코드 생성

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

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

44.2.10. 여러 WSDL 파일에 대한 코드 생성

여러 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>

44.2.11. Maven 리포지토리에서 WSDL 다운로드

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

44.2.12. 인코딩

(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>
...

44.2.13. 별도의 프로세스 복제

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

한 번
codegen 플러그인 구성에 지정된 모든 WSDL 파일을 처리하도록 단일 새 JVM을 분기합니다.
always
코드gen 플러그인 구성에 지정된 각 WSDL 파일을 처리하도록 새 JVM을 포크합니다.
false
(기본값) 는 forking을 비활성화합니다.

코드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>
...

44.2.14. 옵션 참조

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

옵션해석

-fe|-frontend frontend

코드 생성기에서 사용하는 프런트 엔드를 지정합니다.Specifies the front end used by the code generator. 가능한 값은 jaxws,jaxws21cxf 입니다. jaxws21 프론트엔드는 JAX-WS 2.1 규정을 준수하는 데 사용됩니다. jaxws frontend 대신 선택적으로 사용할 수 있는 cxf frontend는 서비스 클래스에 대한 추가 생성자를 제공합니다. 이 생성자를 사용하면 서비스 구성을 위한 버스 인스턴스를 편리하게 지정할 수 있습니다. 기본값은 jaxws 입니다.

-db|-databinding databinding

코드 생성기에서 사용하는 데이터 바인딩을 지정합니다.Specifies the data binding used by the code generator. 가능한 값은 jaxb,xmlbeans,sdo -staticsdo-dynamic), jibx 입니다. 기본값은 jaxb 입니다.

-wv wsdlVersion

도구에서 예상되는 WSDL 버전을 지정합니다. 기본값은 1.1 입니다.[a]

-p wsdlNamespace=PackageName

생성된 코드에 사용할 0개 이상의 패키지 이름을 지정합니다. 선택적으로 패키지 이름 매핑에 대한 WSDL 네임스페이스를 지정합니다.

-b bindingName

하나 이상의 JAXWS 또는 JAXB 바인딩 파일을 지정합니다. 각 바인딩 파일에 별도의 -b 플래그를 사용합니다.

-sn serviceName

코드를 생성할 WSDL 서비스의 이름을 지정합니다. 기본값은 WSDL 문서의 모든 서비스에 대한 코드를 생성하는 것입니다.

-reserveClass classname

-autoNameResolution 와 함께 사용되는 경우 클래스를 생성할 때 사용하지 않는 wsdl-to-java의 클래스 이름을 정의합니다. 여러 클래스에 대해 이 옵션을 여러 번 사용하십시오.

-catalog catalogUrl

가져온 스키마 및 WSDL 문서를 확인하는 데 사용할 XML 카탈로그의 URL을 지정합니다.

-d output-directory

생성된 코드 파일이 작성되는 디렉터리를 지정합니다.

-compile

생성된 Java 파일을 컴파일합니다.

-classdir complile-class-dir

컴파일된 클래스 파일이 작성되는 디렉터리를 지정합니다.Specifies the directory into which the compiled class files are written.

-clientjar jar-file-name

모든 클라이언트 클래스 및 WSDL이 포함된 JAR 파일을 생성합니다. 이 옵션을 지정하면 지정된 wsdlLocation 이 작동하지 않습니다.

-client

클라이언트 메인 라인에 대한 시작점 코드를 생성합니다.

-server

서버 메인 라인에 대한 시작 지점 코드를 생성합니다.

-impl

구현 개체의 시작 지점 코드를 생성합니다.Generates starting point code for an implementation object.

-all

모든 시작 지점 코드를 생성합니다. 유형, 서비스 프록시, 서비스 인터페이스, 서버 메인라인, 클라이언트 메인라인, 구현 오브젝트, Ant build.xml 파일.

-ant

Ant build.xml 파일을 생성합니다.

-autoNameResolution

바인딩 사용자 정의를 사용하지 않고도 이름 지정을 자동으로 해결합니다.

-defaultValues=DefaultValueProvider

생성된 클라이언트 및 생성된 구현에 대한 기본값을 생성하도록 툴에 지시합니다. 선택적으로 기본값을 생성하는 데 사용되는 클래스의 이름을 제공할 수도 있습니다. 기본적으로 RandomValueProvider 클래스가 사용됩니다.

-nexclude schema-namespace=java-packagename

코드를 생성할 때 지정된 WSDL 스키마 네임스페이스를 무시합니다. 이 옵션은 여러 번 지정할 수 있습니다. 또한 선택적으로 제외된 네임스페이스에 설명된 유형에서 사용하는 Java 패키지 이름을 지정합니다.

-exsh (true/false)

확장된 soap 헤더 메시지 바인딩 처리를 활성화하거나 비활성화합니다. 기본값은 false입니다.

-noTypes

생성 유형을 비활성화합니다.

-DNS (true/false)

기본 네임스페이스 패키지 이름 매핑을 활성화하거나 비활성화합니다. 기본값은 true입니다.

-DEX (true/false)

default excludes 네임스페이스 매핑을 활성화하거나 비활성화합니다. 기본값은 true입니다.

-xjcargs

JAXB 데이터 바인딩을 사용하는 경우 XJC로 직접 전달할 쉼표로 구분된 인수 목록을 지정합니다. 가능한 모든 XJC 인수 목록을 가져오려면 -xjc-X 를 사용합니다.

-noAddressBinding

JAX-WS 2.1 호환 매핑 대신 Apache CXF 전용 WS-Addressing 유형을 사용하도록 툴에 지시합니다.

-validate [=all|basic|none]

코드를 생성하려고 시도하기 전에 WSDL 문서의 유효성을 검사하도록 도구를 지시합니다.

-keep

기존 파일을 덮어쓰지 않도록 도구에 지시합니다.

-wsdlLocation wsdlLocation

@WebService 주석의 wsdlLocation 속성 값을 지정합니다.

-v

도구의 버전 번호를 표시합니다.

-verbose|-V

코드 생성 프로세스 중 주석을 표시합니다.

-quiet

코드 생성 프로세스 중 주석을 비활성화합니다.

-allowElementReferences[=true], -aer[=true]

true 인 경우 JAX-WS 2.2 사양의 2.3.1.2(v) 섹션에 제공된 규칙을 무시하면 래퍼 스타일 매핑을 사용할 때 요소 참조를 허용하지 않습니다. 기본값은 false 입니다.

-asyncMethods[=method1,method2,…​]

JAX-WS 바인딩 파일에서 enableAsyncMapping 과 유사하게 클라이언트 측 비동기 호출을 허용하도록 생성된 Java 클래스 메서드 목록입니다.

-bareMethods[=method1,method2,…​]

JAX-WS 바인딩 파일에서 enableWrapperStyle 과 유사하게 래퍼 스타일을 갖는 Java 클래스 메서드 목록입니다(아래 참조).

-mimeMethods[=method1,method2,…​]

JAX-WS 바인딩 파일에서 MIMEContent를 활성화하는 것과 유사하게 mime:content 매핑을 활성화하는 Java 클래스 메서드 목록입니다.

-faultSerialVersionUID fault-serialVersionUID

오류 예외의 suid를 생성하는 방법 가능한 값은 NONE,TIMESTAMP,FQCN 또는 특정 번호입니다. 기본값은 None입니다.

-encoding 인코딩

Java 코드를 생성할 때 사용할 Charset 인코딩을 지정합니다.

-exceptionSuper

wsdl:fault 요소에서 생성된 오류 빈의 슈퍼 클래스(기본값: java.lang.Exception).

-seiSuper interfaceName

생성된 SEI 인터페이스의 기본 인터페이스를 지정합니다. 예를 들어 이 옵션을 사용하여 Java 7 AutoCloseable 인터페이스를 슈퍼 인터페이스로 추가할 수 있습니다.

-mark-generated

생성된 클래스에 @Generated 주석을 추가합니다.

[a] 현재 Apache CXF는 코드 생성기에 대한 WSDL 1.1 지원만 제공합니다.
Red Hat logoGithubRedditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

© 2024 Red Hat, Inc.