如何避免在 CXF 或 JAX-WS 生成的 Web 服务客户机中指定 WSDL 位置?

2022-08-31 06:42:52

当我使用来自 CXF 的 wsdl2java 生成 Web 服务客户端时(它生成类似于 wsimport 的东西),通过 maven,我的服务以如下代码开头:

@WebServiceClient(name = "StatusManagement", 
                  wsdlLocation = "c:/some_absolute_path_to_a_wsdl_file.wsdl",
                  targetNamespace = "http://tempuri.org/") 
public class StatusManagement extends Service {

    public final static URL WSDL_LOCATION;
    public final static QName SERVICE = new QName("http://tempuri.org/", "StatusManagement");
    public final static QName WSHttpBindingIStatus = new QName("http://tempuri.org/", "WSHttpBinding_IStatus");
    static {
        URL url = null;
        try {
            url = new URL("c:/some_absolute_path_to_a_wsdl_file.wsdl");
        } catch (MalformedURLException e) {
            System.err.println("Can not initialize the default wsdl from c:/some_absolute_path_to_a_wsdl_file.wsdl");
            // e.printStackTrace();
        }
        WSDL_LOCATION = url;
    }

硬编码的绝对路径真的很糟糕。生成的类在除我的计算机之外的任何其他计算机中都不起作用。

第一个想法是将 WSDL 文件(加上它导入的所有内容、其他 WSDL 和 XSD)放在 jar 文件中的某个位置,并对其进行类路径。但我们希望避免这种情况。由于所有这些东西都是由基于 WSDL 和 XSD 的 CXF 和 JAXB 生成的,因此我们认为在运行时不需要了解 WSDL 是没有意义的。

wsdlLocation属性旨在覆盖WSDL位置(至少这是我在某处读取的内容),它的默认值是“”。由于我们使用的是maven,因此我们尝试在CXF的配置中包含,以尝试强制源生成器将wsdlLocation留空。但是,这只会使它忽略 XML 标记,因为它是空的。我们做了一个非常丑陋的可耻的黑客,使用.<wsdlLocation></wsdlLocation><wsdlLocation>" + "</wsdlLocation>

这也改变了其他地方:

@WebServiceClient(name = "StatusManagement", 
                  wsdlLocation = "" + "",
                  targetNamespace = "http://tempuri.org/") 
public class StatusManagement extends Service {

    public final static URL WSDL_LOCATION;
    public final static QName SERVICE = new QName("http://tempuri.org/", "StatusManagement");
    public final static QName WSHttpBindingIStatus = new QName("http://tempuri.org/", "WSHttpBinding_IStatus");
    static {
        URL url = null;
        try {
            url = new URL("" + "");
        } catch (MalformedURLException e) {
            System.err.println("Can not initialize the default wsdl from " + "");
            // e.printStackTrace();
        }
        WSDL_LOCATION = url;
    }

所以,我的问题是:

  1. 即使所有类都是由 CXF 和 JAXB 生成的,我们真的需要一个 WSDL 位置吗?如果是,为什么?

  2. 如果我们真的不需要 WSDL 位置,那么如何让 CXF 不生成它并完全避免它的正确而干净的方法呢?

  3. 我们可以通过该黑客获得哪些不良副作用?我们仍然无法测试它以查看会发生什么,所以如果有人可以提前说,那就太好了。


答案 1

我今天终于找到了这个问题的正确答案。

<plugin>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-codegen-plugin</artifactId>
    <version>${cxf.version}</version>
    <executions>
        <execution>
            <id>generate-sources</id>
            <phase>generate-sources</phase>
            <configuration> 
                <sourceRoot>${project.build.directory}/generated-sources/cxf</sourceRoot>
                <wsdlOptions>
                    <wsdlOption>
                        <wsdl>${project.basedir}/src/main/resources/wsdl/FooService.wsdl</wsdl>
                        <wsdlLocation>classpath:wsdl/FooService.wsdl</wsdlLocation>
                    </wsdlOption>
                </wsdlOptions>
            </configuration>
            <goals>
                <goal>wsdl2java</goal>
            </goals>
        </execution>
    </executions>
</plugin>

请注意,我已将 中的值作为前缀。这告诉插件 wsdl 将位于类路径上,而不是绝对路径上。然后它将生成类似于以下内容的代码:wsdlLocationclasspath:

@WebServiceClient(name = "FooService", 
                  wsdlLocation = "classpath:wsdl/FooService.wsdl",
                  targetNamespace = "http://org/example/foo") 
public class Foo_Service extends Service {

    public final static URL WSDL_LOCATION;

    public final static QName SERVICE = new QName("http://org/example/foo", "Foo");
    public final static QName FooSOAPOverHTTP = new QName("http://org/example/foo", "Foo_SOAPOverHTTP");
    static {
        URL url = Foo_Service.class.getClassLoader().getResource("wsdl/FooService.wsdl");
        if (url == null) {
            java.util.logging.Logger.getLogger(Foo_Service.class.getName())
                .log(java.util.logging.Level.INFO, 
                     "Can not initialize the default wsdl from {0}", "classpath:wsdl/FooService.wsdl");
        }       
        WSDL_LOCATION = url;
    }

请注意,这仅适用于 cxf-codegen-plugin 的 2.4.1 或更高版本。


答案 2

我们使用

wsdlLocation = "WEB-INF/wsdl/WSDL.wsdl"

换句话说,使用相对于类路径的路径。

我相信在运行时可能需要WSDL来验证封送/取消封送期间的消息。


推荐