rest注解说明及使用示例（java）

1.常用API介绍

1.1 javax.ws.rs包(用于创建RESTful服务资源的高级接口和注解)

1.1.1 统一接口

JAX-RS使用@javax.ws.rs.POST 、@javax.ws.rs.GET 、@javax.ws.rs.PUT、@javax.ws.rs.DELETE四个注解代表了对资源的CRUD(Create, Retrieve, Update, Delete)操作。

1.1.2 定位资源

注:下文中url中的root代表你的web应用的名称加上你在web.xml中servlet-mapping元素设置的路径。

@javax.ws.rs.ApplicationPath 标识应用路径，用于由@Path提供的所有资源uri的基本uri。当发布在一个servlet容器中，它的值可以使用web.xml中的servlet-mapping进行重写。

@javax.ws.rs.Path 标识要请求的资源类或类方法的uri路径。

@javax.ws.rs.PathParam 将uri中指定的路径参数绑定到资源方法参数，资源类的字段，或资源类的bean属性。
比如：

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserResource{

@GET

@Path("{userName}")

@Produces(MediaType.APPLICATION_JSON)

publicUsergetUser(@PathParam("userName")StringuserName){

...

}

}

当浏览器请求http://localhost:8080/root/user/boglond时，方法中userName值为boglond。

@javax.ws.rs.QueryParam 将http请求的Query参数绑定到资源方法参数，资源类的字段，或资源类的bean属性。

eg:

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserRecource{

@GET

@Path("/getUser")

@Produces(MediaType.APPLICATION_JSON)

publicUsergetUser(@QueryParam("userName")StringuserName,@QueryParam("age")intage){

...

}

}

当浏览器请求http://localhost:8080/root/user/getUser?userName=boglond&age=26时，方法中userName值为boglond，age值为26。

@javax.ws.rs.FormParam 将http请求的Form表单中的参数绑定到资源方法参数。

eg:

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserRecource{

@javax.ws.rs.POST

@Path("/insert")

@Consumes(MediaType.APPLICATION_FORM_URLENCODED)

publicStringinsertUser(@FormParam("userName")StringuserName,@FormParam("age")intage){

...

}

}

页面中的form表单如下

1

2

3

4

5

<formaction="/root/user/insert"method="post">

姓名:<inputname="userName"id="userName"type="text"value="boglond"/></br>

年龄:<inputname="age"id="age"type="text"value="26"/>

<buttontype="submit">提交</button>

</form>

提交表单后方法中userName值为boglond，age值为26。

@javax.ws.rs.CookieParam 将http cookie的值绑定到资源方法参数，资源类的字段，或资源类的bean属性。
eg:

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserRecource{

@GET

@Path("/getCookieParam")

@Produces(MediaType.APPLICATION_JSON)

publicStringgetCookieParam(@CookieParam("JSESSIONID")StringjsessionId){

...

}

}

当浏览器请求http://localhost:8080/root/user/getCookieParam时，方法中jsessionId值为”FFF7BDDC46579DBDDDEB3E94776A2623″,此值不是固定的,不同的浏览器有不同的值。

@javax.ws.rs.HeaderParam 将http header的值绑定到资源方法参数，资源类的字段，或资源类的bean属性。
eg:

1

2

3

4

5

6

7

8

9

10

@Path("/user")

public classUserRecource{

@GET

@Path("/getHeaderParam")

@Produces(MediaType.APPLICATION_JSON)

publicStringgetHeaderParam(@HeaderParam("Accept")Stringaccept,@HeaderParam("Accept-Language")

  StringacceptLang){

...

}

}

当浏览器请求http://localhost:8080/root/user/getHeaderParam时，方法中accept值为”text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8″，acceptLang值为”zh-CN,zh;q=0.8,en-US;q=0.5,en;q=0.3″，不同的浏览器，值有所不同。

@javax.ws.rs.MatrixParam 将uri矩阵参数的值绑定到资源方法参数，资源类的字段，或资源类的bean属性。
eg:

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserRecource{

@GET

@Path("/getUser")

@Produces(MediaType.APPLICATION_JSON)

publicUsergetUser(@MatrixParam("userName")StringuserName,@MatrixParam("age")intage){

...

}

}

当浏览器请求http://localhost:8080/root/user/getUser;userName=boglond;age=26时，方法中userName值为boglond，age值为26。

@javax.ws.rs.DefaultValue 设置 @PathParam, @QueryParam, @MatrixParam, @CookieParam, @FormParam, or @HeaderParam参数的默认值。如果它们没有接收到值，就使用默认值。

@javax.ws.rs.BeanParam 将请求中的bean绑定到资源方法参数，资源类的字段，或资源类的bean属性。

eg:

1

2

3

4

5

6

7

8

@javax.xml.bind.annotation.XmlRootElement

public classUserBean{

@FormParam("userName")

privateStringuserName;

@FormParam("age")

privateintage;

...

}

1

2

3

4

5

6

7

8

9

@Path("/user")

public classUserRecource{

@javax.ws.rs.POST

@Path("/insertUserBean")

@Consumes(MediaType.APPLICATION_FORM_URLENCODED)

publicStringinsertUserBean(@BeanParamUserBeanuserBean){

...

}

}

页面中的form表单如下:

1

2

3

4

5

<formaction="/root/user/insertUserBean"method="post">

姓名:<inputname="userName"id="userName"type="text"value="boglond"/></br>

年龄:<inputname="age"id="age"type="text"value="26"/>

<buttontype="submit">提交</button>

</form>

当提交表单后insertUserBean方法中的userBean对象的属性值会映射为表单中对应的值。

1.1.3 表述资源的数据格式(通过媒体类型表述)

@javax.ws.rs.Consumes 定义一个资源类的方法或MessageBodyReader能够接受的媒体类型。方法级别的@Consumes会覆盖类级别的@Consumes。(指定将要返回给client端的数据MIME类型)

@javax.ws.rs.Produces 定义一个资源类的方法或MessageBodyWriter能够产生的媒体类型。方法级别的@Produces会覆盖类级别的@Produces。(指定可以接受client发送过来的MIME类型)

eg:@Produces(“application/json”);指定多个MIME类型 @Produces({“application/json”,”application/xml”})
常见的媒体类型如

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

text/html：HTML格式

text/plain：纯文本格式

text/xml：XML格式(它会忽略xml头所指定编码格式而默认采用us-ascii编码)

image/gif：gif图片格式

image/jpeg：jpg图片格式

image/png：png图片格式

application/xhtml+xml：XHTML格式

application/xml：XML格式(它会根据xml头指定的编码格式来编码)

application/atom+xml：AtomXML聚合格式

application/json：JSON数据格式

application/pdf：pdf格式

application/msword：Word文档格式

application/octet-stream：二进制流数据（如常见的文件下载）

application/x-www-form-urlencoded：&lt;formencType=””&gt;中默认的encType，form表单数据被编码为key/value格式发送到服务器（表单默认的提交数据的格式）

multipart/form-data：需要在表单中进行文件上传时，就需要使用该格式。

媒体类型的常量值在javax.ws.rs.core.MediaType中。

1.1.4 编解码

@javax.ws.rs.Encoded 禁用由 @QueryParam, @PathParam, @FormParam or @MatrixParam绑定的参数值的自动解码
eg:

1

2

3

4

5

6

7

8

9

10

@Path("/user")

public classUserRecource{

@GET

@Path("/getUser")

@Produces(MediaType.APPLICATION_JSON)

publicUsergetUser(@MatrixParam("userName")StringuserName,

@MatrixParam("age")intage){

...

}

}

此时没有使用@Encoded
当浏览器请求http://localhost:8080/root/user/getUser;userName=boglond%5CD;age=26时,方法中userName值为boglond\D，age值为26。

当给方法参数加上@Encoded时,
浏览器请求http://localhost:8080/root/user/getUser;userName=boglond%5CD;age=26,方法中userName值为boglond%5CD，age值为26。

@Encoded可加在方法的上面禁用此方法所有参数的自动解码。

1.2 javax.ws.rs.client包(JAX-RS客户端API)

javax.ws.rs.client.WebTarget 由资源URI标识的资源目标。

javax.ws.rs.client.ClientBuilder 用于加载客户端实例的主入口点。

eg:使用 request() 函数来初始化一个请求并用后续的 post 或者get等方法来指定请求的类型。

1

2

Clientclient=ClientBuilder.newClient();

client.target(..).request().get();

通过 path() 和 resolveTemplate() 方法来处理动态的 URL 路径参数。

1

2

3

4

client.target(..).path(..).resolveTemplate(..);

javax.ws.rs.client.InvocationCallback&lt;RESPONSE&gt;可以实现从调用处理接收异步处理事件。

javax.ws.rs.client.ClientRequestFilter客户端请求过滤器。

javax.ws.rs.client.ClientResponseFilter客户端响应过滤器。

1.3 javax.ws.rs.container包(特定容器JAX-RS API )

@javax.ws.rs.container.ResourceContext 提供对资源类实例的访问,使用@javax.ws.rs.core.Context 注入。

eg:

1

2

3

publicStringgetResourceContext(@javax.ws.rs.core.ContextResourceContextresourceContext){

...

}

@javax.ws.rs.container.ContainerRequestContext 容器请求过滤器上下文。为过滤器提供特定于请求的信息的可变类，例如请求URI，消息头，消息实体或请求范围属性。暴露的setter方法允许修改暴露的请求特定信息。

@javax.ws.rs.container.ContainerResponseContext 容器响应过滤器上下文。为过滤器提供特定于响应的信息的可变类，例如消息头，消息实体或请求范围属性。暴露的setter方法允许修改暴露的响应特定信息。

1.4 javax.ws.rs.core包(用于创建RESTful服务资源的低级接口和注解)

@javax.ws.rs.core.MediaType 媒体类型常量类。
j

avax.ws.rs.core.Cookie 在请求中转移的HTTP Cookie的值。
eg:

1

2

Cookiec=newCookie(name,value);

javax.ws.rs.core.Form表示使用"application / x-www-form-urlencoded"媒体类型编码的HTML表单数据请求实体。

eg:

1

2

Formf=newForm();

f.param(name,value)

javax.ws.rs.core.Response.Status http所定义的响应状态码。

javax.ws.rs.core.HttpHeaders 一个可注入的接口，提供对HTTP头信息的访问。
eg:

1

2

3

4

5

6

@GET

@Path("/getHttpHeaders")

@Produces(MediaType.APPLICATION_JSON)

public StringgetHttpHeaders(@javax.ws.rs.core.ContextHttpHeadershttpHeaders){

...

}

@javax.ws.rs.core.UriInfo 一个可注入的接口，提供对应用程序和请求URI信息的访问。
eg:

1

2

3

4

5

6

@GET

@Path("/getUriInfo")

@Produces(MediaType.APPLICATION_JSON)

public StringgetUriInfo(@javax.ws.rs.core.ContextUriInfouriInfo){

...

}

@javax.ws.rs.core.Context 将信息注入类字段，bean属性或方法参数。如

1.5 javax.ws.rs.ext包(为JAX-RS API支持的类型提供扩展)

javax.ws.rs.ext.MessageBodyReader<T> 反序列化
javax.ws.rs.ext.MessageBodyWriter<T> 序列化

本文作者： 伯乐在线 - 求知者 。

来源：http://blog.jobbole.com/109031/