RESTful Web 服务 - Java (JAX-RS)



JAX-RS 代表 JAVA API for RESTful Web Services。JAX-RS 是一个基于 JAVA 的编程语言 API 和规范,用于提供对创建 RESTful Web 服务的支持。其 2.0 版本于 2013 年 5 月 24 日发布。JAX-RS 使用 Java SE 5 中提供的注解来简化基于 JAVA 的 Web 服务创建和部署。它还提供对创建 RESTful Web 服务客户端的支持。

规范

以下是将资源映射为 Web 服务资源最常用的注解。

序号 注解 & 描述

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

资源的上下文。例如,HTTPRequest 作为上下文。

注意 - 我们在RESTful Web 服务 - 第一个应用程序RESTful Web 服务 - 方法章节中使用了 Jersey,它是 Oracle 的 JAX-RS 2.0 参考实现。

广告