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

时间:2010-12-15 21:38:50

标签: java wsdl cxf wsdl2java

当我使用CXF中的wsdl2java(生成类似于wsimport的东西)生成一个webservice客户端时,通过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></wsdlLocation>以尝试强制源生成器将wsdlLocation留空。但是,这只是使它忽略XML标记,因为它是空的。我们使用<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. 我们可以通过该黑客获得哪些不良副作用?我们仍然无法测试看看会发生什么,所以如果有人可以事先说出来,那就太好了。

9 个答案:

答案 0 :(得分:194)

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

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

请注意,我已将wsdlLocation中的值加上classpath:作为前缀。这告诉插件wsdl将在类路径而不是绝对路径上。然后它将生成类似于此的代码:

@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;
    }

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

答案 1 :(得分:20)

我们使用

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

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

我相信在编组/解组时可能需要在运行时验证消息。

答案 2 :(得分:9)

1)在某些情况下,是的。如果WSDL包含诸如策略之类的内容以及指示运行时行为的内容,那么在运行时可能需要WSDL。不会为与策略相关的事物生成工件。此外,在一些不起眼的RPC / Literal情况下,并非所有需要的命名空间都在生成的代码中输出(按照规范)。因此,他们需要wsdl。虽然模糊不清。

2)我认为类似的东西会起作用。什么版本的CXF?这听起来像个bug。你可以在那里尝试一个空字符串(只是空格)。不确定这是否有效。也就是说,在您的代码中,您可以使用获取WSDL URL的构造函数并传递null。 wsdl不会被使用。

3)只是上述限制。

答案 3 :(得分:4)

我能够生成

static {
    WSDL_LOCATION = null;
}

通过将pom文件配置为wsdlurl为空:

    <plugin>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-codegen-plugin</artifactId>
        <executions>
            <execution>
                <id>generate-sources</id>
                <phase>generate-sources</phase>
                <configuration>
                    <sourceRoot>${basedir}/target/generated/src/main/java</sourceRoot>
                    <wsdlOptions>
                        <wsdlOption>
                            <wsdl>${basedir}/src/main/resources/service.wsdl</wsdl>
                            <extraargs>
                                <extraarg>-client</extraarg>
                                <extraarg>-wsdlLocation</extraarg>
                                <wsdlurl />
                            </extraargs>
                        </wsdlOption>
                    </wsdlOptions>
                </configuration>
                <goals>
                    <goal>wsdl2java</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

答案 4 :(得分:4)

您是否可以避免使用wsdl2java?您可以立即使用CXF FrontEnd API来调用SOAP Web服务。唯一的问题是您需要在客户端创建SEI和VO。这是一个示例代码。

package com.aranin.weblog4j.client;

import com.aranin.weblog4j.services.BookShelfService;
import com.aranin.weblog4j.vo.BookVO;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

public class DemoClient {
    public static void main(String[] args){
        String serviceUrl = "http://localhost:8080/weblog4jdemo/bookshelfservice";
        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
        factory.setServiceClass(BookShelfService.class);
        factory.setAddress(serviceUrl);
        BookShelfService bookService = (BookShelfService) factory.create();

        //insert book
        BookVO bookVO = new BookVO();
        bookVO.setAuthor("Issac Asimov");
        bookVO.setBookName("Foundation and Earth");

        String result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        bookVO = new BookVO();
        bookVO.setAuthor("Issac Asimov");
        bookVO.setBookName("Foundation and Empire");

        result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        bookVO = new BookVO();
        bookVO.setAuthor("Arthur C Clarke");
        bookVO.setBookName("Rama Revealed");

        result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        //retrieve book

        bookVO = bookService.getBook("Foundation and Earth");

        System.out.println("book name : " + bookVO.getBookName());
        System.out.println("book author : " + bookVO.getAuthor());

    }
}

您可以在此处查看完整教程http://weblog4j.com/2012/05/01/developing-soap-web-service-using-apache-cxf/

答案 5 :(得分:4)

更新CXF 3.1.7

在我的情况下,我将WSDL文件放在pom中,并将此路径添加到Eclipse中的Srouces(右键单击Project-&gt; Build Path - &gt; Configure Build Path ...-&gt; Source [标签] - &gt;添加文件夹。

以下是我的wsdlLocation文件的外观,可以看出没有 <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/cxf</sourceRoot> <wsdlOptions> <wsdlOption> <wsdl>classpath:wsdl/FOO_SERVICE.wsdl</wsdl> </wsdlOption> </wsdlOptions> </configuration> <goals> <goal>wsdl2java</goal> </goals> </execution> </executions> </plugin> 需要的选项:

@WebServiceClient(name = "EventService", 
              wsdlLocation = "classpath:wsdl/FOO_SERVICE.wsdl",
              targetNamespace = "http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/") 
public class EventService extends Service {

public final static URL WSDL_LOCATION;

public final static QName SERVICE = new QName("http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/", "EventService");
public final static QName EventPort = new QName("http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/", "EventPort");
static {
    URL url = EventService.class.getClassLoader().getResource("wsdl/FOO_SERVICE.wsdl");
    if (url == null) {
        java.util.logging.Logger.getLogger(EventService.class.getName())
            .log(java.util.logging.Level.INFO, 
                 "Can not initialize the default wsdl from {0}", "classpath:wsdl/FOO_SERVICE.wsdl");
    }       
    WSDL_LOCATION = url;   
}

这是生成的服务。可以看出,URL是从ClassLoader获取的,而不是来自Absolute File-Path

{{1}}

答案 6 :(得分:2)

说真的,最重要的答案对我不起作用。 尝试了cxf.version 2.4.1和3.0.10。并且每次都使用wsdlLocation生成绝对路径。

我的解决方案是在wsdl2java中使用apache-cxf-3.0.10\bin\命令 与-wsdlLocation classpath:wsdl/QueryService.wsdl

详情:

    wsdl2java -encoding utf-8 -p com.jeiao.boss.testQueryService -impl -wsdlLocation classpath:wsdl/testQueryService.wsdl http://127.0.0.1:9999/platf/testQueryService?wsdl

答案 7 :(得分:0)

@Martin Devillers解决方案工作正常。为了完整起见,请提供以下步骤:

  1. 将wsdl放入资源目录,例如:src/main/resource
  2. 在pom文件中,添加wsdlDirectory和wsdlLocation(在wsdlLocation的开头不要错过/),如下所示。 wsdlDirectory用于生成代码,而wsdlLocation用于在运行时创建动态代理。

    <wsdlDirectory>src/main/resources/mydir</wsdlDirectory>
    <wsdlLocation>/mydir/my.wsdl</wsdlLocation>
    
  3. 然后在您的Java代码中(使用无参数构造函数):

    MyPort myPort = new MyPortService().getMyPort();
    
  4. 这是pom文件中完整的代码生成部分,生成的代码中包含流利的api。

    <plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>jaxws-maven-plugin</artifactId>
    <version>2.5</version>
    
    <dependencies>
        <dependency>
            <groupId>org.jvnet.jaxb2_commons</groupId>
            <artifactId>jaxb2-fluent-api</artifactId>
            <version>3.0</version>
        </dependency>
        <dependency>
            <groupId>com.sun.xml.ws</groupId>
            <artifactId>jaxws-tools</artifactId>
            <version>2.3.0</version>
        </dependency>
    </dependencies>
    
    <executions>
        <execution>
            <id>wsdl-to-java-generator</id>
            <goals>
                <goal>wsimport</goal>
            </goals>
            <configuration>
                <xjcArgs>
                    <xjcArg>-Xfluent-api</xjcArg>
                </xjcArgs>
                <keep>true</keep>
                <wsdlDirectory>src/main/resources/package</wsdlDirectory>
                <wsdlLocation>/package/my.wsdl</wsdlLocation>
                <sourceDestDir>${project.build.directory}/generated-sources/annotations/jaxb</sourceDestDir>
                <packageName>full.package.here</packageName>
            </configuration>
        </execution>
    </executions>
    

答案 8 :(得分:0)

我能够生成自动生成的

    static {
        WSDL_LOCATION = null;
    }

    <wsdlLocation>null</wsdlLocation>

虽然,这对我来说似乎是有限的。我试图尽可能快地实现短暂的 WS 客户端,尽量减少 svc = new MyService(); binding = svc.getMySoapPort(); 上的初始化,但现在我明白了

INFO: Creating Service {http://www.example.com/MyApi}MyApiService from class com.company.MyApiPortType

代替

INFO: Creating Service {http://www.example.com/MyApi}MyApiService from WSDL ...

看来,new MyService(); 无论如何都是代价高昂的,所以我必须考虑重用它的长期并发实例......所以 WSDL 的运行时解析不会成为问题。