Spring 3 整合Apache CXF WebService
在CXF2版本中，整合Spring3发布CXF WebService就更加简单了。因为Spring 3提供了annotation注解，而CXF2发布WebService已经不像之前版本的配置那样（参考老版本发布WebService系列文章：http://www.cnblogs.com/hoojo/archive/2011/03/30/1999563.html），现在发布一个WebService可以直接从Spring的IoC容器中拿到一个对象，发布成WebService服务。当然发布WebService的配置有了些小小的变动，具体请往下看。
在老版本中发布一个WebService，配置applicationContext-server.xml文件中添加如下配置如下：
jaxws:server的发布方式
<bean id="userServiceBean" class="com.hoo.service.ComplexUserService"/>
<bean id="inMessageInterceptor" class="com.hoo.interceptor.MessageInterceptor">
<constructor-arg value="receive"/>
</bean>
<bean id="outLoggingInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
<!-- 注意下面的address，这里的address的名称就是访问的WebService的name -->
<jaxws:server id="userService" serviceClass="com.hoo.service.IComplexUserService" address="/Users">
<jaxws:serviceBean>
<!-- 要暴露的 bean 的引用 -->
<ref bean="userServiceBean"/>
</jaxws:serviceBean>
<jaxws:inInterceptors>
<ref bean="inMessageInterceptor"/>
</jaxws:inInterceptors>
<jaxws:outInterceptors>
<ref bean="outLoggingInterceptor"/>
</jaxws:outInterceptors>
</jaxws:server>
jaxws:endpoint的发布方式
<!-- com.hoo.service.ComplexUserService是com.hoo.service.IComplexUserService接口的实现， 这种方法应该不能从Ioc中引用对象 -->
<jaxws:endpoint id="userService2" implementor="com.hoo.service.ComplexUserService" address="/Users">
<jaxws:inInterceptors>
<ref bean="inMessageInterceptor"/>
</jaxws:inInterceptors>
<jaxws:outInterceptors>
<ref bean="outLoggingInterceptor"/>
</jaxws:outInterceptors>
</jaxws:endpoint>
而在2.x新版本中，发布Ioc容器中的对象为一个WebService的方法
<bean id="userServiceBean" class="com.hoo.service.ComplexUserService"/>
<bean id="inMessageInterceptor" class="com.hoo.interceptor.MessageInterceptor">
<constructor-arg value="receive"/>
</bean>
<bean id="outLoggingInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
<!-- 注意下面的address，这里的address的名称就是访问的WebService的name；#userServiceBean是直接引用Ioc容器中的Bean对象 -->
<jaxws:server id="userService" serviceBean="#userServiceBean" address="/Users">
<jaxws:inInterceptors>
<ref bean="inMessageInterceptor"/>
</jaxws:inInterceptors>
<jaxws:outInterceptors>
<ref bean="outLoggingInterceptor"/>
</jaxws:outInterceptors>
</jaxws:server>
<!-- 或者这种方式，在老版本中这个是不能引用Ioc容器中的对象，但在2.x中可以直接用#id或#name的方式发布服务 -->
<jaxws:endpoint id="userService2" implementor="#userServiceBean" address="/Users">
<jaxws:inInterceptors>
<ref bean="inMessageInterceptor"/>
</jaxws:inInterceptors>
<jaxws:outInterceptors>
<ref bean="outLoggingInterceptor"/>
</jaxws:outInterceptors>
</jaxws:endpoint>
五、CXF WebService整合Spring
首先，CXF和spring整合需要准备如下jar包文件：
这边我是用Spring的jar包是Spring官方提供的，并没有使用CXF中的Spring的jar文件。
添加这么多文件后，首先在web.xml中添加如下配置：
<!-- 加载Spring容器配置 --><listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener><!-- 设置Spring容器加载配置文件路径 --><context-param><param-name>contextConfigLocation</param-name><param-value>classpath*:applicationContext-server.xml</param-value></context-param><listener><listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class></listener><servlet><servlet-name>CXFService</servlet-name><servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class></servlet><servlet-mapping><servlet-name>CXFService</servlet-name><url-pattern>/*</url-pattern></servlet-mapping>然后在src目录中，新建一个applicationContext-server.xml文件，文件内容如下：
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:jaxws="http://cxf.apache.org/jaxws"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans >http://www.springframework.org/schema/beans/spring-beans-3.0.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.0.xsdhttp://cxf.apache.org/jaxwshttp://cxf.apache.org/schemas/jaxws.xsd"注意上面的带下划线加粗部分，这个很重要的哦！不能写错或是遗漏了。
添加完这个文件后，还需要在这个文件中导入这么几个文件。文件内容如下：
<import resource="classpath:META-INF/cxf/cxf.xml"/><import resource="classpath:META-INF/cxf/cxf-extension-soap.xml"/><import resource="classpath:META-INF/cxf/cxf-servlet.xml"/>下面开始写服务器端代码，首先定制服务器端的接口，代码如下：
package com.hoo.service;import javax.jws.WebParam;import javax.jws.WebService;import javax.jws.soap.SOAPBinding;import javax.jws.soap.SOAPBinding.Style;import com.hoo.entity.User;import com.hoo.entity.Users;/*** <b>function:</b>定制客户端请求WebService所需要的接口* @author hoojo* @createDate 2011-3-18 上午08:22:55* @file ComplexUserService.java* @package com.hoo.service* @project CXFWebService* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@WebService@SOAPBinding(style = Style.RPC)public interface IComplexUserService {public User getUserByName(@WebParam(name = "name") String name);public void setUser(User user);}下面编写WebService的实现类，服务器端实现代码如下：
package com.hoo.service;import java.util.ArrayList;import java.util.Date;import java.util.HashMap;import java.util.List;import javax.jws.WebParam;import javax.jws.WebService;import javax.jws.soap.SOAPBinding;import javax.jws.soap.SOAPBinding.Style;import com.hoo.entity.User;import com.hoo.entity.Users;/*** <b>function:</b> WebService传递复杂对象，如JavaBean、Array、List、Map等* @author hoojo* @createDate 2011-3-18 上午08:22:55* @file ComplexUserService.java* @package com.hoo.service* @project CXFWebService* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@WebService@SOAPBinding(style = Style.RPC)@SuppressWarnings("deprecation")public class ComplexUserService implements IComplexUserService {public User getUserByName(@WebParam(name = "name") String name) {User user = new User();user.setId(new Date().getSeconds());user.setName(name);user.setAddress("china");user.setEmail(name + "@hoo.com");return user;}public void setUser(User user) {System.out.println("############Server setUser###########");System.out.println("setUser:" + user);}}注意的是和Spring集成，这里一定要完成接口实现，如果没有接口的话会有错误的。
下面要在applicationContext-server.xml文件中添加如下配置：
<bean id="userServiceBean" class="com.hoo.service.ComplexUserService"/><bean id="inMessageInterceptor" class="com.hoo.interceptor.MessageInterceptor"><constructor-arg value="receive"/></bean><bean id="outLoggingInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/><!-- 注意下面的address，这里的address的名称就是访问的WebService的name --><jaxws:server id="userService" serviceClass="com.hoo.service.IComplexUserService" address="/Users"><jaxws:serviceBean><!-- 要暴露的 bean 的引用 --><ref bean="userServiceBean"/></jaxws:serviceBean><jaxws:inInterceptors><ref bean="inMessageInterceptor"/></jaxws:inInterceptors><jaxws:outInterceptors><ref bean="outLoggingInterceptor"/></jaxws:outInterceptors></jaxws:server>下面启动tomcat服务器后，在WebBrowser中请求：
http://localhost:8080/CXFWebService/Users?wsdl
如果你能看到wsdl的xml文件的内容，就说明你成功了，注意的是上面地址的Users就是上面xml配置中的address的名称，是一一对应的。
下面编写客户端请求的代码，代码如下：
package com.hoo.client;import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;import com.hoo.entity.User;import com.hoo.service.IComplexUserService;/*** <b>function:</b>请求Spring整合CXF的WebService客户端* @author hoojo* @createDate 2011-3-28 下午03:20:35* @file SpringUsersWsClient.java* @package com.hoo.client* @project CXFWebService* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/public class SpringUsersWsClient {public static void main(String[] args) {//调用WebServiceJaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();factory.setServiceClass(IComplexUserService.class);factory.setAddress("http://localhost:8080/CXFWebService/Users");IComplexUserService service = (IComplexUserService) factory.create();System.out.println("#############Client getUserByName##############");User user = service.getUserByName("hoojo");System.out.println(user);user.setAddress("China-Guangzhou");service.setUser(user);}}运行后，可以在控制台中看到
log4j:WARN No appenders could be found for logger (org.apache.cxf.bus.spring.BusApplicationContext). log4j:WARN Please initialize the log4j system properly. log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info. 2011-3-28 18:12:26 org.apache.cxf.service.factory.ReflectionServiceFactoryBean buildServiceFromClass 信息: Creating Service {http://service.hoo.com/}IComplexUserServiceService from class com.hoo.service.IComplexUserService #############Client getUserByName############## 27#hoojo#hoojo@hoo.com#china Tomcat控制台
这个server端是通过Spring整合配置的，下面我们将Client端也通过Spring配置完成整合。
首先增加applicationContext-client.xml配置文件，文件内容如下：
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:jaxws="http://cxf.apache.org/jaxws"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans >http://www.springframework.org/schema/beans/spring-beans-3.0.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.0.xsdhttp://cxf.apache.org/jaxwshttp://cxf.apache.org/schemas/jaxws.xsd"<import resource="classpath:META-INF/cxf/cxf.xml"/><import resource="classpath:META-INF/cxf/cxf-extension-soap.xml"/><import resource="classpath:META-INF/cxf/cxf-servlet.xml"/><jaxws:client id="userWsClient" serviceClass="com.hoo.service.IComplexUserService"address="http://localhost:8080/CXFWebService/Users"/></beans>客户端请求代码如下：
package com.hoo.client;import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;import org.springframework.context.ApplicationContext;import org.springframework.context.support.ClassPathXmlApplicationContext;import com.hoo.entity.User;import com.hoo.service.IComplexUserService;/*** <b>function:</b>请求Spring整合CXF的WebService客户端* @author hoojo* @createDate 2011-3-28 下午03:20:35* @file SpringUsersWsClient.java* @package com.hoo.client* @project CXFWebService* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/public class SpringUsersWsClient {public static void main(String[] args) {ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-client.xml");IComplexUserService service = ctx.getBean("userWsClient", IComplexUserService.class);System.out.println("#############Client getUserByName##############");User user = service.getUserByName("hoojo");System.out.println(user);user.setAddress("China-Guangzhou");service.setUser(user);}}运行后结果如下：
#############Client getUserByName############## 45#hoojo#hoojo@hoo.com#china ############Server setUser########### setUser:45#hoojo#hoojo@hoo.com#China-GuangzhouSpring REST
前面介绍过Spring的MVC结合不同的view显示不同的数据，如：结合json的view显示json、结合xml的view显示xml文档。那么这些数据除了在WebBrowser中用JavaScript来调用以外，还可以用远程服务器的Java程序、C#程序来调用。也就是说现在的程序不仅在BS中能调用，在CS中同样也能调用，不过你需要借助RestTemplate这个类来完成。RestTemplate有点类似于一个WebService客户端请求的模版，可以调用http请求的WebService，并将结果转换成相应的对象类型。至少你可以这样理解！
上一次博文介绍SpringMVC结合不同的View，显示不同的数据。http://www.cnblogs.com/hoojo/archive/2011/04/29/2032571.html
Email：hoojo_@126.com
Blog：http://blog.csdn.net/IBM_hoojo
一、准备工作
1、 下载jar包
spring各版本jar下载地址：http://ebr.springsource.com/repository/app/library/detail?name=org.springframework.spring
相关的依赖包也可以在这里找到：http://ebr.springsource.com/repository/app/library
2、 需要jar包如下
3、 当前工程的web.xml配置
<?xml version="1.0" encoding="UTF-8"?><web-app version="2.4"xmlns="http://java.sun.com/xml/ns/j2ee"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://java.sun.com/xml/ns/j2eehttp://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"><!-- 配置Spring核心控制器 --><servlet><servlet-name>dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><init-param><param-name>contextConfigLocation</param-name><param-value>/WEB-INF/dispatcher.xml</param-value></init-param><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>*.do</url-pattern></servlet-mapping><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list></web-app>4、 WEB-INF中的dispatcher.xml配置
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:mvc="http://www.springframework.org/schema/mvc"xmlns:context="http://www.springframework.org/schema/context"xmlns:util="http://www.springframework.org/schema/util"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsdhttp://www.springframework.org/schema/mvchttp://www.springframework.org/schema/mvc/spring-mvc-3.0.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.0.xsdhttp://www.springframework.org/schema/utilhttp://www.springframework.org/schema/util/spring-util-3.0.xsd"><context:component-scan base-package="com.hoo.*"><!-- 忽略这个类 --><context:exclude-filter type="assignable" expression="com.hoo.client.RESTClient"/></context:component-scan><!-- annotation的方法映射适配器 --><bean id="handlerAdapter" class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/><!-- xml视图，XStreamMarshaller，可以转换任何形式的java对象 --><bean name="xStreamMarshallingView" class="org.springframework.web.servlet.view.xml.MarshallingView"><property name="marshaller"><bean class="org.springframework.oxm.xstream.XStreamMarshaller"><!-- 为了初始化XStreamMarshaller，这个类会把我们接口中得到结果以XML文档形式展现出来 --><property name="autodetectAnnotations" value="true"/></bean></property></bean><!-- 视图解析器，根据视图的名称new ModelAndView(name)，在配置文件查找对应的bean配置 --><bean class="org.springframework.web.servlet.view.BeanNameViewResolver"><property name="order" value="3"/></bean><!-- annotation默认的方法映射适配器 --><bean id="handlerMapping" class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"><property name="order" value="1" /></bean></beans>5、 启动后，可以看到index.jsp 没有出现异常或错误。那么当前SpringMVC的配置就成功了。
二、REST控制器实现
REST控制器主要完成CRUD操作，也就是对于http中的post、get、put、delete。
还有其他的操作，如head、options、trace。
具体代码：
package com.hoo.controller;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.servlet.ModelAndView;/*** <b>function:</b>SpringMVC REST示例* @author hoojo* @createDate 2011-6-9 上午11:34:08* @file RESTController.java* @package com.hoo.controller* @project SpringRestWS* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@RequestMapping("/restful")@Controllerpublic class RESTController {@RequestMapping(value = "/show", method = RequestMethod.GET)public ModelAndView show() {System.out.println("show");ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("show method");return model;}@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)public ModelAndView getUserById(@PathVariable String id) {System.out.println("getUserById-" + id);ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("getUserById method -" + id);return model;}@RequestMapping(value = "/add", method = RequestMethod.POST)public ModelAndView addUser(String user) {System.out.println("addUser-" + user);ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("addUser method -" + user);return model;}@RequestMapping(value = "/edit", method = RequestMethod.PUT)public ModelAndView editUser(String user) {System.out.println("editUser-" + user);ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("editUser method -" + user);return model;}@RequestMapping(value = "/remove/{id}", method = RequestMethod.DELETE)public ModelAndView removeUser(@PathVariable String id) {System.out.println("removeUser-" + id);ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("removeUser method -" + id);return model;}}上面的方法对应的http操作：
/show -> get 查询/get/id -> get 查询/add -> post 添加/edit -> put 修改/remove/id -> delete 删除在这个方法中，就可以看到RESTful风格的url资源标识
@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)public ModelAndView getUserById(@PathVariable String id) {System.out.println("getUserById-" + id);ModelAndView model = new ModelAndView("xStreamMarshallingView");model.addObject("getUserById method -" + id);return model;}value=”/get/{id}”就是url中包含get，并且带有id参数的get请求，就会执行这个方法。这个url在请求的时候，会通过Annotation的@PathVariable来将url中的id值设置到getUserById的参数中去。 ModelAndView返回的视图是xStreamMarshallingView是一个xml视图，执行当前请求后，会显示一篇xml文档。文档的内容是添加到model中的值。
三、利用RestTemplate调用REST资源
代码如下：
package com.hoo.client;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Component;import org.springframework.web.client.RestTemplate;/*** <b>function:</b>RestTemplate调用REST资源* @author hoojo* @createDate 2011-6-9 上午11:56:16* @file RESTClient.java* @package com.hoo.client* @project SpringRestWS* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@Componentpublic class RESTClient {@Autowiredprivate RestTemplate template;private final static String url = "http://localhost:8080/SpringRestWS/restful/";public String show() {return template.getForObject(url + "show.do", String.class, new String[]{});}public String getUserById(String id) {return template.getForObject(url + "get/{id}.do", String.class, id);}public String addUser(String user) {return template.postForObject(url + "add.do?user={user}", null, String.class, user);}public String editUser(String user) {template.put(url + "edit.do?user={user}", null, user);return user;}public String removeUser(String id) {template.delete(url + "/remove/{id}.do", id);return id;}}RestTemplate的getForObject完成get请求、postForObject完成post请求、put对应的完成put请求、delete完成delete请求；还有execute可以执行任何请求的方法，需要你设置RequestMethod来指定当前请求类型。
RestTemplate.getForObject(String url, Class<String> responseType, String... urlVariables)
参数url是http请求的地址，参数Class是请求响应返回后的数据的类型，最后一个参数是请求中需要设置的参数。
template.getForObject(url + "get/{id}.do", String.class, id);
如上面的参数是{id}，返回的是一个string类型，设置的参数是id。最后执行该方法会返回一个String类型的结果。
下面建立一个测试类，完成对RESTClient的测试。代码如下：
package com.hoo.client;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.test.context.ContextConfiguration;import org.springframework.test.context.junit38.AbstractJUnit38SpringContextTests;/*** <b>function:</b>RESTClient TEST* @author hoojo* @createDate 2011-6-9 下午03:50:21* @file RESTClientTest.java* @package com.hoo.client* @project SpringRestWS* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@ContextConfiguration("classpath:applicationContext-*.xml")public class RESTClientTest extends AbstractJUnit38SpringContextTests {@Autowiredprivate RESTClient client;public void testShow() {System.out.println(client.show());}public void testGetUserById() {System.out.println(client.getUserById("abc"));}public void testAddUser() {System.out.println(client.addUser("jack"));}public void testEditUser() {System.out.println(client.editUser("tom"));}public void testRemoveUser() {System.out.println(client.removeUser("aabb"));}}我们需要在src目录下添加applicationContext-beans.xml完成对restTemplate的配置。restTemplate需要配置MessageConvert将返回的xml文档进行转换，解析成JavaObject。
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.0.xsd"><context:component-scan base-package="com.hoo.*"/><bean id="restTemplate" class="org.springframework.web.client.RestTemplate"><property name="messageConverters"><list><bean class="org.springframework.http.converter.xml.MarshallingHttpMessageConverter"><property name="marshaller" ref="xStreamMarshaller"/><property name="unmarshaller" ref="xStreamMarshaller"/></bean></list></property></bean><bean id="xStreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller"><property name="annotatedClasses"><array></array></property></bean></beans>上面配置了xStreamMarshaller是和RESTController中的ModelAndView的view对应的。因为那边是用xStreamMarshaller进行编组的，所以RestTemplate这边也需要用它来解组。RestTemplate还指出其他的MarshallingHttpMessageConverter；
