Restful 接口傳遞參數

首先補充一下什麼是 Restful ,這裏簡單說一下,若是一個架構符合REST原則,就稱它爲RESTful架構。
RESTful架構特色:
  (1)每個URI表明一種資源;
  (2)客戶端和服務器之間,傳遞這種資源的某種表現層;

  (3)客戶端經過四個HTTP動詞,對服務器端資源進行操做,實現"表現層狀態轉化"。css

具體介紹參考:html

RESTful API 設計指南
json

RESTful架構簡介
api


一:沒有 對象類型 的多參數傳遞
服務器


@POST
@Path("/addFavor/")
void addFavor(@QueryParam("linkId") String linkId, @QueryParam("userId") List<String> userId,
            @QueryParam("favorTypeCode") String favorTypeCode, @QueryParam("linkTable") String linkTable);
restful


另外一種方式能夠經過 @PathParam 註解參數,這種方式要在 URL 地址後面聲明 如:/{id},多參:/{id}{aaa}{bbb}
@GET
@Path("/{id}")
@ApiMethod(path = "/api/rest/category/{id}", verb = ApiVerb.GET, description = "get category by id", produces = { MediaType.APPLICATION_JSON }, consumes = { MediaType.APPLICATION_JSON })
@ApiResponseObject
Category get(@ApiPathParam(name = "id", description = "The Category id") @PathParam("id") String id);
markdown


二:包含 對象類型 的多參傳遞架構

須要在對象前聲明 @ApiBodyObject框架


@POST
@Path("/addFavor/")
void addFavor(@QueryParam("linkId") String linkId, @ApiBodyObject User user,
            @QueryParam("favorTypeCode") String favorTypeCode, @QueryParam("linkTable") String linkTable);

@ApiBodyObject 至關於 SpringMVC 的 @RequestBody

參數註解的做用就是將 xml/json (具體那種看配置,cxf 是json) 轉換爲實體對象如 User 傳遞給實現方法,以下:

@Override
@Transactional(readOnly = false)
public void addFavor(String linkId, User user, String favorTypeCode, String linkTable) {

}

三:多 對象參數 傳遞
ide

Restful 僅支持多個參數中,最多隻能有一個是對象參數,就好比一個 Form 表單中只能提交一個對象

解決辦法:將多個對象參數封裝到一個大對象中,好比新建一個 VO 把這些對象參數都放進去,或者放到Map,List 這些也行


四:Jersey

上面的代碼基於 Jersey 框架實現,下面來講說 Jersey RESTful 的關係:

開發 RESTful WebService 意味着支持在多種媒體類型以及抽象底層的客戶端-服務器通訊細節,若是沒有一個好的工具包可用,這將是一個困難的任務
爲了簡化使用Java開發 RESTful WebService 及其客戶端,一個輕量級的標準被提出:JAX-RS API
Jersey RESTful WebService框架是一個開源的、產品級別的JAVA框架,支持JAX-RS API而且是一個JAX-RS(JSR 311和 JSR 339)的參考實現
Jersey不單單是一個JAX-RS的參考實現,Jersey提供本身的API,其API繼承自JAX-RS,提供更多的特性和功能以進一步簡化RESTful service和客戶端的開發


Reference

http://blog.csdn.net/aitcax/article/details/53097562

http://www.tuicool.com/articles/32yYvm

http://liugang594.iteye.com/blog/1496651

http://blog.csdn.net/bapinggaitianli/article/details/46518705

相關文章
相關標籤/搜索