程序博客网 > wifi无网络连接感叹号

使用Jersey创建RESTful服务

来源：互联网 发布：wifi无网络连接感叹号 编辑：程序博客网 时间：2024/06/04 18:36


REST基础概念

首先REST是Representational State Transfer的缩写，如果一个架构符合REST原则，它就是RESTful架构。
在REST中的一切都被认为是一种资源。所谓”资源”，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。
所谓”上网”，就是与互联网上一系列的”资源”互动，调用它的URI。

我们把”资源”具体呈现出来的形式，叫做它的表现层（Representation）。
比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。
URI只代表资源的实体，不代表它的形式。URI只代表资源的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对”表现层”的描述。
客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。
互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生状态转化（State Transfer）。而这种转化是建立在表现层之上的，所以就是表现层状态转化。
客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

Jersey RESTful

Jersey RESTful 框架是开源的RESTful框架, 实现了JAX-RS 规范。它扩展了JAX-RS 参考实现， 提供了更多的特性和工具， 可以进一步地简化 RESTful service 和 client 开发。
尽管相对年轻，它已经是一个产品级的RESTful service和client框架。
有关Jersey文档请点击Jersey文档
下面介绍使用Maven与Jersey编写一个简单的RestFul服务的栗子。

在intellij中创建RestFul栗子

加入Maven包依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<dependency>
   <groupId>com.sun.jersey</groupId>
   <artifactId>jersey-core</artifactId>
   <version>1.3</version>
 </dependency>
 <dependency>
   <groupId>com.sun.jersey</groupId>
   <artifactId>jersey-server</artifactId>
   <version>1.3</version>
 </dependency>
 <dependency>
   <groupId>com.sun.jersey</groupId>
   <artifactId>jersey-client</artifactId>
   <version>1.3</version>
 </dependency>
 <dependency>
   <groupId>log4j</groupId>
   <artifactId>log4j</artifactId>
   <version>1.2.14</version>
 </dependency>
 <dependency>
   <groupId>javax.ws.rs</groupId>
   <artifactId>jsr311-api</artifactId>
   <version>1.1.1</version>
 </dependency>
 <dependency>
   <groupId>asm</groupId>
   <artifactId>asm</artifactId>
   <version>3.2</version>
 </dependency>

在Web.xml文件中定义Servlet调度程序

定义一个初始化参数，指示包含资源的Java包，我把Resource都放在了com.zeusjava.resource里了,所有的资源通过http://localhost:8081/jersey/api/来访问

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<display-name>JerseyRestFul</display-name>
<servlet>
    <servlet-name>JerseyRestFul</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>com.sun.jersey.config.property.packages</param-name>
        <param-value>com.zeusjava.resource</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>JerseyRestFul</servlet-name>
    <url-pattern>/api/*</url-pattern>
</servlet-mapping>
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

创建资源文件

资源是Rest中最重要的部分，可以通过Http的方法 GET、POST、PUT 和DELETE等对资源进行增删改查，下面创建的UserResource中实现了对User的增删改查，用户存储在UserCache的一个Map中，在JAX-RX中，资源通过POJO实现，使用@Path 注释组成其标识符。资源可以有子资源。在这种情况下，父资源是资源集合，子资源是成员资源。

增加一个User

注解@Path("/users")将UserResource暴露为一个Rest服务，注解@POST将HTTP方法映射到资源的 让POST方法变成创建方法。

  1. @Consumes：声明该方法使用 HTML FORM即表单输入。
  2. @FormParam：注入该方法的 HTML 属性确定的表单输入。
  3. @Response.created(uri).build()： 构建新的 URI 用于新创建的User（/users/{id}）并设置响应代码（201/created）。您可以使用 http://localhost:8081/jersey/api/users/ 访问新用户。
  4. @Produces：限定响应内容的MIME类型。MIME类型有很多种，XML和JSON是常用的两种
  5. @Context： 使用该注释注入上下文对象，比如 Request、Response、UriInfo、ServletContext 等。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@Path("/users")
public class UserResource {
    @Context
    UriInfo uriInfo;
  /**
     * 增加用户
     * @param userId
     * @param userName
     * @param userAge
     * @param servletResponse
     * @throws IOException
     */
    @POST
    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
    public void newUser(
            @FormParam("userId") String userId,
            @FormParam("userName") String userName,
            @FormParam("userAge") int userAge,
            @Context HttpServletResponse servletResponse
    ) throws IOException {
        User user = new User(userId,userName,userAge);
        UserCache.getUserCache().put(userId,user);
        URI uri = uriInfo.getAbsolutePathBuilder().path(userId).build();
        Response.created(uri).build();
    }
}

删除用户

@DELETE将Http Delete请求绑定到删除用户（资源）操作上
@PathParam该注释将参数注入方法参数的路径

1
2
3
4
5
6
7
@DELETE
   @Path("/{id}")
   public void deleteContact(@PathParam("id") String id) {
       User user = UserCache.getUserCache().remove(id);
       if(user==null)
           throw new NotFoundException("No such User.");
   }

更新用户

根据用户的Id来更新一个用户（资源）。
Consume XML：putContact() 方法接受 APPLICATION/XML 请求类型，而这种输入 XML 将使用 JAXB 绑定到 User 对象。
PUT 请求的响应没有任何内容，但是有不同的状态码。如果Cache中存在联系人，我将更新该User并返回 204/no content。如果没有User，我将创建一个并返回 201/created。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/**
 * 更新用户
 * @param jaxbContact
 * @return
 */
@PUT
@Path("/{id}")
@Consumes(MediaType.APPLICATION_XML)
public Response putUser(JAXBElement<User> jaxbContact,@PathParam("id") String id) {
    User user = jaxbContact.getValue();
    Response res;
    if(UserCache.getUserCache().containsKey(id)) {
        res = Response.noContent().build();
    } else {
        res = Response.created(uriInfo.getAbsolutePath()).build();
    }
    UserCache.getUserCache().put(user.getUserId(), user);
    return res;
}

查找用户

根据传入的id查找用户，如果没有用户则抛出异常。
返回类型为MediaType.APPLICATION_XML需要在JavaBean中设置@XmlRootElement注解。

1
2
3
4
5
6
7
8
9
10
11
@GET
 @Path("/{id}")
 @Produces(MediaType.APPLICATION_XML)
 public User getUser(@PathParam("id") String id) {
     User user = UserCache.getUserCache().get(id);
     if(user==null){
         throw new NotFoundException("No such User.");
     }
     return user;
 }

User实体类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package com.zeusjava.entity;
import javax.xml.bind.annotation.XmlRootElement;
/**
 * Created By IntelliJ IDEA.
 * User: LittleXuan
 * Date: 2015/11/18.
 * Time: 17:05
 * Desc: User实体类
 */
@XmlRootElement
public class User {
    private String userId;
    private String userName;
    private int userAge;
    public User(){
    }
    public User(String userId, String userName, int userAge) {
        this.userId = userId;
        this.userName = userName;
        this.userAge = userAge;
    }
   //getter&setter
 
}

User缓存类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package com.zeusjava.cache;
import com.zeusjava.entity.User;
import java.util.HashMap;
import java.util.Map;
/**
 * Created By IntelliJ IDEA.
 * User: LittleXuan
 * Date: 2015/11/19.
 * Time: 9:17
 * Desc: UserCache 存储用户
 */
public class UserCache {
    private static Map<String,User> userCache;
    private static UserCache instance = null;
    private UserCache() {
        userCache = new HashMap<String,User>();
        initOneUser();
    }
    public static Map<String,User> getUserCache() {
        if(instance==null) {
            instance = new UserCache();
        }
        return userCache;
    }
    private static void initOneUser() {
        User user = new User("001","zhaohongxuan",24);
        userCache.put(user.getUserId(),user);
    }
}

创建Client测试

测试代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.zeusjava.client;
import javax.ws.rs.core.MediaType;
import javax.xml.bind.JAXBElement;
import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.GenericType;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.representation.Form;
import com.zeusjava.entity.User;
import org.junit.Test;
public class UserClient {
private WebResource r = null;
@Test
public void insertUser(){
r = Client.create().resource("http://localhost:8081/jersey/api/users");
Form form = new Form();
form.add("userId", "002");
form.add("userName", "ZhaoHongXuan");
form.add("userAge", 23);
ClientResponse response = r.type(MediaType.APPLICATION_FORM_URLENCODED)
.post(ClientResponse.class, form);
System.out.println(response.getStatus());
}
@Test
public void findUser(){
r = Client.create().resource("http://localhost:8081/jersey/api/users/002");
String jsonRes = r.accept(MediaType.APPLICATION_XML).get(String.class);
System.out.println(jsonRes);
}
@Test
public void updateUser(){
r = Client.create().resource("http://localhost:8081/jersey/api/users");
User user = new User("002","ZhaoXiaoXuan",24);
ClientResponse response = r.path(user.getUserId()).accept(MediaType.APPLICATION_XML)
.put(ClientResponse.class, user);
System.out.println(response.getStatus());
}
@Test
public void deleteUser(){
r = Client.create().resource("http://localhost:8081/jersey/api/users");
GenericType<JAXBElement<User>> generic = new GenericType<JAXBElement<User>>() {};
JAXBElement<User> jaxbContact = r
.path("002")
.type(MediaType.APPLICATION_XML)
.get(generic);
User user = jaxbContact.getValue();
System.out.println(user.getUserId() + ": " + user.getUserName());
ClientResponse response = r.path("002").delete(ClientResponse.class);
System.out.println(response.getStatus());
}
}

测试程序

服务器使用tomcat启动（本步略）
1.首先运行insertUserTest方法添加一个用户
返回响应码201表示创建成功。
2.运行findUser查询id为002的用户

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><user><userAge>23</userAge><userId>002</userId><userName>ZhaoHongXuan</userName></user>

服务器响应的是我们刚才添加的用户
3.运行updateUser更新用户名为ZhaoXiaoXuan,年龄为24
返回响应码为204表示更新成功
再次查询id为002的用户

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><user><userAge>24</userAge><userId>002</userId><userName>ZhaoXiaoXuan</userName></user>用户名称和年龄已经更改为`ZhaoxiaoXuan`和`24`

4.运行deleteUser删除用户

结果如下：

002: ZhaoXiaoXuan204

表示删除成功
再次运行查询，则服务器报404错误，说明该用户已经被删除。

GET http://localhost:8081/jersey/api/users/002 returned a response status of 404

完整的使用Jersey创建服务的代码地址为：JerseyRestFul

0 0
wifi无网络连接感叹号 wifi无网络连接感叹号
原创粉丝点击
热门IT博客
北京淘宝培训班多少钱北京淘宝培训班多少钱
办公软件2007教程办公软件2007教程
四川城市职业学院网络
淘宝虚假交易5单怎么办
js控制视频播放
ubuntu改变系统语言
道长脸型数据
微信的钱怎么转到淘宝
江西省网络广播电视台
淘宝联系卖家客服不回
腾讯手游助手没有网络
不实名域名注册商
淘宝店铺代运营方案
kmeans算法k值确定
ubuntu root 权限不够
淘宝二手转卖
截图软件免费下载
中国象棋人机对战 知乎
qq飞车刀锋杀手数据
网络歌曲视频大全
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 蓝卡断桥铝门窗 蓝卡断桥铝门窗怎么样 小蓝卡app 小蓝卡 蓝卡医疗 lanka 蓝印 蓝印户口 蓝叠 蓝叠中国 蓝叶 二胎是个奢侈品 蓝叶 蓝吕洗发水怎么样 蓝图 蓝图影视 蓝图影院 蓝图工作台 服务蓝图 蓝图机价格 蓝图纸 扑克蓝图 施工蓝图 蓝图打印 建筑蓝图 未来蓝图 美好蓝图 什么蓝图 米蓝图 平面蓝图 蓝图打印机 硫酸纸 蓝图 画蓝图 蓝图怎么样 晒工程蓝图 汇蓝图 未来的蓝图 什么是蓝图 明日之后蓝图 蓝图是什么意思 明日之后蓝图怎么用 明日之后蓝图变现

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里