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 參考實現。

廣告