详解Axis2实现Web Services之ADB篇

danlley

构建一个新的Web Services服务，会有很多种不同的方法，你即可以用pojo结合rpc模式来写，也可以用axis2自己的axiom api从底层写，也可以从wsdl生成相应框架，然后填写相应逻辑。
对于wsdl生成框架代码这种形式，又有不同的数据绑定可以使用。axis2 1.1 可以使用adb(axis2自己的data binding)、xmlbeans、jibx、jaxme、jaxbri。其中常用的还是前两种，axis2官方是极力推荐自己的data binding的，因为速度快，架构相对简单，而且有一些独有的特性。xmlbeans，是对模式支持最好的data binding，一些特别复杂的模式只能在xmlbeans下才能正确生成框架代码。其他几种代码wsdl2java目前都不是支持得很好，都还在实验改进阶段。
面对这么多数据绑定模式，很多人都无从选择。官方maillist上也有好多人问该用哪个。查了一些资料，据说，adb很好用，而且速度快，如果只是简单的模式，那么使用这种数据绑定就可以了。xmlbeans的强力模式支持，可以支持足够负责的模式，但是速度上也只是比adb低5%左右。
axis2的wsdl2java工具对于adb以及xmlbeans支持都已经很好了，可以直接从wsdl2java生成相应的绑定类
Axis2 还提供自己的简单数据绑定框架，称为 Axis2 Data Binding (ADB)。这就允许用户下载 Axis2 并使用它，而不用太多考虑数据绑定框架。由于 ADB 和 Axis2 内部元素之间实现了紧密的集成，可以预见，与其他框架相比，此框架的性能和生成代码维护方面都更具优势。

为了充分利用资源，我们用上一个有关AXIOM专题的例子中生成的WSDL文件来为这个例子服务
1.生成ADB服务框架。使用的ＷＳＤＬ文件如下：
http://service.util.danlley.org
" xmlns:soap12="
http://schemas.xmlsoap.org/wsdl/soap12/
"
xmlns:http="
http://schemas.xmlsoap.org/wsdl/http/
" xmlns:mime="
http://schemas.xmlsoap.org/wsdl/mime/
"
xmlns:ns="
http://service.util.danlley.org/xsd
" xmlns:soap="
http://schemas.xmlsoap.org/wsdl/soap/
" xmlns:wsdl="
http://schemas.xmlsoap.org/wsdl/
"
targetNamespace="
http://service.util.danlley.org
">

  
http://www.w3.org/2001/XMLSchema
" attributeFormDefault="qualified" elementFormDefault="qualified"
   targetNamespace="
http://service.util.danlley.org/xsd
">
   
   
     
      
     
   
   
   
   
     
      
     
   
   
   
   
     
      
     
   
   
   
   
     
      
     
   
   
   
   
     
      
     
   
   
   
   
     
      
     
   
   
  


  


  


  


  


  


  


  
   
   
   
  
  
   
   
   
  


  
http://schemas.xmlsoap.org/soap/http
" style="document" />
  
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
  
  
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
  


  
http://schemas.xmlsoap.org/soap/http
" style="document" />
  
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
  
  
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
   
   
http://service.util.danlley.org
" />
   
  


  
   
http://localhost:8080/axis2/services/HelloWorldAxiom
" />
  
  
   
http://localhost:8080/axis2/services/HelloWorldAxiom
" />
  





2.生成工程框架

运行命令如下：WSDL2Java -uri resources/META-INF/HelloWorldAxiom.wsdl -p org.danlley.service.adb -d adb -s -ss -sd -ssi -o build/service
如果得到以下结果则说明执行成功：
D:\eclipse\workspace\axis2adblab>WSDL2Java -uri resources/META-INF/HelloWorldAxi
om.wsdl -p org.danlley.service.adb -d adb -s -ss -sd -ssi -o build/service
Using AXIS2_HOME:   D:\axis2-1.1.1
Using JAVA_HOME:    C:\Program Files\Java\jdk1.5.0_06
D:\eclipse\workspace\axis2adblab>


执行成功后在工程中出现的路径如下：
./build/service/build.xml
./build/service/resources/HelloWorldAxiom.wsdl
                                             services.xml
./build/service/src/org/danlley/service/adb/GetHelloMessageFaultException.java
                                                                           GetMoreMessageFaultException.java
                                                                           HelloWorldAxiomMessageReceiverInOut.java
                                                                           HelloWorldAxiomSkeleton.java
                                                                           HelloWorldAxiomSkeletonInterface.java
./build/service/src/org/danlley/util/service/xsd/ExtensionMapper.java
                                                                                 GetHelloMessage.java
                                                                                 GetHelloMessageFault.java
                                                                                 GetHelloMessageResponse.java
                                                                                 GetMoreMessage.java
                                                                                 GetMoreMessageFault.java
                                                                                 GetMoreMessageResponse.java





3.分析框架结构

Ａｘｉｓ·２的服务确实够周到的，不仅仅给我们把整个服务的框架都搭建好了，而且，还给我们顺便连编译工程所需用的Ａｎｔ脚本都生成好了。真是不得不让人感叹一句"Apache办事，我放心！"呵呵呵。
让我们先大体看看生成的这些Ｊａｖａ代码的作用，GetHelloMessageFaultException和GetMoreMessageFaultException是用来做异常处理的。关于这个话题我以纪在以前的专题中已经有过提及（也就是跟Fault相关的话题）。
说到Fault就不得不再提提SOAP 处理模型，Axis2 体系结构定义了两个管道（或流），分别称为 InPipe (InFlow) 和 OutPipe (OutFlow)，用于处理服务器端的请求消息和响应消息。在客户端，这两个管道是反向的——换句话说，SOAP 请求消息流经 OutPipe，而响应消息流经 InPipe。管道或流包含一系列分为阶段的处理程序。除预先定义的阶段和处理程序集外，用户还可以在操作级别、服务级别或全局级别配置用户阶段和相关处理程序。处理程序充当 SOAP 消息的拦截器，可以处理 SOAP 消息的 Header 或 Body。InPipe 是通过以下阶段进行配置的：
TransportIn
PreDispatch
Dispatch
PostDispatch
PolicyDetermination
User phases
Message validation



请求消息在通过 Inpipe 中配置的所有阶段后，到达 MessageReceiver，然后由 MessageReceiver 调用实际服务实现。服务器的 OutPipe 包含以下阶段：
Message initialization
Policy determination
User phases
MessageOut
用户配置的阶段位于这两个管道的用户阶段(User phases) 部分。如果在执行这些管道的过程中发生错误，则这些错误将通过 InFaultPipe 或 OutFaultPipe 管道。收到 Fault 消息后，在客户端调用 InFaultPipe；如果某个调用导致将错误发送到客户端，则在服务器端调用 OutFaultPipe。用户可以将处理程序添加到预先定义的阶段，并且按照这些处理程序运行的顺序进行配置。
那么既然ADB pattern为我们提供了GetHelloMessageFaultException、GetMoreMessageFaultException、GetHelloMessageFault和GetMoreMessageFault类。那也就意味着我们可以对这些类进行扩充，以满足我们在实际当中的应用需求。由于我们Axiom的专题中举例时，两个实例均采用了in-Out模式，因此通过此工程的WSDL生成的ADB框架也就只有HelloWorldAxiomMessageReceiverInOut类来处理In-Out模式。GetHelloMessage和GetMoreMessage用来对接口HelloWorldAxiomSkeletonInterface的收取的数据进行封装，而GetHelloMessageResponse和GetMoreMessageResponse类则用于封装由HelloWorldAxiomSkeleton类处理后的结果。也就是说，真正的服务提供者就是HelloWorldAxiomSkeleton类。现在思路已经整理清楚，ADB生成的框架也基本上相当清楚了。那么剩下就是为我们新生成的框架动点小外科手术的时候了。






4.构建工程
根据我个人喜好，我的工程目录结构整理后如下：
./build.xml
./resources/HelloWorldAxiom.wsdl
                     services.xml
./src/main/java/org/danlley/service/adb/GetHelloMessageFaultException.java
                                                                       GetMoreMessageFaultException.java
                                                                       HelloWorldAxiomMessageReceiverInOut.java
                                                                       HelloWorldAxiomSkeleton.java
                                                                       HelloWorldAxiomSkeletonInterface.java
./src/main/java/org/danlley/util/service/xsd/ExtensionMapper.java
                                                                             GetHelloMessage.java
                                                                             GetHelloMessageFault.java
                                                                             GetHelloMessageResponse.java
                                                                             GetMoreMessage.java
                                                                             GetMoreMessageFault.java
                                                                             GetMoreMessageResponse.java

工程目录改变也就意味着我们需要修改Ａｎｔ脚本，修改后的脚步如下：














  
  
  
   
  


  
  
  
  


  
  
  
  
   
   
   
   
  
  
  
  


  
   
  


  
   
   
  


  



  
   
   
   
   
   
  
  
   
  


  
   
   
   
   
   
   
  


  
  
  


  
   
   
  


  
   
   
  
  
  
   
   
   
   
     
   
   
  


  


打开HelloWorldAxiomSkeleton类：
package org.danlley.service.adb;
import org.danlley.util.service.xsd.GetHelloMessage;
import org.danlley.util.service.xsd.GetHelloMessageResponse;
import org.danlley.util.service.xsd.GetMoreMessage;
import org.danlley.util.service.xsd.GetMoreMessageResponse;
public class HelloWorldAxiomSkeleton implements HelloWorldAxiomSkeletonInterface{
    public GetMoreMessageResponse getMoreMessage(GetMoreMessage param4) throws GetMoreMessageFaultException{
        //Todo fill this with the necessary business logic
        throw new UnsupportedOperationException("Please implement "+this.getClass().getName()+"#getMoreMessage");
    }
    public GetHelloMessageResponse getHelloMessage(GetHelloMessage param6) throws GetHelloMessageFaultException{
        //Todo fill this with the necessary business logic
        throw new UnsupportedOperationException("Please implement "+this.getClass().getName()+"#getHelloMessage");
    }
}


实现HelloWorldAxiomSkeleton类：
package org.danlley.service.adb;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.danlley.util.service.xsd.GetHelloMessage;
import org.danlley.util.service.xsd.GetHelloMessageResponse;
import org.danlley.util.service.xsd.GetMoreMessage;
import org.danlley.util.service.xsd.GetMoreMessageResponse;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentFactory;
import org.dom4j.DocumentHelper;
public class HelloWorldAxiomSkeleton implements HelloWorldAxiomSkeletonInterface{
    public GetMoreMessageResponse getMoreMessage(GetMoreMessage param4) throws GetMoreMessageFaultException{
        try{
            OMElement element=param4.getElement();
            element.build();
            element.detach();
            DocumentFactory dom=new DocumentFactory();
            dom.createDocument(element.toString());
            System.out.println(element.toString());
            Document doc=DocumentHelper.parseText(element.toString());
            String msg=doc.selectSingleNode("//tns:msg").getText();
            String userPWD=doc.selectSingleNode("//tns:userPWD").getText();
            String transactionKey=doc.selectSingleNode("//tns:transactionKey").getText();
            System.out.println("\n msg="+msg+"\n userPWD="+userPWD+"\n transactionKey="+transactionKey);
            OMFactory fac=OMAbstractFactory.getOMFactory();
            OMNamespace omNs=fac.createOMNamespace("
http://service.util.danlley.org/xsd","ns
");
            OMElement method=fac.createOMElement("getHelloMessageResponse",omNs);
            OMElement value=fac.createOMElement("return",omNs);
            String returnText="MultiMessage for U, Danlley!";
            returnText=returnText+"\n msg="+msg+"\t userPWD="+userPWD+"\t transactionKey="+transactionKey;
            value.addChild(fac.createOMText(value,returnText));
            method.addChild(value);
            GetMoreMessageResponse response=new GetMoreMessageResponse();
            response.set_return(method);
            return response;
        }catch(OMException e){
            e.printStackTrace();
            return null;
        }catch(DocumentException e){
            e.printStackTrace();
            return null;
        }
    }
    public GetHelloMessageResponse getHelloMessage(GetHelloMessage param6) throws GetHelloMessageFaultException{
        OMElement element=param6.getElement();
        element.build();
        element.detach();
        OMElement symbolElement=element.getFirstElement();
        String helloworld=symbolElement.getText();
        System.out.println("We got the messages :"+(helloworld!=null?helloworld:"No Msg!"));
        String returnText="You are Perfect, Danlley!";
        OMFactory fac=OMAbstractFactory.getOMFactory();
        OMNamespace omNs=fac.createOMNamespace("
http://service.util.danlley.org/xsd","ns
");
        OMElement method=fac.createOMElement("getHelloMessageResponse",omNs);
        OMElement value=fac.createOMElement("return",omNs);
        value.addChild(fac.createOMText(value,returnText));
        method.addChild(value);
        GetHelloMessageResponse response=new GetHelloMessageResponse();
        response.set_return(method);
        return response;
    }
}





5.发布、部署

执行ａｎｔ脚本声称aar包。部署aar到tomcat目录下，在浏览器中访问：
http://localhost:8080/axis2/services/HelloWorldAxiom?wsdl
就可以看到我们生成的新的ＷＳＤＬ。由于WSDL 文件过于繁冗，让我们看看XSD文件就已经足够了，访问地址：
http://localhost:8080/axis2/services/HelloWorldAxiom?xsd
　可以看到如下内容：
http://www.w3.org/2001/XMLSchema
" xmlns:axis2="
http://service.util.danlley.org
"
xmlns:http="
http://schemas.xmlsoap.org/wsdl/http/
" xmlns:mime="
http://schemas.xmlsoap.org/wsdl/mime/
"
xmlns:ns="
http://service.util.danlley.org/xsd
" xmlns:soap="
http://schemas.xmlsoap.org/wsdl/soap/
"
xmlns:soap12="
http://schemas.xmlsoap.org/wsdl/soap12/
" xmlns:wsaw="
http://www.w3.org/2006/05/addressing/wsdl
"
xmlns:wsdl="
http://schemas.xmlsoap.org/wsdl/
" attributeFormDefault="qualified" elementFormDefault="qualified"
targetNamespace="
http://service.util.danlley.org/xsd
">

  
   
   
   
  


  
   
   
   
  


  
   
   
   
  


  
   
   
   
  


  
   
   
   
  


  
   
   
   
  

这个是编写客户端必不可少的一个信息了。





6.生成客户端框架。

执行以下命令：
WSDL2Java -uri resources/META-INF/HelloWorldAxiom.wsdl -p org.danlley.testcase.client -d adb -s -o build/client
得到以下结果，那么说明客户端运行框架已经生成
D:\eclipse\workspace\axis2adblab>WSDL2Java -uri resources/META-INF/HelloWorldAxi
om.wsdl -p org.danlley.testcase.client -d adb -s -o build/client
Using AXIS2_HOME:   D:\axis2-1.1.1
Using JAVA_HOME:    C:\Program Files\Java\jdk1.5.0_06
D:\eclipse\workspace\axis2adblab>
根据我们的定义，该客户端框架在build/client目录下。将生成的客户端支持框架整理到我们的客户端程序存放路径下：src/test/java
目录结构如下：
./src/test/java/org/danlley/testcase/client/GetHelloMessageFaultException.java
                                                                        GetMoreMessageFaultException.java
                                                                        HelloWorldAxiomStub.java

在此目录下定义一个 ADBClient.java，也就是我们Ｗｅｂ　Ｓｅｒｖｉｃｅｓ客户端。
实现ADBClient类（这里我们只实现了对getHelloMessage的处理）：
package org.danlley.testcase.client;
import java.io.StringWriter;
import java.rmi.RemoteException;
import javax.xml.stream.XMLOutputFactory;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.axis2.AxisFault;
import org.apache.axis2.Constants;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.ServiceClient;
import org.danlley.util.service.xsd.GetHelloMessage;
import org.danlley.util.service.xsd.GetHelloMessageResponse;
public class ADBClient{
    private static EndpointReference targetEPR=new EndpointReference("
http://localhost:8080/axis2/services/HelloWorldAxiom
");
    public static void main(String[] args){
        try{
            getHelloMessage("Hi, Danlley !");
            System.out.println("END
    public static void getHelloMessage(String msg){
        try{
            HelloWorldAxiomStub stub=new HelloWorldAxiomStub("
http://localhost:8080/axis2/services/HelloWorldAxiom
");
            HelloWorldAxiomStub.GetHelloMessage helloMsg=new HelloWorldAxiomStub.GetHelloMessage();
            OMElement element=getOMElement(msg);
            helloMsg.setElement(element);
            System.out.println(helloMsg.getElement().toString());
            HelloWorldAxiomStub.GetHelloMessageResponse helloResponse;
            helloResponse=stub.getHelloMessage(helloMsg);
            OMElement return_val=helloResponse.get_return();
            System.out.println(return_val);
        }catch(AxisFault e){
            e.printStackTrace();
        }catch(RemoteException e){
            e.printStackTrace();
        }catch(GetHelloMessageFaultException e){
            e.printStackTrace();
        }
    }
    public static OMElement getOMElement(String msg){
        OMFactory fac=OMAbstractFactory.getOMFactory();
        OMNamespace omNs=fac.createOMNamespace("
http://service.util.danlley.org/xsd","ns1
");
        OMElement method=fac.createOMElement("getHelloMessage",omNs);
        OMElement value=fac.createOMElement("msg",omNs);
        value.addChild(fac.createOMText(value,msg));
        method.addChild(value);
        return method;
    }
}
运行客户端程序：
Hi]http://service.util.danlley.org/xsd">Hi[/url]
, Danlley !
You]http://service.util.danlley.org/xsd">You[/url]
are Perfect, Danlley!
END
那么一个基于ADB pattern的Web Services就实现了。








注：此文档在8月之前将一直处于维护状态

参考资料
http://ws.apache.org/axis2/1_2/index.html
http://blog.mllm.org/node/171
http://www-128.ibm.com/developerworks/cn/webservices/ws-webaxis1/#figure1


本文来自ChinaUnix博客，如果查看原文请点：http://blog.chinaunix.net/u/22374/showart_338115.html