44.2. cxf-codegen-plugin

以下 POM 提取显示如何配置 Maven cxf-codegen-plugin 来处理 myService.wsdl WSDL 文件的简单示例：

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-codegen-plugin</artifactId>
  <version>3.3.6.fuse-7_12_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 元素，但不需要包含 绑定 元素或 service 元素。您可以使用可选参数自定义生成的代码。

至少需要一个 wsdlOptions 元素来配置插件。wsdlOptions 元素的 wsdl 子级是必需的，并指定插件要处理的 WSDL 文档。除了 wsdl 元素外，wsdlOptions 元素还可以提取多个子对象，它可以自定义 WSDL 文档的处理方式。

可以在插件配置中列出多个 wsdlOptions 元素。每个元素配置单个 WSDL 文档进行处理。

defaultOptions 元素是一个可选元素。它可用于设置可在所有指定的 WSDL 文档中使用的选项。

要指定通用代码生成选项（与 Apache CXF wsdl2java 命令行工具支持的交换机相对应），您可以添加 extraargs 元素作为 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>
...

（需要 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 元素添加为配置元素的子级，将 codegen 插件配置为 分叉 单独的 JVM 进行代码生成。fork 元素可以设置为以下值之一：

如果 codegen 插件配置为 fork 独立的 JVM （即，fork 选项被设置为非错误值），您可以通过 additionalJvmArgs 元素为 forked JVM 指定额外的 JVM 参数。例如，以下片段将 codegen 插件配置为 fork 单个 JVM，该 JVM 仅限于从本地文件系统访问 XML 模式（通过设置 javax.xml.accessExternalSchema 系统属性）：

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

下表中列出了用于管理代码生成过程的选项。