例如,GET http://host/context/employees/12345 将获取 ID 为 12345 的员工的表示。这个响应表示可以是包含详细的员工信息的 XML 或 ATOM,或者是具有更好 UI 的 JSP/HTML 页面。您看到哪种表示方式取决于服务器端实现和您的客户端请求的 MIME 类型。
RESTful Web Service 是一个使用 HTTP 和 REST 原理实现的 Web Service。通常,一个 RESTful Web Service 将定义基本资源 URI、它所支持的表示/响应 MIME,以及它所支持的操作。
<properties>
<spring.version>4.0.5.RELEASE</spring.version>
<jackson.version>1.9.2</jackson.version>
<cxf.version>3.0.3</cxf.version>
</properties> <dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency> <!--spring核心包-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency> <dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency> <dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency> <dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency> <dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency> <!--JSTL标签类-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency> <dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency> <dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.3.2</version>
</dependency>
<!--cxf-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxrs</artifactId>
<version>${cxf.version}</version>
</dependency> <!--json-->
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-core-asl</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-jaxrs</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-xc</artifactId>
<version>${jackson.version}</version>
</dependency>
</dependencies>
配置application.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:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd "> <!--扫描器-->
<context:component-scan base-package="com.wangzhu"/> </beans>
配置applicationWebService.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jaxws="http://cxf.apache.org/jaxws"
xmlns:jaxrs="http://cxf.apache.org/jaxrs"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.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-extension-jaxrs-binding.xml"/>
<import resource="classpath:META-INF/cxf/cxf-servlet.xml"/>-->
<jaxrs:server id="webService" address="/">
<!--输入拦截器设置-->
<jaxrs:inInterceptors> </jaxrs:inInterceptors> <!--输出拦截器设置-->
<jaxrs:outInterceptors> </jaxrs:outInterceptors> <!--serviceBeans:暴露的WebService服务类-->
<jaxrs:serviceBeans>
<ref bean="studentService"/>
</jaxrs:serviceBeans> <!--支持的协议-->
<jaxrs:extensionMappings>
<entry key="json" value="application/json"/>
<entry key="xml" value="application/xml"/>
</jaxrs:extensionMappings>
<!--编码格式-->
<jaxrs:languageMappings> </jaxrs:languageMappings>
<!--对象转换-->
<jaxrs:providers>
<bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"/>
</jaxrs:providers> </jaxrs:server>
</beans>
备注:注意以上文件中的标记的地方!其中address可以用于指定Web Service的版本!
配置web.xml
<!--全局配置文件-->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath*:applicationContext*.xml</param-value>
</context-param> <!--spring的监听器-->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener> <!--cxf的Servlet-->
<servlet>
<servlet-name>CXFServlet</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>
实体类StudentVo .java
package com.wangzhu.vo; import java.io.Serializable; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement
public class StudentVo implements Serializable { /**
*
*/
private static final long serialVersionUID = -5481609827444603990L;
private Integer id;
private String name;
private Integer age;
private String desc;
private Boolean status; public StudentVo() {
} public StudentVo(Integer id, String name, Integer age, String desc,
Boolean status) {
this.id = id;
this.name = name;
this.age = age;
this.desc = desc;
this.status = status;
} public Integer getId() {
return id;
} public void setId(Integer id) {
this.id = id;
} public String getName() {
return name;
} public void setName(String name) {
this.name = name;
} public Integer getAge() {
return age;
} public void setAge(Integer age) {
this.age = age;
} public String getDesc() {
return desc;
} public void setDesc(String desc) {
this.desc = desc;
} public Boolean getStatus() {
return status;
} public void setStatus(Boolean status) {
this.status = status;
} @Override
public String toString() {
return "{id=" + id + ", name=" + name + ", age=" + age + ", desc="
+ desc + ", status=" + status + "}";
} }
实体类StudentListVo.java
package com.wangzhu.vo; import java.io.Serializable;
import java.util.List; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement
public class StudentListVo implements Serializable { /**
*
*/
private static final long serialVersionUID = -2200047544608641662L;
private List<StudentVo> studentList; public StudentListVo() {
} public StudentListVo(List<StudentVo> studentList) {
this.studentList = studentList;
} public List<StudentVo> getStudentList() {
return studentList;
} public void setStudentList(List<StudentVo> studentList) {
this.studentList = studentList;
} @Override
public String toString() {
return "{studentList=" + studentList + "}";
} }
数据生成器StudentDateSet.java
package com.wangzhu.dataset; import java.util.ArrayList;
import java.util.List; import org.springframework.stereotype.Component; import com.wangzhu.vo.StudentVo; @Component
public class StudentDateSet {
private static List<StudentVo> list; static {
StudentDateSet.list = new ArrayList<StudentVo>(); for (int i = 0; i <; i++) {
StudentVo vo = new StudentVo(i, "name" + i, Math.round(100.0f),
"desc" + i, (i & 1) == 0);
StudentDateSet.list.add(vo);
}
} public static List<StudentVo> getList() {
return StudentDateSet.list;
} }
Web Service的接口StudentService.java
package com.wangzhu.service; import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType; import com.wangzhu.vo.StudentListVo;
import com.wangzhu.vo.StudentVo; @Path("/studentService")
@Produces(MediaType.APPLICATION_JSON)
public interface StudentService { @GET
@Path("/status")
public String getStatus(); @GET
@Path("/students/{index}")
public StudentVo getStudentById(@PathParam("index") Integer id); @GET
@Path("/students")
public StudentListVo getStudentList();
}
Web Service的实现类StudentServiceImpl.java
package com.wangzhu.service.impl; import java.util.List; import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component; import com.wangzhu.dataset.StudentDateSet;
import com.wangzhu.service.StudentService;
import com.wangzhu.vo.StudentListVo;
import com.wangzhu.vo.StudentVo; @Component("studentService")
public class StudentServiceImpl implements StudentService {
@Autowired
private StudentDateSet studentDateSet; /**
* url:http://<host>:<port>/<appcontext>/services/studentService/status
*/
@Override
@GET
@Path("/status")
public String getStatus() {
return "getStatus";
} /**
* url:http://<host>:<port>/<appcontext>/services/studentService/students/{
* index}
*/
@Override
@GET
@Path("/students/{index}")
public StudentVo getStudentById(@PathParam("index") Integer id) {
List<StudentVo> studentList = StudentDateSet.getList();
StudentVo vo = null;
if (studentList.size() > id) {
vo = studentList.get(id - 1);
}
return vo;
} /**
* url:http://<host>:<port>/<appcontext>/services/studentService/students
*/
@Override
@GET
@Path("/students")
public StudentListVo getStudentList() {
List<StudentVo> studentList = StudentDateSet.getList();
StudentListVo listVo = new StudentListVo(studentList);
return listVo;
} }
备注:注意以上有标记的studentService与applicationWebService.xml中有同名的标记。
测试:
在浏览器的地址栏中输入:
1、http://<host>:<port>/<appcontext>/services/studentService/students
2、http://<host>:<port>/<appcontext>/services/studentService/students/1