1.axis2 简介: apache axis2 项目是一个基于 java 语言的 webservices 系统服务和客户端的实现。为了从 apache axis 1.0 中获取教训, apache axis2 提供了一个完整的对象模型和模块化体系结构,这样可以很容易的添加功能以及支持一个新的与 web services
1.axis2简介:
apache axis2项目是一个基于java语言的webservices系统服务和客户端的实现。为了从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-atomictransaction获取优势的服务。
(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发布成axis2webservice的简单例子:
(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:
rpcserviceclient client = new rpcserviceclient();options options = client.getoptions();
(2).指定调用webservice的url:
endpointreference targeturl = new endpointreference(“webservice发布的url地址”);options.setto(targeturl);
(3).指定调用服务方法的参数值:
object[] parameters = new object[]{参数值};
(4).指定方法返回值的数据类型,如:
class[] classes = new class[]{string.class};
(5).指定要调用方法名和wsdl文件的命名空间:
//命名空间为wsdl文件中元素的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 wsdl的url –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文件,添加如下内容:
发布的服务类全路径发布的服务类全路径 …… ......
注意:有返回值的处理器为: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.messagecontext和org.apache.axis2.context.servicecontext类来保存与获取保存在服务端的状态信息,类似于使用httpsession接口的getattribute和setattribute方法获得与设置session属性。
(2).此外,还需修改services.xml文件的内容,为元素添加一个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中所对应的元素添加一个scope属性,并将该属性值设置为”transportsession”。
(3).在客户端使用setmanagesession(true);打开session管理功能。
12.webservice的session管理操作代码:
(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).使用messagecontext和servicecontext获取与设置session的key-value对。
(2).为要进行session管理的webservice类在services.xml中所对应的元素添加一个scope属性,并将该属性值设置为”application”。
(3).在客户端使用setmanagesession(true);打开session管理功能。
注意:java中只有将scope设置为application才支持跨服务的会话管理功能。
14.axis2和spring的集成:
(1).为工程添加spring支持,在web.xml文件中添加spring的相关配置。
(2).在spring配置文件中配置axis2的servicebean如下:
(3).在web-inf/services/下新建一个目录,这个名字可以起的随便,我们就起做test吧,然后在web-inf/services/test/下建立meta-inf这个目录,最后在web-inf/services/test/meta-inf/下建立service.xml,文件内容是:
服务描述 org.apache.axis2.extensions.spring.receivers.springappcontextawareobjectsupplier 在spring配置文件中配置的服务id
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模块的引用,。
(6).发布axis2模块,需要使用jar命令将axis2模块打包成”.mar”后缀名包,然后将该后缀名为”.mar”的文件拷贝到axis2模块发布目录” %tomcat%/webapps/axis2/web-inf/modules”。
注意:模块和service要分开打包,将module类,handler类和module.xml打成”.mar”文件,将service类和services.xml文件打成”.aar”文件,分别发布。
