WebService学习笔记5——AXIS2基础

转载自

1.AXIS2简介：

Apache Axis2项目是一个基于Java语言的Web services系统服务和客户端的实现。为了从Apache Axis 1.0中获取教训，Apache Axis2提供了一个完整的对象模型和模块化体系结构，这样可以很容易的添加功能以及支持一个新的与Web services相关的说明和建议。Axis2可以让你很容易的执行以下任务：

(1).发送SOAP消息。

(2).接收和处理SOAP消息。

(3).从一个普通的Java类建立Web service。

(4).用WSDL来建立实现服务和客户端的实现类。

(5).很容易的从一个服务来获取WSDL。

(6).发送和接收带有附件的SOAP消息。

(7).建立或者使用基于REST的Web service。

(8).建立或者使用从WS-Security, WS-ReliableMessaging, WS-Addressing, WS-Coordination和WS-Atomic Transaction获取优势的服务。

(9).当新建议出现时，使用Axis2的模块化结构来很容易的加入对它的支持。

2.配置AXIS2环境：

(1).下载Axis2，去http://ws.apache.org/axis2/下载axis2的最新版本，一般是两个zip文件，如axis2-1.4.1-bin.zip(包含了Axis2中所有的jar文件)和axis2-1.4.1-war.zip(用于将WebService发布到web容器中)。
(2). 把axis2-1.4.1-war.zip解压，将目录中的axis2.war文件放到Servlet容器的项目发布目录中，以Tomcat为例，放到”%Tomcat%/webapps”目录中，启动Tomcat。

(3).在浏览器地址栏中输入如下的URL：http://localhost:8080/axis2/”，应该可以进入axis2的欢迎界面，点击”Validate”如果没有报错，则说明axis2的环境已经配置好。

(4).点击”Administration”，初始用户名和密码分别是：admin和axis2，也可以到” %Tomcat%/webapps/axis2/WEB-INF/conf/axis2.xml”下修改用户名和密码。

3.POJO发布成AXIS2 WebService的简单例子：

(1).编程普通的java类，将编译过后的”.class”文件拷贝到axis2的POJO发布目录”%Tomcat%/webapps/axis2/WEB-INF/POJO”中。
注意：若目录下没有POJO目录，则手动新建该目录即可。

(2).启动Tomcat，POJO即被发布成了WebService，java类中中所有的public方法即被发布成WebService的Operation。

注意：POJO类不能使用package关键字声明包，AXIS2默认是热部署的。

4.POJO无配置发布高级：

由于AXIS2的POJO发布方式不支持Package，若类中需要调用其他类的方法时，需要将所引用的类编译后的”.class”文件拷贝到”%Tomcat%/webapps/axis2/WEB-INF/classes”目录下。

5.AXIS2客户端的简单实现：

(1).使用RPC方式调用WebService：

[java]  view plain copy

1. RPCServiceClient client = new RPCServiceClient();  
2. Options options = client.getOptions();  

 

(2).指定调用WebService的URL：

[java]  view plain copy

1. EndpointReference targetURL = new EndpointReference(“WebService发布的URL地址”);  
2. Options.setTo(targetURL);  

 

(3).指定调用服务方法的参数值：

[java]  view plain copy

1. Object[] parameters = new Object[]{参数值};  

 

(4).指定方法返回值的数据类型，如：

[java]  view plain copy

1. Class[] classes = new Class[]{String.class};  

 

(5).指定要调用方法名和WSDL文件的命名空间：

[java]  view plain copy

1. //命名空间为wsdl文件中<wsdl:definitions>元素的targetNamespace属性值  
2. QName qname = new QName(“命名空间”, “调用方法名”);  

 

(6).调用服务的方法：

[java]  view plain copy

1. //三个参数第一个为QName对象，表示要调用的方法名；第二个参数表示要调用的//WebService方法的参数值；第三个参数表示WebService方法的返回值类型  
2. Object result = client.invokeBlocking(qname, parameters, classes)[0];  

 

注意：当方法没有参数时，第二个参数值不能为null，而要使用new Object[]{}。

当被调用的方法没有返回值时，应该使用RPCServiceClient类的invokeRobust方法。

6.使用wsdl2java简化客户端的编写：

在Windows控制台输出如下的命令行来生成调用WebService的代码：

%AXIS2_HOME%/bin/wsdl2java –uri wsdl的url –p 生成java类的包名 -s –o 客户端存根目录名

其中-url参数指定wsdl文件的路径，可以说本地路径，也可以是网络路径。-p参数指定了生成的java类的包名，-o参数指定了生成的一系列文件保存的根目录。执行完命令后就会在当前目录下生成一个存根目录名的目录，里面就是wsdl2java生成的客户端代码。

7.AXIS2复合类型数据的传递：

AXIS2中可以直接使用将WebService方法的参数或返回值类型声明为数组或者类(接口)。

注意：

(1).在定义数组类型时只能使用一维数组，如果想传递多维数组，可以使用分隔符进行分割，如：

[java]  view plain copy

1. String[] strArray = new String[]{“自行车, 飞机, 火箭”, “中国, 美国, 德国”, “超人, 蜘蛛侠, 钢铁侠”};  

 

可以将该数组看作是一个3×3的二维数组。

(2).当传递自定义的类或接口时，请务必实现序列化。

8.使用services.xml方式发布WebService：

(1).编写服务端的类。

(2).在工程META-INF目录下建services.xml文件，添加如下内容：

[xhtml]  view plain copy

1. <serviceGroup>  
2.        <!--第一种服务发布方式-->  
3.        <service name=”服务名”>  
4.               <parameter name=”ServiceClass”>发布的服务类全路径</parameter>  
5.               <!--处理WebService的处理器-->  
6.               <messageReceivers>  
7.                      <!--有返回值的处理器-->  
8.                      <messageReceiver mep=”http://www.w3.org/2004/08/wsdl/in-out”  
9.                         class=”org.apache.axis2.rpc.receivers.RPCMessageReceiver”/>  
10.              <!--无返回值的处理器-->  
11.              <messageReceiver mep=”http://www.w3.org/2004/08/wsdl/in-only”  
12.                         class=”org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver”/>  
13.         </messageReceivers>  
14.     </service>  
15.     <!--第二种服务发布方式-->  
16.     <service name=”服务名”>  
17.         <parameter name=”ServiceClass”>发布的服务类全路径</parameter>  
18.         <operation name=”服务的方法名”>  
19.             <messageReceiver class=”处理WebService方法的处理器(如，RPCMessageReceiver类)”/>  
20.         </operation>  
21.         ……  
22.     </service>  
23.     ......  
24. </serviceGroup>  

 

注意：有返回值的处理器为：org.apache.axis2.rpc.receivers.RPCMessageReceiver。

无返回值的处理器为：org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver。

(3).将META-INF(包含services.xml)和编译好的类使用jar工具命令打包成”.aar”后缀名的文件。

(4).将打包的”.aar”文件发布到axis2的发布目录：”%Tomcat%/webapps/axis2/WEB-INF/Services”。

注意：此种方法允许使用package。

9.AXIS2使用DataHandler传输二进制文件：

(1).服务端：

[java]  view plain copy

1. private void writeInputStreamToFile(InputStream is, OutputStream os) throw Exception{  
2.        int n = 0;  
3.        byte[] byffer = new byte[1024];  
4.        while((n = is.read(buffer)) > 0){  
5.               os.write(buffer, 0, n);  
6. }  
7. }  
8.    
9. public boolean uploadFileWithDataHandler(DataHandler handler, String fileName){  
10.        FileOutputStream fos = null;  
11.        try{  
12.               fos = new FileOutputStream(fileName);  
13.               writeInputStreamToFile(handler.getInputStream, fos);  
14.               fos.close();  
15. }catch(Exception e){  
16.        return false;  
17. }finally{  
18.        if(fos != null){  
19.               try{  
20.        fos.close();  
21. }catch(IOException e){}  
22. }  
23. }  
24.        return true;  
25. }  

 

(2).客户端：

[java]  view plain copy

1. File file = new File(文件路径);  
2. DataHandler dh = new DataHandler(new FileDataSource(file));  
3. Object[] parameters = new Object[]{dh, “文件名”};  
4. QName qname = new QName(“targetNamespace”, “服务端方法名(如：uploadFileWithDataHandler)”);  
5. Class[] classes = new Class[]{Boolean.class};  
6. boolean result = Service.invokeBlocking(qname, parameters, classes)[0];  

 

10.AXIS2的状态管理：

(1).AXIS2管理WebService的状态基本上对开发人员是透明的，在WebService类需要使用org.apache,axis2.context.MessageContext和org.apache.axis2.context.ServiceContext类来保存与获取保存在服务端的状态信息，类似于使用HTTPSession接口的getAttribute和setAttribute方法获得与设置Session属性。

(2).此外，还需修改services.xml文件的内容，为<service>元素添加一个scope属性，该属性有4个可取的值：application、soapsession、transportsession和request(全部小写，request是默认值)。

其中transportsession和application分别实现同一个WebService类和跨WebService类的会话管理。

(3).在客户端需要使用setManageSession(true);打开session管理功能。

11.实现同一个WebService的Session管理步骤：

(1).使用MessageContext和ServiceContext获取与设置Session的key-value对。

(2).为要进行session管理的WebService类在services.xml中所对应的<service>元素添加一个scope属性，并将该属性值设置为”transportsession”。

(3).在客户端使用setManageSession(true);打开Session管理功能。

12.WebService的session管理操作代码：

(1).设置key-value：

[java]  view plain copy

1. MessageContext mc = MessageContext.getCurrentMessageContext();  
2. ServiceContext sc = mc.getServiceContext();  
3. sc.setProperty(key, value);  

 

(2).获取value：

[java]  view plain copy

1. sc.getProperty(key);  

 

(3).若用stub生成方式(进入axis2安装目录使用wsdl2java –uri wsdlURL –p 包名 –s –o 存放目录名)，则需要添加”-serviceClient.getOptions().setManageSession(true);”。

13.WebService跨服务会话管理：

在多个WebService服务之间共享会话状态，也称为跨服务会话管理，实现跨服务会话管理与实现同一个服务的会话管理类似，步骤如下：

(1).使用MessageContext和ServiceContext获取与设置Session的key-value对。

(2).为要进行session管理的WebService类在services.xml中所对应的<service>元素添加一个scope属性，并将该属性值设置为”application”。

(3).在客户端使用setManageSession(true);打开Session管理功能。

注意：java中只有将scope设置为application才支持跨服务的会话管理功能。

14.AXIS2和Spring的集成：

(1).为工程添加Spring支持，在web.xml文件中添加spring的相关配置。

(2).在spring配置文件中配置AXIS2的ServiceBean如下：

[xhtml]  view plain copy

1. <bean id= "applicationContext"  
2.     class = "org.apache.axis2.extensions.spring.receivers.ApplicationContextHolder"/>  
3. <bean id= "服务id"   class = "Web服务类的全路径" ></bean>  

 

(3).在WEB-INF/services/下新建一个目录，这个名字可以起的随便，我们就起做test吧，然后在WEB-INF/services/test/下建立META-INF这个目录，最后在WEB-INF/services/test/META-INF/下建立service.xml,文件内容是：

[xhtml]  view plain copy

1. <service name= "服务名" >  
2.        <description>服务描述</description>  
3.     <!--注意：不再是ServiceClass，而是有Spring提供-->  
4.     <parameter name= "ServiceObjectSupplier" >  
5.         org.apache.axis2.extensions.spring.receivers.SpringAppContextAwareObjectSupplier  
6.     </parameter>  
7.     <parameter name= "SpringBeanName" >在spring配置文件中配置的服务id</parameter>  
8.     <messageReceivers>  
9.         <messageReceiver mep= "http://www.w3.org/2004/08/wsdl/in-only"  
10.                         class = "org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />  
11.               <messageReceiver mep= "http://www.w3.org/2004/08/wsdl/in-out"  
12.                         class = "org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>  
13.        </messageReceivers>  
14. </service>  

 

15.AXIS2的异步调用WebService：

同步调用时，如果被调用的WebService方法长时间没有返回，则客户端将一直处于阻塞状态，知道方法返回为止。为了避免长时间被阻塞，需要使用异步调用。AXIS2异步调用有两种方法：

(1).多线程。

(2).RPCServiceClient类提供了一个invokeNoBlocking()方法实现对WebService的异步调用。具体用法如下：

serviceClient.invokeNoBlocking(qname, parameters, 一个实现了AXISCallback接口的实例对象);

实现AXISCallback接口需要实现其如下4个方法，实现异步回调：

onComplete()，onError(Exception e)，onFault(MessageContext mc)，onMessage(MessageContext mc)。

注意：当使用wsdl2java生成客户端调用stub时，会自动生成”服务名+CallbackHandler”的抽象回调类。

16.AXIS2的模块：

AXIS2可以通过模块(Module)进行扩展，AXIS2模块至少需要有两个类，这两个类分别实现了Module和Handler接口，开发和使用一个AXIS2的模板步骤如下：

(1).编写实现了Module接口的类，AXIS2模块在进行初始化、销毁等动作时会自动调用该类中的相应方法。

(2).编写实现了Handler接口的类，该类是AXIS2模块的业务处理类。

(3).编写module.xml文件，该文件放在工程的META-INF目录下，用于配置模块。

(4).在axis2.xml文件中配置AXIS2模块。

(5).在services.xml文件中配置AXIS2模块的引用，<module ref=”模块名”/>。

(6).发布AXIS2模块，需要使用jar命令将AXIS2模块打包成”.mar”后缀名包，然后将该后缀名为”.mar”的文件拷贝到AXIS2模块发布目录”%Tomcat%/webapps/axis2/WEB-INF/modules”。

注意：模块和Service要分开打包，将module类，handler类和module.xml打成”.mar”文件，将service类和services.xml文件打成”.aar”文件，分别发布。