jersey 注解类型

淡淡的烟草味﹌ 2022-05-08 10:36 204阅读 0赞

HTTP Methods

HTTP方法映射到资源的CRUD（创建、读取、更新和删除）操作，基本模式如下：

*  HTTP *GET*：读取/列出/检索单个或资源集合。
 *  HTTP *POST*：新建资源。
 *  HTTP *PUT*：更新现有资源或资源集合。
 *  HTTP *DELETE*：删除资源或资源集合。

# 1.@Produces #

`@Produces`注释用来指定将要返回给client端的数据标识类型（MIME）。`@Produces`可以作为class注释，也可以作为方法注释，方法的`@Produces`注释将会覆盖class的注释。

a.返回给client字符串类型（text/plain）

@Produces(MediaType.TEXT_PLAIN)

b.返回给client为json类型（application/json）

@Produces(MediaType.APPLICATION_JSON)

# 2.@Consumes #

`@Consumes`与`@Produces`相反，用来指定可以接受client发送过来的MIME类型，同样可以用于class或者method，也可以指定多个MIME类型，一般用于`@PUT`，@POST

a.接受client参数为字符串类型

@Consumes(MediaType.TEXT_PLAIN)

b.接受clent参数为json类型

@Consumes(MediaType.APPLICATION_JSON)

# 3.请求参数注解 #

@PathParam

获取url中指定参数名称：

1.  `@GET`
2.  `@Path("{username"})`
3.  `@Produces(MediaType.APPLICATION_JSON)`
4.  `public User getUser(@PathParam("username") String userName) {`
5.  `...`
6.  `}`

请求url:http://localhost/user/jack时，userName值为jack @QueryParam

获取get请求中的查询参数：

1.  `@GET`
2.  `@Path("/user")`
3.  `@Produces("text/plain")`
4.  `public User getUser(@QueryParam("name") String name,`
5.  `@QueryParam("age") int age) {`
6.  `...`
7.  `}`

当浏览器请求http://host:port/user?name=rose&age=25时，name值为rose，age值为25。如果需要为参数设置默认值，可以使用`@DefaultValue`，如：

1.  `@GET`
2.  `@Path("/user")`
3.  `@Produces("text/plain")`
4.  `public User getUser(@QueryParam("name") String name,`
5.  `@DefaultValue("26") @QueryParam("age") int age) {`
6.  `...`
7.  `}`

@FormParam

获取post请求中表单中的数据：

1.  `@POST`
2.  `@Consumes("application/x-www-form-urlencoded")`
3.  `public void post(@FormParam("name") String name) {`
4.  `// Store the message`
5.  `}`

@BeanParam

获取请求参数中的数据，用实体Bean进行封装：

1.  `@POST`
2.  `@Consumes("application/x-www-form-urlencoded")`
3.  `public void update(@BeanParam User user) {`
4.  `// Store the user data`
5.  `}`

` `