安科网

Spring整合CXF，发布RSETful 风格WebService

jiuweideqixu

jiuweideqixu

2013-09-12

关注 关注

这篇文章是承接之前CXF整合Spring的这个项目示例的延伸，所以有很大一部分都是一样的。关于发布CXF WebServer和Spring整合CXF这里就不再多加赘述了。如果你对Spring整合CXF WebService不了解，具体你可以参看这两篇文章：

http://www.cnblogs.com/hoojo/archive/2011/03/30/1999563.html

http://www.cnblogs.com/hoojo/archive/2012/07/13/2590593.html

如果你不了解restful风格的WebService，你可以参考：

http://www.oracle.com/technetwork/articles/javase/index-137171.html

SpringMVC对RESTful的支持：

http://www.cnblogs.com/hoojo/archive/2011/06/10/2077422.html

使用 Jersey框架，搭建RESTful WebService（这个也比较简单）

http://www.ibm.com/developerworks/cn/web/wa-aj-tomcat/

官方文档：http://jersey.java.net/nonav/documentation/latest/user-guide.html#d4e8

其中，比较常用的RESTful框架就有Jersey、Spring REST、CXF RESTful，这些都可以很好的整合Spring框架，发布也相当的简单。且简单、易用、易上手，文档也比较丰富。

开发环境：

System：Windows

JavaEE Server：tomcat6

JavaSDK： jdk6+

IDE：eclipse、MyEclipse 6.6

开发依赖库：

JDK6、 JavaEE5、CXF-2.3.3、Spring 3.0.4

Email：[email protected]

Blog：http://blog.csdn.net/IBM_hoojo

http://hoojo.cnblogs.com/

http://hoojo.blogjava.net

下面我们就接着http://www.cnblogs.com/hoojo/archive/2011/03/30/1999563.html这篇文章，开始我们CXF RESTful WebService的旅程，enjoy~！^_*

准备工作

首先，你需要添加相关的jar包

Spring整合CXF，发布RSETful 风格WebService

其中，jsr331-api-1.1.1.jar是必须的，利用CXF发布REST服务得用到它，在cxf的lib库中可以找到这个jar。

下载地址：http://www.apache.org/dyn/closer.cgi?path=/cxf/2.3.11/apache-cxf-2.3.11.zip

其它的jar包都是非必须的！

JavaEntity

package com.hoo.entity;
<!--CRLF--><!--CRLF-->
import java.util.Map;
<!--CRLF-->
import javax.xml.bind.annotation.XmlRootElement;
<!--CRLF--><!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b> MapBean 封装Map集合元素
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate 2012-7-20 下午01:22:31
<!--CRLF-->
* @file MapBean.java
<!--CRLF-->
* @package com.hoo.entity
<!--CRLF-->
* @project CXFWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
@XmlRootElement
<!--CRLF-->
public class MapBean {
<!--CRLF-->
private Map<String, User> map;
<!--CRLF--><!--CRLF-->
//@XmlElement(type = User.class)
<!--CRLF-->
public Map<String, User> getMap() {
<!--CRLF-->
return map;
<!--CRLF-->
}
<!--CRLF-->
public void setMap(Map<String, User> map) {
<!--CRLF-->
this.map = map;
<!--CRLF-->
}
<!--CRLF-->
}
<!--CRLF-->
package com.hoo.entity;
<!--CRLF--><!--CRLF-->
import java.util.HashMap;
<!--CRLF-->
import java.util.List;
<!--CRLF-->
import javax.xml.bind.annotation.XmlRootElement;
<!--CRLF--><!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b> Users Entity
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate 2011-3-18 上午09:27:31
<!--CRLF-->
* @file Users.java
<!--CRLF-->
* @package com.hoo.entity
<!--CRLF-->
* @project CXFWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
@XmlRootElement(name = "UserInfos")
<!--CRLF-->
public class Users {
<!--CRLF-->
private List<User> users;
<!--CRLF--><!--CRLF-->
private User[] userArr;
<!--CRLF--><!--CRLF-->
private HashMap<String, User> maps;
<!--CRLF--><!--CRLF--><!--CRLF-->
// getter/setter
<!--CRLF-->
}
<!--CRLF-->
package com.hoo.entity;
<!--CRLF--><!--CRLF-->
import java.io.Serializable;
<!--CRLF-->
import javax.xml.bind.annotation.XmlRootElement;
<!--CRLF--><!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b>User Entity
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate Dec 16, 2010 10:20:02 PM
<!--CRLF-->
* @file User.java
<!--CRLF-->
* @package com.hoo.entity
<!--CRLF-->
* @project AxisWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
@XmlRootElement(name = "UserInfo")
<!--CRLF-->
public class User implements Serializable {
<!--CRLF-->
private static final long serialVersionUID = 677484458789332877L;
<!--CRLF-->
private int id;
<!--CRLF-->
private String name;
<!--CRLF-->
private String email;
<!--CRLF-->
private String address;
<!--CRLF--><!--CRLF-->
//getter/setter
<!--CRLF--><!--CRLF-->
@Override
<!--CRLF-->
public String toString() {
<!--CRLF-->
return this.id + "#" + this.name + "#" + this.email + "#" + this.address;
<!--CRLF-->
}
<!--CRLF-->
}
<!--CRLF-->

一、定义你的WebService的接口RESTSample.java，代码如下

package com.hoo.service;
<!--CRLF--><!--CRLF-->
import java.io.IOException;
<!--CRLF-->
import javax.servlet.http.HttpServletRequest;
<!--CRLF-->
import javax.servlet.http.HttpServletResponse;
<!--CRLF-->
import javax.ws.rs.Consumes;
<!--CRLF-->
import javax.ws.rs.DELETE;
<!--CRLF-->
import javax.ws.rs.GET;
<!--CRLF-->
import javax.ws.rs.POST;
<!--CRLF-->
import javax.ws.rs.PUT;
<!--CRLF-->
import javax.ws.rs.Path;
<!--CRLF-->
import javax.ws.rs.PathParam;
<!--CRLF-->
import javax.ws.rs.Produces;
<!--CRLF-->
import javax.ws.rs.core.Context;
<!--CRLF-->
import javax.ws.rs.core.MediaType;
<!--CRLF--><!--CRLF-->
import com.hoo.entity.MapBean;
<!--CRLF-->
import com.hoo.entity.User;
<!--CRLF-->
import com.hoo.entity.Users;
<!--CRLF--><!--CRLF--><!--CRLF-->
/*
<!--CRLF-->
注释（Annotation）：在 javax.ws.rs.* 中定义，是 JAX-RS (JSR 311) 规范的一部分。
<!--CRLF-->
@Path：定义资源基 URI。由上下文根和主机名组成，资源标识符类似于 http://localhost:8080/RESTful/rest/hello。
<!--CRLF-->
@GET：这意味着以下方法可以响应 HTTP GET 方法。
<!--CRLF-->
@Produces：以纯文本方式定义响应内容 MIME 类型。
<!--CRLF--><!--CRLF-->
@Context： 使用该注释注入上下文对象，比如 Request、Response、UriInfo、ServletContext 等。
<!--CRLF-->
@Path("{contact}")：这是 @Path 注释，与根路径 “/contacts” 结合形成子资源的 URI。
<!--CRLF-->
@PathParam("contact")：该注释将参数注入方法参数的路径，在本例中就是联系人 id。其他可用的注释有 @FormParam、@QueryParam 等。
<!--CRLF-->
@Produces：响应支持多个 MIME 类型。在本例和上一个示例中，APPLICATION/XML 将是默认的 MIME 类型。
<!--CRLF-->
*/
<!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b> CXF RESTful风格WebService
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate 2012-7-20 下午01:23:04
<!--CRLF-->
* @file RESTSampleSource.java
<!--CRLF-->
* @package com.hoo.service
<!--CRLF-->
* @project CXFWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
@Path(value = "/sample")
<!--CRLF-->
public interface RESTSample {
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Produces(MediaType.TEXT_PLAIN)
<!--CRLF-->
public String doGet();
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Produces(MediaType.TEXT_PLAIN)
<!--CRLF-->
@Path("/request/{param}")
<!--CRLF-->
public String doRequest(@PathParam("param") String param,
<!--CRLF-->
@Context HttpServletRequest servletRequest, @Context HttpServletResponse servletResponse);
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/bean/{id}")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public User getBean(@PathParam("id") int id);
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/list")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
<!--CRLF-->
public Users getList();
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/map")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public MapBean getMap();
<!--CRLF--><!--CRLF-->
/*
<!--CRLF-->
@Consumes：声明该方法使用 HTML FORM。
<!--CRLF-->
@FormParam：注入该方法的 HTML 属性确定的表单输入。
<!--CRLF-->
@Response.created(uri).build()： 构建新的 URI 用于新创建的联系人（/contacts/{id}）并设置响应代码（201/created）。
<!--CRLF-->
您可以使用 http://localhost:8080/Jersey/rest/contacts/<id> 访问新联系人
<!--CRLF-->
*/
<!--CRLF-->
@POST
<!--CRLF-->
@Path("/postData")
<!--CRLF-->
public User postData(User user) throws IOException;
<!--CRLF--><!--CRLF-->
@PUT
<!--CRLF-->
@Path("/putData/{id}")
<!--CRLF-->
@Consumes(MediaType.APPLICATION_XML)
<!--CRLF-->
public User putData(@PathParam("id") int id, User user);
<!--CRLF--><!--CRLF-->
@DELETE
<!--CRLF-->
@Path("/removeData/{id}")
<!--CRLF-->
public void deleteData(@PathParam("id") int id);
<!--CRLF-->
}
<!--CRLF-->

二、RESTSample接口的实现，这里我们只是简单的实现下，并不是涉及实际的具体业务

package com.hoo.service;
<!--CRLF--><!--CRLF-->
import java.io.IOException;
<!--CRLF-->
import java.util.ArrayList;
<!--CRLF-->
import java.util.HashMap;
<!--CRLF-->
import java.util.List;
<!--CRLF-->
import java.util.Map;
<!--CRLF-->
import javax.servlet.http.HttpServletRequest;
<!--CRLF-->
import javax.servlet.http.HttpServletResponse;
<!--CRLF-->
import javax.ws.rs.DELETE;
<!--CRLF-->
import javax.ws.rs.GET;
<!--CRLF-->
import javax.ws.rs.POST;
<!--CRLF-->
import javax.ws.rs.PUT;
<!--CRLF-->
import javax.ws.rs.Path;
<!--CRLF-->
import javax.ws.rs.PathParam;
<!--CRLF-->
import javax.ws.rs.Produces;
<!--CRLF-->
import javax.ws.rs.core.Context;
<!--CRLF-->
import javax.ws.rs.core.MediaType;
<!--CRLF-->
import javax.ws.rs.core.Request;
<!--CRLF-->
import javax.ws.rs.core.UriInfo;
<!--CRLF-->
import com.hoo.entity.MapBean;
<!--CRLF-->
import com.hoo.entity.User;
<!--CRLF-->
import com.hoo.entity.Users;
<!--CRLF--><!--CRLF--><!--CRLF-->
/*
<!--CRLF-->
注释（Annotation）：在 javax.ws.rs.* 中定义，是 JAX-RS (JSR 311) 规范的一部分。
<!--CRLF-->
@Path：定义资源基 URI。由上下文根和主机名组成，资源标识符类似于 http://localhost:8080/RESTful/rest/hello。
<!--CRLF-->
@GET：这意味着以下方法可以响应 HTTP GET 方法。
<!--CRLF-->
@Produces：以纯文本方式定义响应内容 MIME 类型。
<!--CRLF--><!--CRLF-->
@Context： 使用该注释注入上下文对象，比如 Request、Response、UriInfo、ServletContext 等。
<!--CRLF-->
@Path("{contact}")：这是 @Path 注释，与根路径 “/contacts” 结合形成子资源的 URI。
<!--CRLF-->
@PathParam("contact")：该注释将参数注入方法参数的路径，在本例中就是联系人 id。其他可用的注释有 @FormParam、@QueryParam 等。
<!--CRLF-->
@Produces：响应支持多个 MIME 类型。在本例和上一个示例中，APPLICATION/XML 将是默认的 MIME 类型。
<!--CRLF-->
*/
<!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b> CXF RESTful风格WebService
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate 2012-7-20 下午01:23:04
<!--CRLF-->
* @file RESTSampleSource.java
<!--CRLF-->
* @package com.hoo.service
<!--CRLF-->
* @project CXFWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
@Path(value = "/sample")
<!--CRLF-->
public class RESTSampleSource implements RESTSample {
<!--CRLF--><!--CRLF-->
@Context
<!--CRLF-->
private UriInfo uriInfo;
<!--CRLF--><!--CRLF-->
@Context
<!--CRLF-->
private Request request;
<!--CRLF--><!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Produces(MediaType.TEXT_PLAIN)
<!--CRLF-->
public String doGet() {
<!--CRLF-->
return "this is get rest request";
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Produces(MediaType.TEXT_PLAIN)
<!--CRLF-->
@Path("/request/{param}")
<!--CRLF-->
public String doRequest(@PathParam("param") String param,
<!--CRLF-->
@Context HttpServletRequest servletRequest, @Context HttpServletResponse servletResponse) {
<!--CRLF-->
System.out.println(servletRequest);
<!--CRLF-->
System.out.println(servletResponse);
<!--CRLF-->
System.out.println(servletRequest.getParameter("param"));
<!--CRLF-->
System.out.println(servletRequest.getContentType());
<!--CRLF-->
System.out.println(servletResponse.getCharacterEncoding());
<!--CRLF-->
System.out.println(servletResponse.getContentType());
<!--CRLF-->
return "success";
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/bean/{id}")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public User getBean(@PathParam("id") int id) {
<!--CRLF-->
System.out.println("####getBean#####");
<!--CRLF-->
System.out.println("id:" + id);
<!--CRLF-->
System.out.println("Method:" + request.getMethod());
<!--CRLF-->
System.out.println("uri:" + uriInfo.getPath());
<!--CRLF-->
System.out.println(uriInfo.getPathParameters());
<!--CRLF--><!--CRLF-->
User user = new User();
<!--CRLF-->
user.setId(id);
<!--CRLF-->
user.setName("JojO");
<!--CRLF-->
return user;
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/list")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
<!--CRLF-->
public Users getList() {
<!--CRLF-->
System.out.println("####getList#####");
<!--CRLF-->
System.out.println("Method:" + request.getMethod());
<!--CRLF-->
System.out.println("uri:" + uriInfo.getPath());
<!--CRLF-->
System.out.println(uriInfo.getPathParameters());
<!--CRLF--><!--CRLF-->
List<User> list = new ArrayList<User>();
<!--CRLF-->
User user = null;
<!--CRLF-->
for (int i = 0; i < 4;i ++) {
<!--CRLF-->
user = new User();
<!--CRLF-->
user.setId(i);
<!--CRLF-->
user.setName("JojO-" + i);
<!--CRLF-->
list.add(user);
<!--CRLF-->
}
<!--CRLF-->
Users users = new Users();
<!--CRLF-->
users.setUsers(list);
<!--CRLF-->
return users;
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@GET
<!--CRLF-->
@Path("/map")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public MapBean getMap() {
<!--CRLF-->
System.out.println("####getMap#####");
<!--CRLF-->
System.out.println("Method:" + request.getMethod());
<!--CRLF-->
System.out.println("uri:" + uriInfo.getPath());
<!--CRLF-->
System.out.println(uriInfo.getPathParameters());
<!--CRLF--><!--CRLF-->
Map<String, User> map = new HashMap<String, User>();
<!--CRLF-->
User user = null;
<!--CRLF-->
for (int i = 0; i < 4;i ++) {
<!--CRLF-->
user = new User();
<!--CRLF-->
user.setId(i);
<!--CRLF-->
user.setName("JojO-" + i);
<!--CRLF-->
map.put("key-" + i, user);
<!--CRLF-->
}
<!--CRLF-->
MapBean bean = new MapBean();
<!--CRLF-->
bean.setMap(map);
<!--CRLF-->
return bean;
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
/*
<!--CRLF-->
@Consumes：声明该方法使用 HTML FORM。
<!--CRLF-->
@FormParam：注入该方法的 HTML 属性确定的表单输入。
<!--CRLF-->
@Response.created(uri).build()： 构建新的 URI 用于新创建的联系人（/contacts/{id}）并设置响应代码（201/created）。
<!--CRLF-->
您可以使用 http://localhost:8080/Jersey/rest/contacts/<id> 访问新联系人
<!--CRLF-->
*/
<!--CRLF-->
@POST
<!--CRLF-->
@Path("/postData")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public User postData(User user) throws IOException {
<!--CRLF-->
System.out.println(user);
<!--CRLF-->
user.setName("jojo##12321321");
<!--CRLF-->
return user;
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@PUT
<!--CRLF-->
@Path("/putData/{id}")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML })
<!--CRLF-->
public User putData(@PathParam("id") int id, User user) {
<!--CRLF-->
System.out.println("#####putData#####");
<!--CRLF-->
System.out.println(user);
<!--CRLF-->
user.setId(id);
<!--CRLF-->
user.setAddress("hoojo#gz");
<!--CRLF-->
user.setEmail("[email protected]");
<!--CRLF-->
user.setName("hoojo");
<!--CRLF-->
System.out.println(user);
<!--CRLF-->
return user;
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@DELETE
<!--CRLF-->
@Path("/removeData/{id}")
<!--CRLF-->
public void deleteData(@PathParam("id") int id) {
<!--CRLF-->
System.out.println("#######deleteData#######" + id);
<!--CRLF-->
}
<!--CRLF-->
}
<!--CRLF-->
三、配置我们的WebService，修改applicationContext-server.xml。这里主要是添加jaxrs标签的支持，修改头部文件如下：
<?xml version="1.0" encoding="UTF-8"?>
<!--CRLF-->
<beans xmlns="http://www.springframework.org/schema/beans"
<!--CRLF-->
xmlns:context="http://www.springframework.org/schema/context"
<!--CRLF-->
xmlns:jaxws="http://cxf.apache.org/jaxws"
<!--CRLF-->
xmlns:jaxrs="http://cxf.apache.org/jaxrs"
<!--CRLF-->
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<!--CRLF-->
xsi:schemaLocation="http://www.springframework.org/schema/beans
<!--CRLF-->
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
<!--CRLF-->
http://www.springframework.org/schema/context
<!--CRLF-->
http://www.springframework.org/schema/context/spring-context-3.0.xsd
<!--CRLF-->
http://cxf.apache.org/jaxws
<!--CRLF-->
http://cxf.apache.org/schemas/jaxws.xsd
<!--CRLF-->
http://cxf.apache.org/jaxrs
<!--CRLF-->
http://cxf.apache.org/schemas/jaxrs.xsd">
<!--CRLF-->
特别注意上面加粗带下划线的部分，这是新增加的配置。我们发布restful WebService需要用到它。
然后在配置文件中添加如下配置
<import resource="classpath:META-INF/cxf/cxf.xml"/>
<!--CRLF-->
<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml"/>
<!--CRLF-->
<import resource="classpath:META-INF/cxf/cxf-servlet.xml"/>
<!--CRLF-->
<bean id="restSample" class="com.hoo.service.RESTSampleSource"/>
<!--CRLF-->
<!-- 这里的地址很重要，客户端需要通过这个地址来访问WebService -->
<!--CRLF-->
<jaxrs:server id="restServiceContainer" address="/rest">
<!--CRLF-->
<jaxrs:serviceBeans>
<!--CRLF-->
<ref bean="restSample" />
<!--CRLF-->
</jaxrs:serviceBeans>
<!--CRLF-->
<jaxrs:extensionMappings>
<!--CRLF-->
<entry key="json" value="application/json" />
<!--CRLF-->
<entry key="xml" value="application/xml" />
<!--CRLF-->
</jaxrs:extensionMappings>
<!--CRLF-->
<jaxrs:languageMappings>
<!--CRLF-->
<entry key="en" value="en-gb"/>
<!--CRLF-->
</jaxrs:languageMappings>
<!--CRLF-->
</jaxrs:server>
<!--CRLF-->

这样服务器端就完成了CXF RESTful WebService的发布，启动你的tomcat。然后在浏览器中服务地址：http://localhost:8000/CXFWebService/ （其实这里请求的是CXFServlet，你可以看看上一篇Spring整合CXF文章的web.xml的配置）

你就可以看到我们这里刚刚发布的RESTSample rest的WebService

Spring整合CXF，发布RSETful 风格WebService 

你也可以看看里面的xml，也就是WebService的wsdl文件内容。我们找一个GET方式的WebService的方法，在浏览器中调用一下试试

http://localhost:8000/CXFWebService/rest/sample/bean/123

这个url对应到下面这个方法

@GET
<!--CRLF-->
@Path("/bean/{id}")
<!--CRLF-->
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
<!--CRLF-->
public User getBean(@PathParam("id") int id)
<!--CRLF-->

结果如下

Spring整合CXF，发布RSETful 风格WebService

一篇xml文档内容。

四、编写客户端代码，调用RESTful WebService

package com.hoo.client;
<!--CRLF--><!--CRLF-->
import java.io.IOException;
<!--CRLF-->
import javax.ws.rs.core.MediaType;
<!--CRLF-->
import org.apache.cxf.jaxrs.client.WebClient;
<!--CRLF-->
import org.junit.After;
<!--CRLF-->
import org.junit.Before;
<!--CRLF-->
import org.junit.Test;
<!--CRLF-->
import org.springframework.context.ApplicationContext;
<!--CRLF-->
import org.springframework.context.support.ClassPathXmlApplicationContext;
<!--CRLF-->
import com.hoo.entity.MapBean;
<!--CRLF-->
import com.hoo.entity.User;
<!--CRLF-->
import com.hoo.entity.Users;
<!--CRLF-->
import com.hoo.service.RESTSample;
<!--CRLF--><!--CRLF-->
/**
<!--CRLF-->
* <b>function:</b> RESTful风格WebService
<!--CRLF-->
* @author hoojo
<!--CRLF-->
* @createDate 2012-7-20 下午03:31:03
<!--CRLF-->
* @file RSETServiceClient.java
<!--CRLF-->
* @package com.hoo.client
<!--CRLF-->
* @project CXFWebService
<!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo
<!--CRLF-->
* @email [email protected]
<!--CRLF-->
* @version 1.0
<!--CRLF-->
*/
<!--CRLF-->
public class RSETServiceClient {
<!--CRLF--><!--CRLF-->
private static WebClient client;
<!--CRLF--><!--CRLF-->
@Before
<!--CRLF-->
public void init() {
<!--CRLF-->
// 手动创建webClient对象，注意这里的地址是发布的那个/rest地址
<!--CRLF-->
//String url = "http://localhost:8000/CXFWebService/rest/";
<!--CRLF-->
//client = WebClient.create(url);
<!--CRLF--><!--CRLF-->
// 从Spring Ioc容器中拿webClient对象
<!--CRLF-->
ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-client.xml");
<!--CRLF-->
client = ctx.getBean("webClient", WebClient.class);
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@After
<!--CRLF-->
public void destory(){
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testGet() {
<!--CRLF-->
System.out.println(client.path("sample").accept(MediaType.TEXT_PLAIN).get(String.class));
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testRequest() {
<!--CRLF-->
System.out.println(client.path("sample/request/234234").accept(MediaType.TEXT_PLAIN).get(String.class));
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testBean() {
<!--CRLF-->
User user = client.path("sample/bean/{id}", 25).accept(MediaType.APPLICATION_XML).get(User.class);
<!--CRLF-->
System.out.println(user);
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testList() {
<!--CRLF-->
System.out.println(client.path("sample/list").accept(MediaType.APPLICATION_XML).get(Users.class).getUsers());
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testMap() {
<!--CRLF-->
System.out.println(client.path("sample/map").accept(MediaType.APPLICATION_XML).get(MapBean.class).getMap());
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testDeleteData() {
<!--CRLF-->
client.path("sample/removeData/23").delete();
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testPostData() {
<!--CRLF-->
User user = new User();
<!--CRLF-->
user.setId(21432134);
<!--CRLF-->
user.setAddress("hoojo#gz");
<!--CRLF-->
user.setEmail("[email protected]");
<!--CRLF-->
user.setName("hoojo");
<!--CRLF-->
System.out.println(client.path("sample/postData").accept(MediaType.APPLICATION_XML).post(user, User.class));
<!--CRLF-->
}
<!--CRLF--><!--CRLF-->
@Test
<!--CRLF-->
public void testPutData() {
<!--CRLF-->
User user = new User();
<!--CRLF-->
user.setId(21432134);
<!--CRLF-->
System.out.println(client.path("sample/putData/1").accept(MediaType.APPLICATION_XML).put(user).getEntity());
<!--CRLF-->
}
<!--CRLF-->
}
<!--CRLF-->
如果你喜欢用Spring的方式，还需要在applicationContext-client.xml中增加如下配置
<?xml version="1.0" encoding="UTF-8"?>
<!--CRLF-->
<beans xmlns="http://www.springframework.org/schema/beans"
<!--CRLF-->
xmlns:context="http://www.springframework.org/schema/context"
<!--CRLF-->
xmlns:jaxws="http://cxf.apache.org/jaxws"
<!--CRLF-->
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<!--CRLF-->
xsi:schemaLocation="http://www.springframework.org/schema/beans
<!--CRLF-->
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
<!--CRLF-->
http://www.springframework.org/schema/context
<!--CRLF-->
http://www.springframework.org/schema/context/spring-context-3.0.xsd
<!--CRLF-->
http://cxf.apache.org/jaxws
<!--CRLF-->
http://cxf.apache.org/schemas/jaxws.xsd">
<!--CRLF--><!--CRLF-->
<bean id="webClient" class="org.apache.cxf.jaxrs.client.WebClient" factory-method="create">
<!--CRLF-->
<constructor-arg type="java.lang.String" value="http://localhost:8000/CXFWebService/rest/" />
<!--CRLF-->
</bean>
<!--CRLF--><!--CRLF-->
</beans>
<!--CRLF-->

这种是利用WebClient对象来调用WebService，还有一种方法也可以调用WebService，代码如下：

// 手动创建
<!--CRLF-->
//RESTSample sample = JAXRSClientFactory.create("http://localhost:8000/CXFWebService/rest", RESTSample.class);
<!--CRLF--><!--CRLF-->
// 从Spring Ioc容器中拿webClient对象
<!--CRLF-->
ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-client.xml");
<!--CRLF-->
RESTSample sample = ctx.getBean("restSampleBean", RESTSample.class);
<!--CRLF--><!--CRLF-->
System.out.println(sample);
<!--CRLF--><!--CRLF-->
System.out.println(sample.doGet());
<!--CRLF-->
//System.out.println(sample.doRequest("haha", null, null));
<!--CRLF-->
System.out.println(sample.getBean(22));
<!--CRLF-->
System.out.println(sample.getList());
<!--CRLF-->
System.out.println(sample.getMap().getMap());
<!--CRLF-->
User user = new User();
<!--CRLF-->
user.setId(21432134);
<!--CRLF-->
user.setAddress("hoojo#gz");
<!--CRLF-->
user.setEmail("[email protected]");
<!--CRLF-->
user.setName("hoojo");
<!--CRLF-->
System.out.println(sample.postData(user));
<!--CRLF-->
System.out.println(sample.putData(111, user));
<!--CRLF-->
sample.deleteData(2);
<!--CRLF-->

这种方式相对比WebClient要简单，直接使用接口中的方法即可。同样如果你要整合到Spring可以在applicationContext-client.xml中增加配置如下：

<bean id="restSampleBean" class="org.apache.cxf.jaxrs.client.JAXRSClientFactory" factory-method="create">
<!--CRLF-->
<constructor-arg type="java.lang.String" value="http://localhost:8000/CXFWebService/rest/" />
<!--CRLF-->
<constructor-arg type="java.lang.Class" value="com.hoo.service.RESTSample" />
<!--CRLF-->
</bean>
<!--CRLF-->

执行以上方法可以看到控制台打印结果如下：

client console
<!--CRLF-->
org.apache.cxf.jaxrs.client.ClientProxyImpl@1cf7491
<!--CRLF-->
this is get rest request
<!--CRLF-->
22#JojO#null#null
<!--CRLF-->
com.hoo.entity.Users@16eb6bc
<!--CRLF-->
{key-0=0#JojO-0#null#null, key-1=1#JojO-1#null#null, key-2=2#JojO-2#null#null, key-3=3#JojO-3#null#null}
<!--CRLF-->
21432134#jojo##12321321#[email protected]#hoojo#gz
<!--CRLF-->
111#hoojo#[email protected]#hoojo#gz
<!--CRLF--><!--CRLF-->
server console
<!--CRLF-->
####getBean#####
<!--CRLF-->
id:22
<!--CRLF-->
Method:GET
<!--CRLF-->
uri:sample/bean/22
<!--CRLF-->
{id=[22]}
<!--CRLF-->
####getList#####
<!--CRLF-->
Method:GET
<!--CRLF-->
uri:sample/list
<!--CRLF-->
{}
<!--CRLF-->
####getMap#####
<!--CRLF-->
Method:GET
<!--CRLF-->
uri:sample/map
<!--CRLF-->
{}
<!--CRLF-->
21432134#hoojo#[email protected]#hoojo#gz
<!--CRLF-->
#####putData#####
<!--CRLF-->
21432134#hoojo#[email protected]#hoojo#gz
<!--CRLF-->
111#hoojo#[email protected]#hoojo#gz
<!--CRLF-->
#######deleteData#######2
<!--CRLF-->

就这样，整合restful WebService成功。

cxf spring框架

jiuweideqixu

jiuweideqixu

0 关注 0 粉丝 0 动态

关注 关注

相关推荐

webservice初体验-cxf

最近一段时间，说忙也不是很忙，说闲但确实很少有时间能静下心来写点东西。但于我而言，做任何仪式感很重要，就算没时间坚持，那仪式感也不能丢，这是一种态度，也是最后的底线。今天的这篇推文，是很久以前就实践过了，前几天又整理了一下，上周没有发，本周必须要更新，不敢

newfarhui 2020-01-18

WebService与Spring整合部署

-- 配置cxf框架 cxf-servlet.xml -->. -- 加载提供的服务 -->. return "服务器返回：" + content;

zhangxiaocc 2019-12-06

Jboss EAP 6启用CXF日志

<logger category="org.apache.cxf"> <level name="INFO"/> </logger>. @WebService(serviceName

forliberty 2015-05-04

Spring整合CXF webservice restful 实例

webservice restful接口跟soap协议的接口实现大同小异，只是在提供服务的类/接口的注解上存在差异，具体看下面的代码，然后自己对比下就可以了。38 public static void main throws IOException

Adolphlwq 2017-08-10

Springboot整合cxf后不能访问controller,不能访问接口

springboot 1.4.X　　<=========>　　cxf-spring-boot-starter-jaxws 3.1.X. 成功集成cxf后，发现只有webservice服务可以正常使用，其他请求url全部无法正常访问。

newfarhui 2019-10-23

CXF与Spring集成Web Service

使用MyEclipse8.5 首先创建一个Web工程，加入Spring框架支持。选择Spring3.0的版本，并且加入Spring3.0 Core包 和 Spring3.0 Web 2个包。编写服务接口以及接口实现类是，在类前加上@Web Service

neweastsun 2013-12-07

Axis，axis2，Xfire以及cxf对比

xfire最新的版本为1.2.6 - May 3, 2007 网站已经说了“XFire is now CXF” --|||. cxf最新的版本为Feb 28, 2011 - Apache CXF 2.3.3 is released!现在只有axis2和cx

Selier 2014-05-28

CXF发布webservice

@WebServicepublic interface xfiretestCXF {public String testmethod(String str);}. <!-- webservice 开始-->. <import resour

蜀川居 2017-10-16

SpringBoot 使用CXF 集成WebService 请求忽略命名空间

上一章我们介绍了如何用springBoot 来搭建一个WebService服务《SpringBoot 使用CXF 集成WebService》，还不了解的同学可以去看下。在使用CXF搭建的WebServic服务时，有个很不爽的地方就是请求必须带上命名空间。这

jianghuchuanke 2019-09-05

几种常用的webservice客户端和spring集成的方法

项目需要，这两天系统要调一个webservice的服务，webservice的东西都扔了好几年了，怎么使用都忘得一干二净了。以前都是使用系统现成的框架掉一个方法就行了，现在几乎是从0开始一点一点搭建环境啊。总结一下，现在项目中很少用webservice了，

zhongjcbill 2015-11-30

Axis

xfire最新的版本为1.2.6-May3,2007网站已经说了“XFireisnowCXF”--|||. 现在只有axis2和cxf官方有更新。XFire是与Axis2并列的新一代WebService平台。XFire采用Woodstox作Stax实现；在

xiajlxiajl 2015-09-01

cxf集成spring，精简版

上次把webservice客户端接口，用注解注入到别的bean里，结果报错了。当时一直没有找到原因，现在回想，有可能是当时代码环境的问题，spring和cxf的配置都有些混乱。最近在搭建一个培训的框架，开发环境很纯净，上次那个问题没有再发生了。因此也简化了

industry0 2014-12-08

cxf +spring 发布webservice

-- 配置spring 监听器 -->. -- 配置CXF的核心Servlet -->. -- 通过初始化参数指定cxf配置文件的位置 -->

cloudspring 2014-11-29

wsimport 天气出错 undefined element declaration s:schema

如果不保留xml文件或移动xml文件，需要将WeatherWebService中的第22行和第35行中的本地xml文件路径替换掉，最好为web路径

bobobocai 2014-07-17

设置CXF的WebService客户端超时时长

　　在使用WebService的时候,我们可能需要一个备份的WebService服务器.一旦主服务器down了,我们可以使用备份的服务器.那么这里就需要对客服端连接服务器的时间做一个修改.　　在Spring+CXF的WebService环境下,客户端有两个

LunaZhang 2012-06-11

CXF学习笔记三（发布restFul）

JAX-RS旨在定义一个统一的规范，使得Java程序员可以使用一套固定的接口来开发REST应用，避免了依赖第三方框架。同时JAX-RS使用POJO编程模型和基于注解的配置并集成JAXB，可以有效缩短REST应用的开发周期。JAX-RS只定义RESTful

89467606 2015-12-25

Axis，axis2，Xfire以及cxf对比

xfire最新的版本为1.2.6 - May 3, 2007 网站已经说了“XFire is now CXF” --|||. cxf最新的版本为Feb 28, 2011 - Apache CXF 2.3.3 is released!现在只有axis2和cx

iPro 2014-05-28

CXF客户端对axis服务器的访问

CXF 和 axis都是非常不错的webservice的技术框架。最近项目需要了解了一下两个框架的访问。CXF客户端对对CXF服务器的访问，很简单。

LunaZhang 2011-09-14

CXF发送、接收消息超时设置

在使用WebService时，我们通常都会在客户端中设置请求超时的限制，以避免长时间的去连接不可用的服务器。在CXF的环境下，客户端可通过两个属性配置超时限制：。ReceiveTimeout - 这个属性是发送WebService的请求后等待响应的时间,超

chenhualeguan 2011-11-30

RPC框架是啥之Apache CXF一款WebService RPC框架入门教程

它可以说是一个功能齐全的集合。支持Web Service标准，包括SOAP规范、WSI Basic Profile...等等我也不了解的，这里就不一一举例了。支持多种传输协议和协议绑定、数据绑定。还是先从案例入手吧项目源码地址：RPC_Demo，记得是项目

青青木屋 2019-07-01
jiuweideqixu

jiuweideqixu

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号