WebService介绍(WebService基础知识、XFire、CXF（基于XFire和Ce

1. <servlet>??
2. ???????<servlet-name>XFireServlet</servlet-name>??
3. ???????<servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>??
4. </servlet>??
5. <servlet-mapping>??
6. ???????<servlet-name>XFireServlet</servlet-name>??
7. ???????<url-pattern>/services/*</url-pattern>??
8. </servlet-mapping>??

1. <??xml?version=”1.0”?encoding=”UTF-8”??>??
2. <beans>??
3. ???????<service?xmlns=”http://xfire.codehaus.org/config/1.0”>??
4. ??????????????<name>webservice名</name>??
5. ??????????????<namespace>http://包名的逆序/服务类名</namespace>??
6. ??????????????<serviceClass>提供服务的接口全路径</serviceClass>??
7. ??????????????<implementationClass>服务实现类全路径</implementationClass>??
8. ??????????????<scope>服务存活范围</scope>??
9. ???????</service>??
10. ???????……??
11. </beans>??

1. <??xml?version=”1.0”?encoding=”UTF-8”??>??
2. <mappings>??
3. ???????<mapping>??
4. ??????????????<method?name=”接口中的方法名”>??
5. ?????????????????????<!--配置方法参数类型，索引从0开始-->??
6. ?????????????????????<parameter?index=”0”?componentType=”参数类型全路径(如：java.lang.String)”/>??
7. ?????????????????????……??
8. ?????????????????????<return-Type?componentType=”返回值类型全路径”/>??
9. ??????????????</method>??
10. ??????????????……??
11. ???????</mapping>??
12. </mappings>??

1. <inHandlers>??
2. ???????<handler?handlerClass=”自定义Handler的全路径”/>??
3. ???????……??
4. </inHandlers>??
5. <outHandlers>??
6. ???????<handler?handlerClass=”自定义Handler的全路径”/>??
7. ???????……??
8. </outHandlers>??

1. Client?client?=?Client.getInstance(客户端得到的服务对象);??
2. client.addInHandler(new?自定义Handler());??
3. client.addOutHandler(new?自定义Handler());??

1. org.codehaus.xfire.client.Client?client?=?((XFireProxy)Proxy.getInVocationHandler(服务对象)).getClient();??
2. client.setProperty(SoapConstants.MTOM_ENABLED,?“true”);??

1. InputStreamReader?input?=?new?InputStreamReader(handler.getInputSream(),?“UTF-8”);??
2. OutputStreamWriter?writer?output?=?new?OutputStreamWriter(new?FileOutputStream(file),?“UTF-8”);??

1. <properties>??
2. ???????<property?key=”mtom-enabled”>true</property>??
3. </properties>??

1. <context-param>??
2. ???????<param-name>classpath:org/codehaus/xfire/spring/xfire.xml,??
3. ????????????????????????????/WEB-INF/applicationContext.xml</param-name>??
4. </context-param>??

1. <import?resource=”classpath:org/codehaus/xfire/spring/xfire.xml”/>??
2. <bean?id=”服务id”?parent=”baseWebService”>??
3. ???????<property?name=”name”?value=”服务名”/>??
4. ???????<property?name=”serviceClass”?value=”服务接口全路径”/>??
5. ???????<property?name=”serviceBean”?value=”服务实现类”/>??
6. </bean>??

1. <bean?id=”?baseWebService”?class=”org.codehaus.xfire.spring.remoting.XFireExporter”?lazy-init=”false”?abstract=”true”>??
2. ???????<property?name=”serviceFactory”?ref=”xfire?serviceFactory”/>??
3. ???????<property?name=”xfire”?ref=”xfire”/>??
4. </bean>??

1. <bean?id=”客户端服务名”?class=”org.codehaus.xfire.spring.remoting.XFireClientFactoryBean”>??
2. ???????<property?name=”serviceClass”?value=”服务接口全路径”/>??
3. ???????<property?name=”wsdlDocument”?value=”服务的WSDL地址”/>??
4. </bean>??

1. <bean?id=”服务id”?class=”服务名”>??
2. ???????<property?name=”name”?value=”服务名”/>??
3. ???????<property?name=”namespace”?value=”服务命名空间”/>??
4. ???????<property?name=”serviceClass”?value=”服务接口全路径”/>??
5. ???????<property?name=”serviceBean”?value/ref=”服务实现类”/>??
6. </bean>?
   

1. package?service;??
2. import?javax.jws.WebService;??
3. @WebService??
4. public?interface?OrderProcess?{??
5. ????String?processOrder(Order?order);??
6. }??

1. package?service;??
2. import?javax.jws.WebService;??
3. @WebService(endpointInterface?=?"service.OrderProcess"，serviceName=”order”)??
4. public?class?OrderProcessImpl?implements?OrderProcess?{??
5. ????public?String?processOrder(Order?order)?{??
6. ????????return?"hello?world"+order;??
7. ????}??
8. }??

1. //创建web服务工厂??
2. JaxWsServerFactoryBean?factory?=?new?JaxWsServerFactoryBean();??
3. //设置服务类??
4. factory.setServiceClass(服务接口实现类.class);??
5. //设置对外发布服务地址??
6. factory.setAddress(对外发布的服务地址);??
7. //创建服务??
8. Server?server?=?factory.create();??
9. //启动服务??
10. server.start();??

1. //创建web服务代理工厂??
2. JaxWsProxyFactoryBean?factory?=?new?JaxWsProxyFactoryBean();??
3. //设置要调用的web服务服务端发布地址??
4. factory.setAddress(web服务的发布地址);??
5. //设置要调用的web服务??
6. factory.setServiceClass(web服务接口.class);??
7. //创建web服务对象??
8. 服务接口?对象?=?(服务接口)?factory.create();??
9. 通过对象调用web服务的方法

6.CXF使用POJO开发服务端：??

1. 和使用JAX-WS开发方式前两步完全一样，第三步稍有不同如下：??
2. //创建web服务工厂??
3. ServiceFactoryBean?svrFactory?=?new?ServiceFactoryBean();??
4. //设置服务类??
5. svrFactory.setServiceClass(服务接口实现类.class);??
6. //设置对外发布服务地址??
7. svrFactory.setAddress(对外发布的服务地址);??
8. //创建服务??
9. Server?server?=?svrFactory.create();??
10. //启动服务??
11. server.start();??

1. //创建web服务代理工厂??
2. ClientProxyFactoryBean?factory?=?new?ClientProxyFactoryBean();??
3. //设置要调用的web服务服务端发布地址??
4. factory.setAddress(web服务的发布地址);??
5. //设置要调用的web服务??
6. factory.setServiceClass(web服务接口.class);??
7. //创建web服务对象??
8. 服务接口?对象?=?(服务接口)?factory.create();??

1. <web-app>??
2. ??<context-param>??
3. ??<param-name>contextConfigLocation</param-name>??
4. ??<param-value>spring配置文件路径</param-value>??
5. ?</context-param>??
6. ?<listener>??
7. ??<listener-class>??
8. ???org.springframework.web.context.ContextLoaderListener??
9. ??</listener-class>??
10. ?</listener>??
11. ?<servlet>??
12. ??<servlet-name>CXFServlet</servlet-name>??
13. ??<display-name>CXF?Servlet</display-name>??
14. ??<servlet-class>??
15. ???org.apache.cxf.transport.servlet.CXFServlet??
16. ??</servlet-class>??
17. ??<load-on-startup>1</load-on-startup>??
18. ?</servlet>??
19. ?<servlet-mapping>??
20. ??<servlet-name>CXFServlet</servlet-name>??
21. ??<url-pattern>/service/*</url-pattern>??
22. ?</servlet-mapping>??
23. </web-app>??

1. <import?resource="classpath:META-INF/cxf/cxf.xml"?/>??
2. <import?resource="classpath:META-INF/cxf/cxf-extension-soap.xml"?/>??
3. <import?resource="classpath:META-INF/cxf/cxf-servlet.xml"?/>??

1. <jaxws:endpoint??
2. ???id="……"??
3. ???implementor="服务接口实现类全路径"??
4. ???address="/web服务发布地址(相对地址)"?/>?
   

4 AXIS1基础(Axis 1.4 Final 2006年后停止开发,转而AXIS2)

1.AXIS简介：

Axis1是Apache组织推出的SOAP引擎，Axis项目是Apache组织著名的SOAP项目的后继项目，目前最新版本是采用Java开发的1.4版本，C++的1.5版本。
但是Axis1不仅仅是一个SOAP引擎，它还包括：

(1).?一个独立运行的SOAP服务器。
(2).一个servlet引擎的插件，这个servlet引擎可以是Tomcat。
(3).对WSDL的扩展支持。

(4).一个将WSDL的描述生成JAVA类的工具。
(5).一些示例代码。
(6).还有一个监控TCP/IP包的工具。

2.Axis1安装配置：

(1)、环境 J2SE SDK,Servlet 容器，如Tomcat 6.0。

(2)、到 http://ws.apache.org/Axis/网站下载Axis安装包。
(3)、解压缩安装包，将Axis_UNZIP_PATH/Axis-version/webapps下的Axis包拷贝到TOMCAT_HOME/webapps目录下，以下约定Axis_HOME为该TOMCAT_HOME/webapps/Axis目录。

(4)、启动tomcat,访问http://localhost:8080/Axis 检查安装是否成功。

(5)、以上步骤执行成功，可以开发webservice例子了。

3.AXIS的发布方式：

AXIS提供了两种Webservice的发布方式：

及时发布(InstantDeployment)。

定制发布(CustomDeployment)。

4.AXIS的及时发布方式——java web service（jws）：

(1).对即时发布的支持是Axis的特色之一，使用即时发布只需将提供服务的Java类的源代码后缀改为”.jws”，然后将该jws文件放到”%Tomcat_HOME%/webapps/axis”目录下，即可将其迅速发布成Web服务。每当用户调用这类服务的时候，Axis会自动进行编译，即使服务器重启了也不必对其做任何处理，使用非常简单快捷。

(2).需要注意的是：JWS的web服务发布是一个很简单的Web服务发布方式，在页面中你不能使用包，而且由于代码是在运行期被编译的，所以在部署之后，你也很难找到错误所在。

5.AXIS定制发布方式——wsdd方式：

(1).即时发布是一项令人激动的技术，它使Web服务的开发变得如此简单；然而即时发布并不总是最好的选择，比如有些应用系统是第三方提供的，我们没有购买源代码，只有.class文件，但我们又希望将这个应用系统的一些功能对外发布成Web服务，使其能够在更大范围内产生作用，这个时候即时发布技术就无能为力了。此外，即时发布技术并不灵活，无法进行更多的服务配置，这使得它并不能满足一些特定系统的需求。

(2).将java源代码编译成.class文件，放置到“%Tomcat_HOME%/webapps/axis/”目录下，即可着手进行发布。定制发布不需要构建.jws文件，但必须在” %Tomcat_HOME%/webapps/axis/WEB-INF/”目录下创建服务发布描述文件deploy.wsdd（Web Service Deployment Descriptor的缩写），这个文件负责描述服务的名称、入口等信息，其内容如下：

?

(3).部署定制服务：

使用Axis提供的一个客户端管理工具——AdminClient来完成服务的定制发布。
???在“%Tomcat_HOME%/webapps/axis/”目录下，运行：

?? java -cp %AXISCLASSPATH%org.apache.axis.client.AdminClient deploy.wsdd

或

java -cp %AXISCLASSPATH%org.apache.axis.client.AdminClient -l http://localhost:8081/WebServiceTest/services/WebServiceServer.WSServerdeploy.wsdd

如果运行时说没有找到类，那么可能是类路径没有配置好，建议将所有的与axis相关的jar都写到classpath中去。这样只要运行:

?? javaorg.apache.axis.client.AdminClient deploy.wsdd
???可以看到以下运行结果：

?Processing file deploy.wsdd
?<Admin>Doneprocessing</Admin>

　　这表明服务定制发布完成。
?
???你也可以调用：
?java org.apache.axis.client.AdminClient undeploy.wsdd??来取消部署。

???你也可以调用：
?java org.apache.axis.client.AdminClient list?来获得所有的已经部署的服务的列表。在这里你会看到services,handlers,transports等等，注意这个调用只是列出了WEB-INF/server-config.wsdd的文件内容。

(4).注意：编译后的class文件要拷贝到WEB-INF/classes的目录中，如果该文件中有包存在的话，别忘了还要在classes目录下创建包的目录
???通过访问http://localhost:8080/axis/services/工程名称?wsdl可以看到这个服务的WSDL描述文件，这说明服务被成功发布了。

6.客户端调用AXIS发布的服务：

?

7. AXIS支持三种对象范围：
(1).request范围：这是默认的情况，每一次Soap请求的时候都将创建新的对象。
(2).application范围：将会为所有的请求生成一个单独的共享的对象。
(3).session范围：为每一个session期的客户端请求创建一个对象。
??指定方法如下：

?8.?AXIS的Handler和Handlers Chain：

?Webservice的Handler可以在Webservice每个方法调用之前或之后做一些特定事情，如权限验证，记录日志等等常用操作。

(1).定义Handler：

自定义的Handler必须要继承BasicHandler类，并实现其中的invoke(MessageContextcontext)方法，其中MessageContext参数是AXIS上下文。

Handler通过getOperation(String string)方法获得配置文件的属性值，通过<requestFlow>标签来讲Handler引入到某个Service中。

(2).配置Handler：

在wsdd文件中加入如下配置：

?

(3).为WebService引入Handler：

在wsdd文件的<service>中加入如下配置：

?

(4).Hanlder Chain：

a.定义Handler Chain：

Handler Chain是实现一连串多个Handler的链，Chain必须继承SimpleChain类，然后在构造方法中使用：this.addHandler(handler对象);将Handler加入到Chain中。

b.配置Handler Chain：

在wsdd文件中，Chain的配置和Handler有些不同，<chain>元素中的子元素只允许是<handler>或者<chain>，即允许<chain>嵌套，具体配置如下：

?

9.WebService传递复杂对象：

(1).创建Qname：

?

(2).注册对象类型映射：

如：

?

(3).返回值类型设置：

如：

?

(4).设置传递的方法参数类型：

如：

?

(5).在wsdd文件中加上类型映射：

在<service>标签中加入如下配置：

?

10.WebService传递带有内部类的复杂对象：

(1).内部类必须是可序列化的，内部类必须是静态的，否则不能被序列化。

(2).内部类也要像自定义类一样进行映射和注册，如：

?

(3).在wsdd文件中配置内部类的相关映射：

如：

?

11.Webservice的RMI调用方式：

本地实现一个Remote接口，其中包含远程webservice的调用方法(同名、同返回类型、同参数类型)，则通过service可以获得一个对远程webservice对象的引用，用该引用可以直接像调用本地方法一样调用远程方法。

(1).服务器端不用继承或者实现任何接口。

(2).通过如下方法使本地的远程接口获取webservice引用：

?

12.WebService传递异常对象：

(1).自定义异常。

(2).方法中抛出该异常对象。

(3).在wsdd文件中加入如下配置：

在<service>元素的<operation>标签中加入<fault>子标签如下：

?

13.WebService传递文件：

(1).服务器端方法：

?

注意：DataHandler是一个专门的传送器，通过它可以把文件进行序列化。

(2).wsdd文件进行如下配置：

?

(3).客户端传递DataHandler对象：

?

文件路径名的获取一般写法如：

5 AXIS2基础(有AXIS1转换而来，有Java和C版)

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：

?

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

?

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

?

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

?

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

?

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

?

注意：当方法没有参数时，第二个参数值不能为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).在定义数组类型时只能使用一维数组，如果想传递多维数组，可以使用分隔符进行分割，如：

?

可以将该数组看作是一个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).服务端：

?

(2).客户端：

?

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：

?

(2).获取value：

?

(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如下：

?

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

?

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模块的引用，<moduleref=”模块名”/>。

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

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