JAX-WS客户端：访问本地WSDL的正确途径是什么？

时间：2010-11-12 10:14:57

标签： java netbeans client jax-ws

问题是我需要从我提供的文件构建Web服务客户端。我已将此文件存储在本地文件系统中，并且在将WSDL文件保存在正确的文件系统文件夹中时，一切都很好。当我将其部署到服务器或从文件系统文件夹中删除WSDL时，代理无法找到WSDL并出现错误。我在网上搜索过，但我发现了以下帖子，但我无法使其发挥作用：
JAX-WS Loading WSDL from jar
http://www.java.net/forum/topic/glassfish/metro-and-jaxb/client-jar-cant-find-local-wsdl-0
http://blog.vinodsingh.com/2008/12/locally-packaged-wsdl.html

我正在使用NetBeans 6.1（这是我要用这个新的Web服务客户端更新的遗留应用程序）。下面是JAX-WS代理类：

    @WebServiceClient(name = "SOAService", targetNamespace = "http://soaservice.eci.ibm.com/", wsdlLocation = "file:/C:/local/path/to/wsdl/SOAService.wsdl")
public class SOAService
    extends Service
{

    private final static URL SOASERVICE_WSDL_LOCATION;
    private final static Logger logger = Logger.getLogger(com.ibm.eci.soaservice.SOAService.class.getName());

    static {
        URL url = null;
        try {
            URL baseUrl;
            baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource(".");
            url = new URL(baseUrl, "file:/C:/local/path/to/wsdl/SOAService.wsdl");
        } catch (MalformedURLException e) {
            logger.warning("Failed to create URL for the wsdl Location: 'file:/C:/local/path/to/wsdl/SOAService.wsdl', retrying as a local file");
            logger.warning(e.getMessage());
        }
        SOASERVICE_WSDL_LOCATION = url;
    }

    public SOAService(URL wsdlLocation, QName serviceName) {
        super(wsdlLocation, serviceName);
    }

    public SOAService() {
        super(SOASERVICE_WSDL_LOCATION, new QName("http://soaservice.eci.ibm.com/", "SOAService"));
    }

    /**
     * @return
     *     returns SOAServiceSoap
     */
    @WebEndpoint(name = "SOAServiceSOAP")
    public SOAServiceSoap getSOAServiceSOAP() {
        return super.getPort(new QName("http://soaservice.eci.ibm.com/", "SOAServiceSOAP"), SOAServiceSoap.class);
    }

    /**
     * @param features
     *     A list of {@link javax.xml.ws.WebServiceFeature} to configure on the proxy.  Supported features not in the <code>features</code> parameter will have their default values.
     * @return
     *     returns SOAServiceSoap
     */
    @WebEndpoint(name = "SOAServiceSOAP")
    public SOAServiceSoap getSOAServiceSOAP(WebServiceFeature... features) {
        return super.getPort(new QName("http://soaservice.eci.ibm.com/", "SOAServiceSOAP"), SOAServiceSoap.class, features);
    }

}


这是我使用代理的代码：

   WebServiceClient annotation = SOAService.class.getAnnotation(WebServiceClient.class);
   // trying to replicate proxy settings
   URL baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource("");//note : proxy uses "."
   URL url = new URL(baseUrl, "/WEB-INF/wsdl/client/SOAService.wsdl");
   //URL wsdlUrl = this.getClass().getResource("/META-INF/wsdl/SOAService.wsdl"); 
   SOAService serviceObj = new SOAService(url, new QName(annotation.targetNamespace(), annotation.name()));
   proxy = serviceObj.getSOAServiceSOAP();
   /* baseUrl;

   //classes\com\ibm\eci\soaservice
   //URL url = new URL(baseUrl, "../../../../wsdl/SOAService.wsdl");

   proxy = new SOAService().getSOAServiceSOAP();*/
   //updating service endpoint 
   Map<String, Object> ctxt = ((BindingProvider)proxy ).getRequestContext();
   ctxt.put(JAXWSProperties.HTTP_CLIENT_STREAMING_CHUNK_SIZE, 8192);
   ctxt.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, WebServiceUrl);

NetBeans将WSDL的副本放在 web-inf / wsdl / client / SOAService 中，因此我也不想将其添加到 META-INF 。服务类位于 WEB-INF / classes / com / ibm / eci / soaservice / 中，baseurl变量包含文件系统的完整路径（c：\ path \ to \ the \ project ... \ soaservice）。上面的代码引发了错误：

  

javax.xml.ws.WebServiceException：无法访问WSDL：file：/WEB-INF/wsdl/client/SOAService.wsdl。它失败了：           \ WEB-INF \ wsdl \ client \ SOAService.wsdl（找不到路径）

首先，我应该更新代理类的wsdllocation吗？那么如何告诉WEB-INF / classes / com / ibm / eci / soaservice中的SOAService类在\ WEB-INF \ wsdl \ client \ SOAService.wsdl中搜索WSDL？

已编辑：我找到了另一个链接 - http://jianmingli.com/wp/?cat=41，它说将WSDL放入类路径中。我很惭愧地问：如何将它放入Web应用程序类路径？

7 个答案:

答案 0 :(得分：110)

最好的选择是使用jax-ws-catalog.xml

编译本地WSDL文件时，覆盖WSDL位置并将其设置为

http://localhost/wsdl/SOAService.wsdl

不要担心这只是一个URI而不是一个URL，这意味着您不必在该地址提供WSDL。
您可以通过将wsdllocation选项传递给wsdl到java编译器来完成此操作。

这样做会改变您的代理代码

static {
    URL url = null;
    try {
        URL baseUrl;
        baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource(".");
        url = new URL(baseUrl, "file:/C:/local/path/to/wsdl/SOAService.wsdl");
    } catch (MalformedURLException e) {
        logger.warning("Failed to create URL for the wsdl Location: 'file:/C:/local/path/to/wsdl/SOAService.wsdl', retrying as a local file");
        logger.warning(e.getMessage());
    }
    SOASERVICE_WSDL_LOCATION = url;
}

到

static {
    URL url = null;
    try {
        URL baseUrl;
        baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource(".");
        url = new URL(baseUrl, "http://localhost/wsdl/SOAService.wsdl");
    } catch (MalformedURLException e) {
        logger.warning("Failed to create URL for the wsdl Location: 'http://localhost/wsdl/SOAService.wsdl', retrying as a local file");
        logger.warning(e.getMessage());
    }
    SOASERVICE_WSDL_LOCATION = url;
}

注意文件：//在URL构造函数中更改为http：//。

现在出现在jax-ws-catalog.xml中。如果没有jax-ws-catalog.xml，jax-ws确实会尝试从该位置加载WSDL 

http://localhost/wsdl/SOAService.wsdl
 并且失败，因为没有这样的WSDL可用。

但是使用jax-ws-catalog.xml，只要它尝试访问WSDL @ 

http://localhost/wsdl/SOAService.wsdl
，就可以将jax-ws重定向到本地打包的WSDL。

这是jax-ws-catalog.xml 

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="system">
        <system systemId="http://localhost/wsdl/SOAService.wsdl"
                uri="wsdl/SOAService.wsdl"/>
    </catalog>

你正在做的是告诉jax-ws，当它需要从

http://localhost/wsdl/SOAService.wsdl
加载WSDL时，它应该从本地路径wsdl / SOAService.wsdl加载它。

现在你应该把wsdl / SOAService.wsdl和jax-ws-catalog.xml放在哪里？那是百万美元的问题不是吗？ 它应该位于应用程序jar的META-INF目录中。

这样的事情

ABCD.jar  
|__ META-INF    
    |__ jax-ws-catalog.xml  
    |__ wsdl  
        |__ SOAService.wsdl

这样您甚至不必覆盖访问代理的客户端中的URL。 WSDL是从您的JAR中获取的，您可以避免在代码中使用硬编码的文件系统路径。

有关jax-ws-catalog.xml的更多信息 http://jax-ws.java.net/nonav/2.1.2m1/docs/catalog-support.html

希望有所帮助

答案 1 :(得分：17)

我们成功采取的另一种方法是使用wsimport（来自Ant，作为Ant任务）生成WS客户端代理代码，并指定wsdlLocation属性。

<wsimport debug="true" keep="true" verbose="false" target="2.1" sourcedestdir="${generated.client}" wsdl="${src}${wsdl.file}" wsdlLocation="${wsdl.file}">
</wsimport>

由于我们为具有多个WSDL的项目运行此操作，因此脚本动态解析$（wsdl.file}值，该值设置为相对于JavaSource位置的/META-INF/wsdl/YourWebServiceName.wsdl（或者/ src，具体取决于你的项目设置方式。）在构建过程中，WSDL和XSD文件被复制到这个位置并打包在JAR文件中。（类似于上面Bhasakar描述的解决方案）

MyApp.jar
|__META-INF
   |__wsdl
      |__YourWebServiceName.wsdl
      |__YourWebServiceName_schema1.xsd
      |__YourWebServiceName_schmea2.xsd

注意：确保WSDL文件对任何导入的XSD使用相对引用而不是http URL：

  <types>
    <xsd:schema>
      <xsd:import namespace="http://valueobject.common.services.xyz.com/" schemaLocation="YourWebService_schema1.xsd"/>
    </xsd:schema>
    <xsd:schema>
      <xsd:import namespace="http://exceptions.util.xyz.com/" schemaLocation="YourWebService_schema2.xsd"/>
    </xsd:schema>
  </types>

在生成的代码中，我们发现：

/**
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.2-b05-
 * Generated source version: 2.1
 * 
 */
@WebServiceClient(name = "YourService", targetNamespace = "http://test.webservice.services.xyz.com/", wsdlLocation = "/META-INF/wsdl/YourService.wsdl")
public class YourService_Service
    extends Service
{

    private final static URL YOURWEBSERVICE_WSDL_LOCATION;
    private final static WebServiceException YOURWEBSERVICE_EXCEPTION;
    private final static QName YOURWEBSERVICE_QNAME = new QName("http://test.webservice.services.xyz.com/", "YourService");

    static {
        YOURWEBSERVICE_WSDL_LOCATION = com.xyz.services.webservice.test.YourService_Service.class.getResource("/META-INF/wsdl/YourService.wsdl");
        WebServiceException e = null;
        if (YOURWEBSERVICE_WSDL_LOCATION == null) {
            e = new WebServiceException("Cannot find '/META-INF/wsdl/YourService.wsdl' wsdl. Place the resource correctly in the classpath.");
        }
        YOURWEBSERVICE_EXCEPTION = e;
    }

    public YourService_Service() {
        super(__getWsdlLocation(), YOURWEBSERVICE_QNAME);
    }

    public YourService_Service(URL wsdlLocation, QName serviceName) {
        super(wsdlLocation, serviceName);
    }

    /**
     * 
     * @return
     *     returns YourService
     */
    @WebEndpoint(name = "YourServicePort")
    public YourService getYourServicePort() {
        return super.getPort(new QName("http://test.webservice.services.xyz.com/", "YourServicePort"), YourService.class);
    }

    /**
     * 
     * @param features
     *     A list of {@link javax.xml.ws.WebServiceFeature} to configure on the proxy.  Supported features not in the <code>features</code> parameter will have their default values.
     * @return
     *     returns YourService
     */
    @WebEndpoint(name = "YourServicePort")
    public YourService getYourServicePort(WebServiceFeature... features) {
        return super.getPort(new QName("http://test.webservice.services.xyz.com/", "YourServicePort"), YourService.class, features);
    }

    private static URL __getWsdlLocation() {
        if (YOURWEBSERVICE_EXCEPTION!= null) {
            throw YOURWEBSERVICE_EXCEPTION;
        }
        return YOURWEBSERVICE_WSDL_LOCATION;
    }

}

也许这也有帮助。这只是一种不使用“目录”方法的不同方法。

答案 2 :(得分：4)

非常感谢Bhaskar Karambelkar的回答，详细解释并解决了我的问题。但是，我想在三个简单的步骤中为那些急于修复的人重新说明答案

  1. 将您的wsdl本地位置引用设为wsdlLocation= "http://localhost/wsdl/yourwsdlname.wsdl"
  2. 在src下创建一个META-INF文件夹。将您的wsdl文件放在META-INF下的文件夹中，例如META-INF / wsdl

  3. 在META-INF下创建一个xml文件jax-ws-catalog.xml，如下所示

    <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="system"> <system systemId="http://localhost/wsdl/yourwsdlname.wsdl" uri="wsdl/yourwsdlname.wsdl" /> </catalog>

    4. 现在打包你的罐子。不再引用本地目录，它都在

    中打包和引用

答案 3 :(得分：1)

对于那些使用Spring的人，您可以使用classpath-protocol简单地引用任何classpath-resource。因此，在wsdlLocation的情况下，这变为：

<wsdlLocation>classpath:META-INF/webservice.wsdl</wsdlLocation>

请注意，这不是标准的Java行为。另见：http://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html

答案 4 :(得分：0)

此处描述的完全相同的问题。无论我做了什么，按照上面的例子，改变我的WSDL文件的位置（在我们的例子中是从Web服务器），它仍然引用嵌入在服务器进程的源树中的原始位置。

在 MANY 小时尝试调试之后，我注意到异常总是从完全相同的行抛出（在我的情况下为41）。最后，今天早上，我决定将我的源客户端代码发送给我们的贸易伙伴，这样他们至少可以了解代码的外观，但也许可以构建自己的代码。对于我的 shock 和恐怖，我在我的客户端源代码树中找到了一堆类文件和我的.java文件。多奇怪!!我怀疑这些是JAX-WS客户端构建器工具的副产品。

一旦我摧毁了那些愚蠢的.class文件并执行了完整的客户端代码清理和重建，一切都运行得很好！ Redonculous !!

YMMV， 安德鲁

答案 5 :(得分：0)

对于那些仍在这里寻求解决方案的人，最简单的解决方案是使用<wsdlLocation>，而无需更改任何代码。工作步骤如下：

  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. 为完整起见，我在这里提供完整的代码生成部分，并在生成的代码中提供流利的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>

答案 6 :(得分：0)

对于那些使用多个 wsdl 文件的人：

pom.xml

<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxws-maven-plugin</artifactId>
<version>2.6</version>
<executions>
    <execution>
        <phase>generate-sources</phase>
        <goals>
            <goal>wsimport</goal>
        </goals>
        <configuration>
            <bindingDirectory>${basedir}/src/main/resources/jaxws</bindingDirectory>
            <bindingFiles>
                <bindingFile>binding.xjb</bindingFile>
            </bindingFiles>
            <wsdlDirectory>${basedir}/src/main/resources/wsdl</wsdlDirectory>
            <wsdlFiles>
                <wsdlFile>VN_PCSApplicationManagementService_v21.xml</wsdlFile>
                <wsdlFile>VN_PCSApplicationOfferManagementService_v7.xml</wsdlFile>
                <wsdlFile>VN_PCSOnlineDebtService_v2.xml</wsdlFile>
            </wsdlFiles>
        </configuration>
    </execution>
</executions>

创建服务客户端时：

@Bean
public ApplicationOfferManagementWSV7 getAppOfferWS() {
    String wsdlLocation = OnlineDebtWSv2Soap11QSService.class.getAnnotation(WebServiceClient.class).wsdlLocation().replaceFirst(".+wsdl/", "/wsdl/");
    URL url = this.getClass().getResource(wsdlLocation);
    ApplicationOfferManagementWSV7 applicationManagementWSV21 = new ApplicationOfferManagementWSV7Soap11QSService(url)
            .getApplicationOfferManagementWSV7Soap11QSPort();

    BindingProvider binding = (BindingProvider) applicationManagementWSV21;
    binding.getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username);
    binding.getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
    binding.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, offerEndpoint);

    return applicationManagementWSV21;
}
相关问题
最新问题