使用 Axis2 和 JiBX 将 Java 类转换成 Web 服务,第 1 部分: 使用 XML 通过 Java 类定义 Web 服务
[ http://blog.csdn.net/phantomhu/archive/2008/02/26/2121397.aspx ] Web 服务在日常开发中重要性与日俱增,Axis2 也成为了倍受人们欢迎的开发 Web 服务的开放源码平台。Axis2 使用 Java 语言编写,它能利用了 JiBX(一种框架,用于将XML和Java绑定在一起)的自由性。假设您有一个含有大量 Java 类和数据结构的 Java 项目,而且不想打乱或者更改它们。JiBX 会帮助您实现这一切,它把在 Axis2 中使用的 XML 数据与 Java 类绑定在一起。这样做的好处是代码易于维护,因为 Web 服务只使用已经开发好、可靠、真正的 Java 类。 本文介绍了将在本系列中使用的 Java 类,并解释了如何生成能准确描述这些 Java 类的 Web 服务描述语言(Web Services Description Language,WSDL)和 JiBX 定义。本系列的第 2 部分将使用 WSDL 和 JiBX XML 文档创建一个 Web 服务的 Java 实现,该 Web 服务使用这个 Java 类作为数据绑定。 要学习这个分为两部分的系列文章,需要如下软件:
下载完上述所有软件后,解压 Geronimo 并键入: 然后,为部署 axis2.war 文件,将 axis2 文件复制到 <geronimo-home>/deploy 目录。 解压 Axis2 二进制文件,将 AXIS2_HOME 环境变量设置为 Axis2 二进制文件解压的目录(本例中设置为 c:\apps\axis2-1.1)。然后解压 JiBX,并将 <jibx-home>/lib 目录的所有 JAR 文件(除了 stax-api.jar 文件之外,因为 Axis2 已经含有了 stax-api.jar 文件)复制到 <axis2-home>/lib 目录下。 这样就设置好了环境。 这里提供了一些 Java 类,用于构成一个简单的 Web 服务 Java 项目。使用什么样的 Java 类并无大障,您也可以使用自己创建的 Java 类。本文使用的项目含有三个类: package com.ibm.devWorks.xml.simpleService;
public class OneWayRequest ...{ protected String requestData; public String getRequestData() ...{ return this.requestData; } public void setRequestData(String requestData) ...{ this.requestData = requestData; } } 上面的代码中只含有一个字段,即 接下来再看一看清单 2 中的 package com.ibm.devWorks.xml.simpleService;
public class TwoWayRequest ...{ protected String echoString; protected boolean booolean; public boolean getBooolean() ...{ return this.booolean; } public void setBooolean(boolean booolean) ...{ this.booolean = booolean; } public String getEchoString() ...{ return this.echoString; } public void setEchoString(String echoString) ...{ this.echoString = echoString; } } 这个类要稍长一点,它定义了两个字段:一个是 清单 3 显示了最后一个类,即 package com.ibm.devWorks.xml.simpleService;
public class TwoWayResponse ...{ protected String echoString; protected boolean invertedBoolean; public boolean getInvertedBoolean() ...{ return this.invertedBoolean; } public void setInvertedBoolean(boolean invertedBoolean) ...{ this.invertedBoolean = invertedBoolean; } public String getEchoString() ...{ return this.echoString; } public void setEchoString(String echoString) ...{ this.echoString = echoString; } } 这个类与前一个 在本系统文章的第 2 部分中,我们将使用 Axis2 读取在本节中创建的 WSDL,用以创建 Web 服务的一个 Java 实现。 在深入学习之前,我们需要先了解一些关于 Web 服务的知识。 接下来回到 WSDL,我们首先需要建立名称空间,如清单 4 如示。 <?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions xmlns:apachesoap="http://xml./xml-soap" xmlns:impl="http://ibm.com/developerWorks/xml/SimpleService" xmlns:intf="http://ibm.com/developerWorks/xml/SimpleService" xmlns:wsdl="http://schemas./wsdl/" xmlns:wsdlsoap="http://schemas./wsdl/soap/" xmlns:xsd="http://www./2001/XMLSchema" targetNamespace="http://ibm.com/developerWorks/xml/SimpleService"> ... 这基本上准备好了 WSDL,稍后我们将在 WSDL 中引用名称空间。当 Axis2 读取 WSDL 文件时,它需要知道我们引用的名称空间的值。 接下来,定义模式,如清单 5 所示。 targetNamespace="http://ibm.com/developerWorks/xml/SimpleService">
<wsdl:types> <schema elementFormDefault="qualified" targetNamespace="http://ibm.com/developerWorks/xml/SimpleService" xmlns="http://www./2001/XMLSchema"> <!-- ELEMENTS --> <element name="OneWayRequest"> <complexType> <sequence> <element name="requestData" type="xsd:string"/> </sequence> </complexType> </element> <element name="TwoWayRequest"> <complexType> <sequence> <element name="echoString" type="xsd:string"/> <element name="booolean" type="xsd:boolean"/> </sequence> </complexType> </element> <element name="TwoWayResponse"> <complexType> <sequence> <element name="echoString" type="xsd:string"/> <element name="invertedBoolean" type="xsd:boolean"/> </sequence> </complexType> </element> </schema> </wsdl:types> ... 您应该对此代码比较熟悉。这在本质上是通过模式定义的 Java 类。请注意,Java 类中的字段匹配上述模式元素中子元素。还需注意,名称空间为 此时再定义消息、端口类型、绑定和 WSDL 服务(如清单 6 所示)。 ...
</wsdl:types> <!-- MESSAGES --> <wsdl:message name="OneWayRequestMessage"> <wsdl:part name="input" element="impl:OneWayRequest"/> </wsdl:message> <wsdl:message name="TwoWayRequestMessage"> <wsdl:part name="input" element="impl:TwoWayRequest"/> </wsdl:message> <wsdl:message name="TwoWayResponseMessage"> <wsdl:part name="output" element="impl:TwoWayResponse"/> </wsdl:message> <!-- Port type (operations) --> <wsdl:portType name="SimpleServicePortType"> <wsdl:operation name="OneWay" parameterOrder="input"> <wsdl:input name="OneWayRequestMessage" message="impl:OneWayRequestMessage"/> </wsdl:operation> <wsdl:operation name="TwoWay" parameterOrder="input"> <wsdl:input name="TwoWayRequestMessage" message="impl:TwoWayRequestMessage"/> <wsdl:output name="TwoWayResponseMessage" message="impl:TwoWayResponseMessage"/> </wsdl:operation> </wsdl:portType> <!-- BINDING (bind operations) --> <wsdl:binding name="SimpleServiceSoapBinding" type="impl:SimpleServicePortType"> <wsdlsoap:binding style="document" transport="http://schemas./soap/http"/> <wsdl:operation name="OneWay"> <wsdlsoap:operation soapAction="OneWay"/> <wsdl:input> <wsdlsoap:body use="literal"/> </wsdl:input> </wsdl:operation> <wsdl:operation name="TwoWay"> <wsdlsoap:operation soapAction="TwoWay"/> <wsdl:input> <wsdlsoap:body use="literal"/> </wsdl:input> <wsdl:output> <wsdlsoap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <!-- SERVICE --> <wsdl:service name="SimpleService"> <wsdl:port binding="impl:SimpleServiceSoapBinding" name="SimpleService"> <wsdlsoap:address location="http://localhost:8080/axis2/services/SimpleService"/> </wsdl:port> </wsdl:service> </wsdl:definitions> 定义的消息映射到模式中的请求和响应元素,由端口类型定义使用,每项操作的输入和输出都映射一个消息。绑定部分在本质上映射一项 SOAP 操作,确切定义了绑定服务的协议和传输方法及其相关操作。最后,服务部分指定了可用服务,展示了每个服务的服务端点(可以访问到服务的 URL)。 这样便完成了该 Web 服务的定义。接下来,我们将把 XML 映射到 Java 类,以便在本系列的下一部分中使用 JiBX 进行数据绑定。 JiBX 定义描述的主要目的是将 Java 类映射到名称空间,包括任何期望的字段。在看了本节创建的文件之后,您会将了解更多。首先,看一看 <?xml version="1.0" encoding="UTF-8"?>
<binding> <mapping name="OneWayRequest" class="com.ibm.devWorks.xml.simpleService.OneWayRequest"> <namespace uri="http://ibm.com/developerWorks/xml/SimpleService" default="elements"/> <value name="requestData" field="requestData" usage="required"/> </mapping> ... mapping 标签中的 接下来,我们将介绍其它两个 Java 类是如何映射的,如清单 8 所示。
...
<mapping name="TwoWayRequest" class="com.ibm.devWorks.xml.simpleService.TwoWayRequest"> <namespace uri="http://ibm.com/developerWorks/xml/SimpleService" default="elements"/> <value name="echoString" field="echoString" usage="required"/> <value name="booolean" field="booolean" usage="required"/> </mapping> <mapping name="TwoWayResponse" class="com.ibm.devWorks.xml.simpleService.TwoWayResponse"> <namespace uri="http://ibm.com/developerWorks/xml/SimpleService" default="elements"/> <value name="echoString" field="echoString" usage="required"/> <value name="invertedBoolean" field="invertedBoolean" usage="required"/> </mapping> </binding> 在清单 8中,我们能看到
太棒了!我们已经完成了一半。我们利用了已有的 Java 类,为其定义了一个 XML 模式,并通过 WSDL 和 Web 服务中的操作将它们公开。我们创建了一个 JiBX 定义描述,它将 Java 类与模式中的元素映射起来,使 Axis2 JiBX 数据绑定能正确地将 Web 服务 SOAP 数据与 Java 类绑定在一起。 在第 2 部分中,Axis2 将使用 JiBX 定义描述生成服务主干和客户端的雏形。我们将在 Apache Geronimo 上部署最终的 Apache Axis2 Web 服务,然后生成并创建一个与部署好的 Web 服务通信的客户机,以此完成测试。
|
|