JAX-RS 表示用于 RESTful Web 服務(wù)的 Java API。JAX-RS 是一種基于 Java 的編程語言 API 以及為創(chuàng)建 RESTful Web 服務(wù)提供支持的規(guī)范。2.0 版本發(fā)布于 2013 年 5 月 24 日。從 Java SE 5 開始大量使用 JAX-RS 注釋以簡化基于 Java 的 Web 服務(wù)的創(chuàng)建和部署。它還為創(chuàng)建 RESTful Web 服務(wù)客戶端提供支持。
以下是影射某個資源為 Web 服務(wù)資源的常用注釋:
編號 | 注釋 & 描述 |
---|---|
1 |
@Path
資源類或方法的相對路徑。 |
2 |
@GET
HTTP Get 請求,用來提取資源。 |
3 |
@PUT
HTTP PUT 請求,用來創(chuàng)建資源。 |
4 |
@POST
HTTP POST 請求,用來創(chuàng)建或更新資源。 |
5 |
@DELETE
HTTP DELETE 請求,用來刪除資源。 |
6 |
@HEAD
HTTP HEAD 請求,用來獲取方法可用的狀態(tài)。 |
7 |
@Produces
由 Web 服務(wù)生成的 HTTP 響應(yīng),比如 APPLICATION/XML,TEXT/HTML,APPLICATION/JSON 等。 |
8 |
@Consumes
HTTP 請求類型,比如 application/x-www-form-urlencoded 在 POST 請求期間在 HTTP 體中接受表單數(shù)據(jù)。 |
9 |
@PathParam
綁定傳遞給方法的參數(shù)為路徑中的某個值。 |
10 |
@QueryParam
綁定傳遞給方法參數(shù)為路徑中的某個查詢參數(shù)。 |
11 |
@MatrixParam
綁定傳遞給方法參數(shù)為路徑中的某個 HTTP 矩陣參數(shù)。 |
12 |
@HeaderParam
綁定傳遞給方法的參數(shù)為 HTTP 頭。 |
13 |
@CookieParam
綁定傳遞給方法的參數(shù)為某個 Cookie。 |
14 |
@FormParam
綁定傳遞給方法的參數(shù)為某個表單值。 |
15 |
@DefaultValue
給傳遞給方法的參數(shù)分配一個默認(rèn)值。 |
16 |
@Context
資源上下文,比如將 HTTP 請求作為上下文。 |
在 RESTful Web 服務(wù) - 第一個應(yīng)用 和 RESTful Web 服務(wù) - 方法 教程中我們使用的 Jersey,它是 Oracle 的 JAX-RS 2.0 的參考實(shí)現(xiàn)。