用CXF构建RESTful services有两种方式:
CXF对JAX-RS的实现。
使用JAX-WS Provider/Dispatch API。
官网上还有Http Bindings方式,他需要做一些繁琐的工作去创建资源再映射到服务上,这种方式从2.6时已经被移除了。
刚好我这里有几个工程都是用第一种方式实现的,在这里便主要记录一下spring CXF构建RESTful service。
首先列举一下JAX-RS的一些常用注解。
@ Path :指定资源的URI。
@ Produces / @ Consumes :指定请求/响应的媒体类型。当类和方法同时被标注时,方法标注会覆盖类标注。
@ GET , @ POST , @ PUT , @ DELETE , @ HEAD , @ OPTIONS :指定请求的Http method。
@ QueryParam , @ PathParam , @ HeaderParam , @ FormParam , @ CookieParam :指定参数值的来源,可标注于类、方法、属性。
符合以下规则的参数值可以被接收:
原始类型
拥有一个String参数的constructor
有valueOf或者fromString静态method
另外部分来源也支持SortedSet、List和Set,T需要满足上面的规则。
org.apache.cxf cxf-bundle-jaxrs ${cxf.version}
现在我打算定义一个服务用来返回一组用户信息。
当以get method访问users资源时将以XML表述:
package pac.king.webservice;import javax.ws.rs.GET;import javax.ws.rs.Path;import javax.ws.rs.Produces;import javax.ws.rs.core.MediaType;import pac.king.pojo.User;@Path('/')public interface MyRestService { @GET @Path('users') @Produces({ MediaType.APPLICATION_XML }) public User[] userInfos();}
接口实现我就简单写一下:
public class MyRestServiceImpl implements MyRestService{ @WebMethod public User[] userInfos() { User[] myInfos = new User[4]; myInfos[0] = new User('0001','Kim','t;stmdtkg'); myInfos[1] = new User('0002','King.','t;stmdtkg'); myInfos[2] = new User('0003','sweet_dreams','t;stmdtkg'); myInfos[3] = new User('0004','show_time','t;stmdtkg'); return myInfos; }}
定义User时需要注意加上无参的constructor和 @ XmlRootElement
package pac.king.pojo;import javax.xml.bind.annotation.XmlRootElement;@XmlRootElementpublic class User { private String id; private String name; private String password; public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public User() {} public User(String id, String name, String password) { super(); this.id = id; this.name = name; this.password = password; }}
使用 org.apache.cxf.jaxrs.JAXRSServerFactoryBean 启动服务:
JAXRSServerFactoryBean rsFactory = new JAXRSServerFactoryBean();rsFactory.setAddress('
http://localhost:8888/myRest');rsFactory.setResourceClasses(MyRestServiceImpl.class);rsFactory.creat...;
访问
http://localhost:8888/myRest/users,输出:
用CXF Spring方式构建RESTful service也非常方便,虽然也会带来一些问题。
服务就继续用上面定义的MyRestService,但是Service的部分属性将定义在XML configration中,并将service放到容器里。
(其实也可以non-Spring配置到容器里,很难想象为什么要用这种方式,但似乎可以明白点点什么。)
spring配置,引入了一些不必要的namespace,但也没什么大问题:
在web.xml中加入CXFServlet,注意我写的url pattern是/services/*:
CXFServlet org.apache.cxf.transport.servlet.CXFServlet 1 CXFServlet /services/*
访问
http://localhost:8080/runtrain/services ,效果如下(还有一个是上一篇的JAX-WS服务):
访问
http://localhost:8080/runtrain/services/rest/users ,效果如下:
最后说一下lifecycle的问题。
像这个例子中用bean标签定义一个服务,此时给他加上scope标签不会有任何效果。
他始终是默认的――singleton。
jaxrs:server下还有一个子标签叫jaxrs:serviceFactories,里面可以存放 org.apache.cxf.jaxrs.spring.SpringResourceFactory 类型的Bean,SpringResourceFactory将会把服务的声明周期委派给ApplicationContext来管理。
我可以做如下配置:
但这种方式有些麻烦,难道我就为了让scope生效定义bean又定义SpringResourceFactory又设置serviceFactoris?
可以更简便地配置,如下:
需要注意的是beanNames属性中写多个值时以space分隔。
二:jaxws
1服务端:
2客服端:
所需jar包:cxf.jar, neethi.jar, wsdl4j.jar, xml scheme-core.jar
IprojectWebService.java
JaxWsProxyFactoryBean factory=new JaxWsProxyFactoryBean()
factory.setAddress(url)
factory.setServiceClass(IprojectWebSevice.class)
IprjectWebService proxyService=factory.create()