xml - 使用 Maven 和重用类生成 WS 客户端

标签 xml web-services maven xsd cxf-codegen-plugin

我的应用程序分为两层，其中后端层公开一堆 Web 服务，表示层使用这些服务来获取业务数据。

为了使我的构建尽可能自动化，我将所有生成的 WSDL 和关联的 XSD 文件打包到 ZIP 依赖​​项中(使用 Maven 汇编器插件)，该依赖项在安装阶段上传到我的 nexus。

然后在 UI POM 上，我将此 ZIP 文件(使用 Maven 依赖插件)解压到本地目录 ( src/main/resources/wsdl )，然后使用 CXF-CODEGEN 插件生成客户端。

问题是——许多服务共享通用模型实体，例如许多方法使用 Catalogue类，它是我用于由 Id 和文本值组成的对象的实体。

使用 CXF 生成的代码，我最终得到了不同的 Catalogue类(具有不同的包名称)为我拥有的每个 Web 服务，从而在我的代码中失去了 OO 多态性功能，因为它们在实践中都是不同的类。

我听说您可以通过某种方式首先将 XSD 类编译为所谓的“剧集”，然后将这些剧集文件提供给 CXF，以告诉它利用它们而不是生成类，从而避免此问题。

我尝试添加一个额外的编译步骤，在该步骤中运行 maven-jaxb2-plugin 以从 XSD 生成类，但我得到了 org.xml.sax.SAXParseException; (...) 'catalogueDTO' is already defined 异常，因为此类在 XSD 文件中重复。

有人能指出我正确的方向吗？

最佳答案

当您的 Web 服务中有一些将在服务和操作之间使用的基类时，最好在单个 XSD 中声明这些类，然后在您的项目中包含并使用此 XSD。

以下示例将向您展示如何操作。我将此示例基于所提供的信息，因此它可能并不完全适合您的需要，但会向您展示概念。

首先让我们创建一个 Catalog.xsd 文件，并使用以下代码在此文件中声明我们的目录对象:

<?xml version="1.0" encoding="utf-8" ?>

<xs:schema xmlns="http://www.yourcompany.com/Services_V1/CommonType"
       elementFormDefault="qualified"
       targetNamespace="http://www.yourcompany.com/Services_V1/CommonType"
       xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="CatalogueID_Type">
    <xs:annotation>
        <xs:documentation>The Catalogue ID is an integer value that is used to uniquely identify the catalog item on the database.</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:int" />
</xs:simpleType>
<xs:simpleType name="CatalogueValue_Type">
    <xs:annotation>
        <xs:documentation>The catalog is a string value that will contain the information describing the catalog key.</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string" />
</xs:simpleType>
<xs:complexType name="Catalogue_Type">
    <xs:sequence>
        <xs:element ref="CatalogID"
                    minOccurs="1"
                    maxOccurs="1" />
        <xs:element ref="CatalogueValue"
                    minOccurs="0"
                    maxOccurs="1" />
    </xs:sequence>
</xs:complexType>
<xs:element name="CatalogID"
            type="CatalogueID_Type" />
<xs:element name="CatalogueValue"
            type="CatalogueValue_Type" />
<xs:element name="Catalogue"
            type="Catalogue_Type" />

或者如果您喜欢视觉表示:

Catalogue XML Object

需要注意的是，目录类/对象具有 http://www.yourcompany.com/Services_V1/CommonType 命名空间，我们将在 WSDL 中再次使用此命名空间。该对象现在将由两个服务(BathroomCatalogue 服务和 KicthenCatalogue 服务)使用。为简单起见，我在服务中只进行了一项名为 GetCatalogueItem 的操作。对于其中每一项服务，我将包含 catalog.xsd 文件并重用此目录对象。

这是浴室服务的 WSDL:

<?xml version="1.0" encoding="utf-8"?>
<wsdl:definitions name="BathroomCatalogueSRV"
              targetNamespace="http://www.yourcompany.com/Services_V1/BathroomCatalogueService"
              xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
              xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
              xmlns:tns="http://www.yourcompany.com/Services_V1/BathroomCatalogueService"
              xmlns:xs="http://www.w3.org/2001/XMLSchema"
              xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
              xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
              xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
              xmlns:catalogue="http://www.yourcompany.com/Services_V1/CommonType">
<wsdl:types>
    <xs:schema elementFormDefault="qualified"
               targetNamespace="http://example.com/">
        <xs:import schemaLocation="Catalog.xsd"
                   namespace="http://www.yourcompany.com/Services_V1/CommonType" />

    </xs:schema>
</wsdl:types>
<wsdl:message name="GetCatalogueItemReq">
    <wsdl:part name="GetCatalogueItemReq"
               element="catalogue:Catalogue" />
</wsdl:message>
<wsdl:message name="GetCatalogueItemRs">
    <wsdl:part name="GetCatalogueItemRs"
               element="catalogue:Catalogue" />
</wsdl:message>
<wsdl:portType name="BathroomCataloguePortType">
    <wsdl:operation name="GetCatalogueItem">
        <wsdl:input message="tns:GetCatalogueItemReq" />
        <wsdl:output message="tns:GetCatalogueItemRs" />
    </wsdl:operation>
</wsdl:portType>
<wsdl:binding name="BathroomCatalogueBinding"
              type="tns:BathroomCataloguePortType">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http"
                  style="document" />
    <wsdl:operation name="GetCatalogueItem">
        <wsdl:input />
        <wsdl:output />
    </wsdl:operation>
</wsdl:binding>
<wsdl:service name="BathroomCatalogueService">
    <wsdl:port name="BathroomCataloguePort"
               binding="tns:BathroomCatalogueBinding">
        <soap:address location="http://www.yourcompany.com/Services_V1/BathroomCatalogueService" />
    </wsdl:port>
</wsdl:service>

或者如果您想要视觉表示:

Bathroom Service

厨房 WSDL 如下所示:

<?xml version="1.0" encoding="utf-8"?>

<wsdl:definitions name="KitchenCatalogueSRV"
              targetNamespace="http://www.yourcompany.com/Services_V1/KitchenCatalogueService"
              xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
              xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
              xmlns:tns="http://www.yourcompany.com/Services_V1/KitchenCatalogueService"
              xmlns:xs="http://www.w3.org/2001/XMLSchema"
              xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
              xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
              xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
              xmlns:catalogue="http://www.yourcompany.com/Services_V1/CommonType">
<wsdl:types>
    <xs:schema elementFormDefault="qualified"
               targetNamespace="http://example.com/">
        <xs:import schemaLocation="Catalog.xsd"
                   namespace="http://www.yourcompany.com/Services_V1/CommonType" />

    </xs:schema>
</wsdl:types>
<wsdl:message name="GetCatalogueItemReq">
    <wsdl:part name="GetCatalogueItemReq"
               element="catalogue:Catalogue" />
</wsdl:message>
<wsdl:message name="GetCatalogueItemRs">
    <wsdl:part name="GetCatalogueItemRs"
               element="catalogue:Catalogue" />
</wsdl:message>
<wsdl:portType name="KitchenCataloguePortType">
    <wsdl:operation name="GetCatalogueItem">
        <wsdl:input message="tns:GetCatalogueItemReq" />
        <wsdl:output message="tns:GetCatalogueItemRs" />
    </wsdl:operation>
</wsdl:portType>
<wsdl:binding name="KitchenCatalogueBinding"
              type="tns:KitchenCataloguePortType">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http"
                  style="document" />
    <wsdl:operation name="GetCatalogueItem">
        <wsdl:input />
        <wsdl:output />
    </wsdl:operation>
</wsdl:binding>
<wsdl:service name="KitchenCatalogueService">
    <wsdl:port name="KitchenCataloguePort"
               binding="tns:KitchenCatalogueBinding">
        <soap:address location="http://www.yourcompany.com/Services_V1/KitchenCatalogueService" />
    </wsdl:port>
</wsdl:service>

再一次从视觉上看:

Kitchen Service

在这两个 WSDL 文件中，我都包含了catalog.xsd 文件。您可以在以下代码行中看到这一点:

<xs:import schemaLocation="Catalog.xsd" 
 namespace="http://www.yourcompany.com/Services_V1/CommonType" />

现在，当我将这些 WSDL 和 XSD 与 cxf 一起使用时，这两个服务将仅使用一个目录对象/类。我很快做了一个shell项目，生成了以下结构:

Project Folders

请注意，我声明的 CatalogueType 现在与我声明它的命名空间位于同一个包中。

查看服务类别时，浴室和厨房服务都将使用这一类别。在厨房服务类中，它使用com.yourcompany.services_v1.commontype.CatalogueType。

@WebService(targetNamespace = "http://www.yourcompany.com/Services_V1/KitchenCatalogueService", name = "KitchenCataloguePortType")
@XmlSeeAlso({com.yourcompany.services_v1.commontype.ObjectFactory.class})
@SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
public interface KitchenCataloguePortType {

@WebResult(name = "Catalogue", targetNamespace = "http://www.yourcompany.com/Services_V1/CommonType", partName = "GetCatalogueItemRs")
@WebMethod(operationName = "GetCatalogueItem")
public com.yourcompany.services_v1.commontype.CatalogueType getCatalogueItem(
    @WebParam(partName = "GetCatalogueItemReq", name = "Catalogue", targetNamespace = "http://www.yourcompany.com/Services_V1/CommonType")
    com.yourcompany.services_v1.commontype.CatalogueType getCatalogueItemReq
);
}

在厨房服务类中，它使用com.yourcompany.services_v1.commontype.CatalogueType。

@WebService(targetNamespace = "http://www.yourcompany.com/Services_V1/BathroomCatalogueService", name = "BathroomCataloguePortType")
@XmlSeeAlso({com.yourcompany.services_v1.commontype.ObjectFactory.class})
@SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
public interface BathroomCataloguePortType {

@WebResult(name = "Catalogue", targetNamespace = "http://www.yourcompany.com/Services_V1/CommonType", partName = "GetCatalogueItemRs")
@WebMethod(operationName = "GetCatalogueItem")
public com.yourcompany.services_v1.commontype.CatalogueType getCatalogueItem(
    @WebParam(partName = "GetCatalogueItemReq", name = "Catalogue", targetNamespace = "http://www.yourcompany.com/Services_V1/CommonType")
    com.yourcompany.services_v1.commontype.CatalogueType getCatalogueItemReq
);
}

提醒一下，您绝不能编辑这些类，因为它们是由 CXF 派生和生成的，您的更改将会丢失。因此，通过采用 WSDL 第一种方法，您必须确保正确构建 XSD 文件和 WSDL。

请告诉我这是否有意义。

关于xml - 使用 Maven 和重用类生成 WS 客户端，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/28340258/

上一篇：spring - 如果目标上的消费者已关闭，则通知 ActiveMQ 生产者

下一篇：ruby-on-rails - 有没有办法将关系与OR结合起来？

相关文章：

c# - 如何在 C# 中管理依赖项？

asp.net - XML 与 SQlite 与 Access

web-services - CXF jaxws 端点相对发布地址

git - gitlab 中的 Maven 发布

html - Byethost 网络服务将无法工作。它不会与端口 21 上的 ftp 服务器连接

c# - 最佳实践 : Persisting data throughout multiple web method calls

java - Maven运行测试，然后编译然后进行其他测试

c# - 在功能区中使用 .ico 图像

ruby - 选择相邻的兄弟元素而不插入非空白文本节点

c# - 如何从 CDATA 中删除 href 标签

©2024 IT工具网  联系我们