RESTful Web Services – Java (JAX-RS)
JAX-RS 代表Java API for RESTful Web Services。 JAX-RS是一个基于JAVA的编程语言API和规范,用于提供创建RESTful Web Services的支持。它的2.0版本于2013年5月24日发布。 JAX-RS使用来自Java SE 5的注释来简化基于JAVA的Web服务的创建和部署。它还支持创建RESTful Web Services的客户端。
规范
以下是最常用的将资源映射为Web服务资源的注释。
Sr.No. | 注释及说明 |
---|---|
1 | @Path 资源类/方法的相对路径。 |
2 | @GET HTTP GET请求,用于获取资源。 |
3 | @PUT HTTP PUT请求,用于更新资源。 |
4 | @POST HTTP POST请求,用于创建新资源。 |
5 | @DELETE HTTP DELETE请求,用于删除资源。 |
6 | @HEAD HTTP HEAD请求,用于获取方法可用性的状态。 |
7 | @Produces 说明Web服务生成的HTTP响应。例如,APPLICATION/XML,TEXT/HTML,APPLICATION/JSON等。 |
8 | @Consumes 说明HTTP请求类型。例如,application/x-www-formurlencoded在POST请求期间接受HTTP正文中的表单数据。 |
9 | @PathParam 将传递给方法的参数绑定到路径中的值。 |
10 | @QueryParam 将传递给方法的参数绑定到路径中的查询参数。 |
11 | @MatrixParam 将传递给方法的参数绑定到路径中的HTTP矩阵参数。 |
12 | @HeaderParam 将传递给方法的参数绑定到HTTP头。 |
13 | @CookieParam 将传递给方法的参数绑定到Cookie。 |
14 | @FormParam 将传递给方法的参数绑定到表单值。 |
15 | @DefaultValue 将默认值赋给传递给方法的参数。 |
16 | @Context 资源的上下文。例如,将HttpServletRequest作为上下文。 |
注意: 我们在“RESTful Web Services – First Application”章节和“RESTful Web Services – Methods”章节中使用了Oracle的JAX-RS 2.0的参考实现Jersey。