WebService之基于REST机制的实现实例（Java版）

 WebService之基于REST机制的实现实例（Java版）

REST是REpresentational State Transfer的缩写（一般中文翻译为表述性状态转移）。2000年Roy Fielding博士在他的博士论文“Architectural Styles and the Design of Network-based Software Architectures”《体系结构与基于网络的软件架构设计》中提出了REST。

REST是一种体系结构, 而HTTP是一种包含了REST架构属性的协议。

REST基础概念

• 在REST中所有东西都被看作资源。每一个资源都有一个URI和它对应。
• 在REST中使用统一接口处理资源。与数据库CRUD操作（Create、Read、Update 和 Delete）一样，可以用POST、GET、PUT和DELETE处理REST资源。
• 每个REST请求都是孤立的，请求中包含了所需的全部信息。REST服务端不存储状态。
• REST支持不同的通信数据格式，比如XML、JSON。

RESTful Web Services

RESTful Web Services因其简单性被广泛使用，它比SOAP要更简单。本文将重点介绍如何使用Jersey框架创建RESTful Web Services。Jersey框架实现了JAX-RS接口。本文示例代码使用Eclipse和Java SE 6编写。

一、新建项目：RESTfulWS ，然后创建RESTful Web Service服务端

• 在Eclipse中创建一个“dynamic web project”（动态web工程） ，项目名设为 “RESTfulWS”。

• 从这里下载Jersey。示例代码使用的是Jersey 1.17.1。首先解压Jersey到“jersey-archive-1.17.1”文件夹。接着将里面lib文件夹下的jar文件拷贝到工程目录的WEB-INF -> lib。然后将它们添加到build path。

1. asm-3.1.jar
2. jersey-client-1.17.1.jar
3. jersey-core-1.17.1.jar
4. jersey-server-1.17.1.jar
5. jersey-servlet-1.17.1.jar
6. jsr311-api-1.1.1.jar

• 在工程Java Resources -> src中创建“com.eviac.blog.restws”包，并在其中创建“UserInfo”类。

UserInfo.java

[java] view plain copy

 

1. package com.eviac.blog.restws;  
2. import javax.ws.rs.GET;  
3. import javax.ws.rs.Path;  
4. import javax.ws.rs.PathParam;  
5. import javax.ws.rs.Produces;  
6. import javax.ws.rs.core.MediaType;  
7. /** 
8.  *  
9.  * @author pavithra 
10.  *  
11.  */  
12.   
13. // 这里@Path定义了类的层次路径。  
14. // 指定了资源类提供服务的URI路径。  
15. @Path("UserInfoService")  
16. public class UserInfo {  
17.     // @GET表示方法会处理HTTP GET请求  
18.     @GET  
19.     // 这里@Path定义了类的层次路径。指定了资源类提供服务的URI路径。  
20.     @Path("/name/{i}")  
21.     // @Produces定义了资源类方法会生成的媒体类型。  
22.     @Produces(MediaType.TEXT_XML)  
23.     // @PathParam向@Path定义的表达式注入URI参数值。  
24.     public String userName(@PathParam("i")  
25.     String i) {  
26.         String name = i;  
27.         return "<User>" + "<Name>" + name + "</Name>" + "</User>";  
28.     }  
29.   
30.     @GET  
31.     @Path("/age/{j}")  
32.     @Produces(MediaType.TEXT_XML)  
33.     public String userAge(@PathParam("j")  
34.     int j) {  
35.         int age = j;  
36.         return "<User>" + "<Age>" + age + "</Age>" + "</User>";  
37.     }  
38. }  

最后把web.xml拷贝到WEB-INF目录下，web.xml内容为：

[html] view plain copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <web-app id="WebApp_ID" version="2.5"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.     xmlns="http://java.sun.com/xml/ns/javaee"  
5.     xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"  
6.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee">  
7.     <a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">  
8.         http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"  
9.     </a>  
10.   
11.     <display-name>RESTfulWS</display-name>  
12.     <servlet>  
13.         <servlet-name>Jersey REST Service</servlet-name>  
14.         <servlet-class>  
15.             com.sun.jersey.spi.container.servlet.ServletContainer  
16.         </servlet-class>  
17.         <init-param>  
18.             <param-name>  
19.                 com.sun.jersey.config.property.packages  
20.             </param-name>  
21.             <param-value>com.eviac.blog.restws</param-value>  
22.         </init-param>  
23.         <load-on-startup>1</load-on-startup>  
24.     </servlet>  
25.     <servlet-mapping>  
26.         <servlet-name>Jersey REST Service</servlet-name>  
27.         <url-pattern>/rest/*</url-pattern>  
28.     </servlet-mapping>  
29. </web-app>  

• 将此webservice-URL拷贝到浏览器地址栏中运行：

1. http://localhost:8080/RESTfulWS/rest/UserInfoService/name/Pavithra

输出结果如下：

二、再新建一个项目:RestTest，来创建客户端，使用上一个项目发布的webservice服务接口

• 首先创建一个独立新项目：RestTest （再次创建一个java project即可）。

• 这里同样需要Jersey框架的lib目录下的jar包。解压Jersey到“jersey-archive-1.17.1”文件夹，接着将里面lib文件夹下的jar文件拷贝到工程目录的WEB-INF -> lib或者将它们添加到build path。

1. asm-3.1.jar
2. jersey-client-1.17.1.jar
3. jersey-core-1.17.1.jar
4. jersey-server-1.17.1.jar
5. jersey-servlet-1.17.1.jar
6. jsr311-api-1.1.1.jar

• 创建一个“com.eviac.blog.restclient”包，然后新建“UserInfoClient”类。

UserInfoClient.java

[java] view plain copy

 

1. package com.eviac.blog.restclient;  
2.   
3. import javax.ws.rs.core.MediaType;  
4.   
5. import com.sun.jersey.api.client.Client;  
6. import com.sun.jersey.api.client.ClientResponse;  
7. import com.sun.jersey.api.client.WebResource;  
8. import com.sun.jersey.api.client.config.ClientConfig;  
9. import com.sun.jersey.api.client.config.DefaultClientConfig;  
10.   
11. /** 
12.  *  
13.  * @author pavithra 
14.  *  
15.  */  
16. public class UserInfoClient {  
17.   
18.     public static final String BASE_URI = "http://localhost:8080/RESTfulWS";  
19.     public static final String PATH_NAME = "/UserInfoService/name/";  
20.     public static final String PATH_AGE = "/UserInfoService/age/";  
21.   
22.     public static void main(String[] args) {  
23.   
24.         String name = "Pavithra";  
25.         int age = 25;  
26.   
27.         ClientConfig config = new DefaultClientConfig();  
28.         Client client = Client.create(config);  
29.         WebResource resource = client.resource(BASE_URI);  
30.   
31.         WebResource nameResource = resource.path("rest").path(PATH_NAME + name);  
32.         System.out.println("Client Response \n"  
33.                 + getClientResponse(nameResource));  
34.         System.out.println("Response \n" + getResponse(nameResource) + "\n\n");  
35.   
36.         WebResource ageResource = resource.path("rest").path(PATH_AGE + age);  
37.         System.out.println("Client Response \n"  
38.                 + getClientResponse(ageResource));  
39.         System.out.println("Response \n" + getResponse(ageResource));  
40.     }  
41.   
42.     /** 
43.      * 返回客户端请求。 例如： GET 
44.      * http://localhost:8080/RESTfulWS/rest/UserInfoService/name/Pavithra 
45.      * 返回请求结果状态“200 OK”。 
46.      *  
47.      * @param service 
48.      * @return 
49.      */  
50.     private static String getClientResponse(WebResource resource) {  
51.         return resource.accept(MediaType.TEXT_XML).get(ClientResponse.class)  
52.                 .toString();  
53.     }  
54.   
55.     /** 
56.      * 返回请求结果XML 例如：<User><Name>Pavithra</Name></User> 
57.      *  
58.      * @param service 
59.      * @return 
60.      */  
61.     private static String getResponse(WebResource resource) {  
62.         return resource.accept(MediaType.TEXT_XML).get(String.class);  
63.     }  
64. }  

• 运行客户端程序后，可以看到以下输出：

[plain] view plain copy

 

1. Client Response   
2. GET http://localhost:8080/RESTfulWS/rest/UserInfoService/name/Pavithra returned a response status of 200 OK  
3. Response   
4. <User><Name>Pavithra</Name></User>  
5.    
6. Client Response   
7. GET http://localhost:8080/RESTfulWS/rest/UserInfoService/age/25 returned a response status of 200 OK  
8. Response   
9. <User><Age>25</Age></User>  

试试吧 ：）

原文链接： eviac 翻译： ImportNew.com - 陈洁
译文链接： http://www.importnew.com/7336.html