WebService学习笔记5——AXIS2基础

    技术2022-05-20  49

     

    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).建立或者使用基于RESTWeb service

    (8).建立或者使用从WS-Security, WS-ReliableMessaging, WS-Addressing, WS-CoordinationWS-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).在浏览器地址栏中输入如下的URLhttp://localhost:8080/axis2/”,应该可以进入axis2的欢迎界面,点击”Validate”如果没有报错,则说明axis2的环境已经配置好。

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

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

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

    (2).启动TomcatPOJO即被发布成了WebServicejava类中中所有的public方法即被发布成WebServiceOperation

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

    4.POJO无配置发布高级:

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

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

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

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

    (2).指定调用WebServiceURL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    注意:

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

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

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

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

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

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

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

    <serviceGroup> <!--第一种服务发布方式--> <service name=”服务名”> <parameter name=”ServiceClass”>发布的服务类全路径</parameter> <!--处理WebService的处理器--> <messageReceivers> <!--有返回值的处理器--> <messageReceiver mep=”http://www.w3.org/2004/08/wsdl/in-out” class=”org.apache.axis2.rpc.receivers.RPCMessageReceiver”/> <!--无返回值的处理器--> <messageReceiver mep=”http://www.w3.org/2004/08/wsdl/in-only” class=”org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver”/> </messageReceivers> </service> <!--第二种服务发布方式--> <service name=”服务名”> <parameter name=”ServiceClass”>发布的服务类全路径</parameter> <operation name=”服务的方法名”> <messageReceiver class=”处理WebService方法的处理器(如,RPCMessageReceiver类)”/> </operation> …… </service> ...... </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).服务端:

    private void writeInputStreamToFile(InputStream is, OutputStream os) throw Exception{ int n = 0; byte[] byffer = new byte[1024]; while((n = is.read(buffer)) > 0){ os.write(buffer, 0, n); } } public boolean uploadFileWithDataHandler(DataHandler handler, String fileName){ FileOutputStream fos = null; try{ fos = new FileOutputStream(fileName); writeInputStreamToFile(handler.getInputStream, fos); fos.close(); }catch(Exception e){ return false; }finally{ if(fos != null){ try{ fos.close(); }catch(IOException e){} } } return true; } 

    (2).客户端:

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

    10.AXIS2的状态管理:

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

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

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

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

    11.实现同一个WebServiceSession管理步骤:

    (1).使用MessageContextServiceContext获取与设置Sessionkey-value对。

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

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

    12.WebServicesession管理操作代码:

    (1).设置key-value

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

    (2).获取value

    sc.getProperty(key); 

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

    13.WebService跨服务会话管理:

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

    (1).使用MessageContextServiceContext获取与设置Sessionkey-value对。

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

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

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

    14.AXIS2Spring的集成:

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

    (2).spring配置文件中配置AXIS2ServiceBean如下:

    <bean id= "applicationContext" class = "org.apache.axis2.extensions.spring.receivers.ApplicationContextHolder"/> <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,文件内容是:

    <service name= "服务名" > <description>服务描述</description> <!--注意:不再是ServiceClass,而是有Spring提供--> <parameter name= "ServiceObjectSupplier" > org.apache.axis2.extensions.spring.receivers.SpringAppContextAwareObjectSupplier </parameter> <parameter name= "SpringBeanName" >在spring配置文件中配置的服务id</parameter> <messageReceivers> <messageReceiver mep= "http://www.w3.org/2004/08/wsdl/in-only" class = "org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" /> <messageReceiver mep= "http://www.w3.org/2004/08/wsdl/in-out" class = "org.apache.axis2.rpc.receivers.RPCMessageReceiver"/> </messageReceivers> </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模块至少需要有两个类,这两个类分别实现了ModuleHandler接口,开发和使用一个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”文件,分别发布。

     


    最新回复(0)