JAX-RS規范-常用注解淺析

1、@Path

  若希望1個Java類能夠處理REST要求，則這個類必須最少添加1個@Path("/")的annotation；

  對方法，這個annotation是可選的，如果不添加，則繼承類的定義。

（1）@Path里的值可以是1個復雜的表達式，例如@Path("{id}") ，其中 {id}表達式代碼了1個模板參數；

         1個模板參數是1個定義在@Path里的通配符，它以 { 開始，中間是1堆字母和數字的混合串（不能包括 / 字符），以 } 結尾。又如： @Path("{firstName}-{lastName}") .

（2）@Path也支持正則表達式，例如： @Path("{id: d+}") ，其中 d+ 表示1個數字。格式為： A : B

2、@Method

（1）1個方法上只有添加了某個Http Method的annotation，例如@GET，才有資格處理要求。

經常使用的HTTP動詞有下面5個（括號里是對應的SQL命令）。

• GET（SELECT）：從服務器取出資源（1項或多項）。
• POST（CREATE）：在服務器新建1個資源。
• PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完全資源）。
• PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。
• DELETE（DELETE）：從服務器刪除資源。

還有兩個不經常使用的HTTP動詞。

• HEAD：獲得資源的元數據。
• OPTIONS：獲得信息，關于資源的哪些屬性是客戶端可以改變的。

下面是1些例子。

• GET /zoos：列出所有動物園
• POST /zoos：新建1個動物園
• GET /zoos/ID：獲得某個指定動物園的信息
• PUT /zoos/ID：更新某個指定動物園的信息（提供該動物園的全部信息）
• PATCH /zoos/ID：更新某個指定動物園的信息（提供該動物園的部份信息）
• DELETE /zoos/ID：刪除某個動物園
• GET /zoos/ID/animals：列出某個指定動物園的所有動物
• DELETE /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

3：Accept和Content-Type的區分

4：@Produces 表示類或方法返回的MIME數據類型。

        有幾種格式以下：

（1）@Produces("text/plain") 文本類型

（2）@Produces("text/html")  Html類型

（3）@Produces({"application/xml"}) Xml類型

        （4）@Produces({ "application/json"}) Json類型

       可以1次注解兩種或多種的MIME類型，格式如：{"application/xml", "application/json"}這表示二者都可使用，但是選擇的時候1般會選擇前者，即application/xml,由于它第1次出現。

5：@Consumes 代表的是1個資源可以接受的 MIME 類型。

6：@Queryparam與@Pathparam區分

@Queryparam：指定的是URL中的參數是以鍵值對的情勢出現的,而在程序中 @QueryParam("from")  int from則讀出URL中from的值, 

例如：URL輸入為:users?from=100&to=200&orderBy=age&orderBy=name 

@Pathparam：URL中只出現參數的值,不出現鍵值對

例如： /users/100 

生活不易，碼農辛苦
如果您覺得本網站對您的學習有所幫助,可以手機掃描二維碼進行捐贈