Spring RestController 請求參數詳解

引用作者jpfss
在閱讀之前，最好先了解http請求的get,post,以及各種head頭類型，請求參數類型。

無參數，設置RestController請求路徑
查詢字符串參數，可選和必選參數
json參數，RestController用實體類型接受
路徑參數
body參數
文件流參數

1 無參數，設置RestController請求路徑

下面是一個例子，例子無請求參數，通過@RequestMapping設置了請求的路由路徑和請求方法。路由路由由類的mapping和方法的mapping組成，在后面的例子中，我就不再寫出RestApiRequestDemoController類的mapping了。記住，url里面有個demo在前面。

@RestController
@RequestMapping("/demo")
public class RestApiRequestDemoController {

    ///方法說明: 普通查詢
    ///示例請求：http://localhost:8091/demo/list
    @RequestMapping(value="/searchList",method = RequestMethod.POST)
    @ResponseBody
    public List<UserModel> searchList() {
        List list = new list();
        return list;
    }
}

2 查詢字符串參數，可選和必選參數2. 查詢字符串參數，可選和必選參數

下面是使用查詢字符串的例子，required可以設置請求的字符串是否必填

///方法說明：url參數的使用-查詢字符串 ,且name必填
///示例請求：http://localhost:8091/demo/searchListByName?name=liuyanwei
@RequestMapping(value="/listByName",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@RequestParam(value="name",required = true) String name) {

    Session context = DatabaseHelper.context();
    String sql = "select * from tb_user where name ='"+ name+"'" ;
    List list = context.createSQLQuery(sql)
            .setResultTransformer(Transformers.aliasToBean(TbUserModel.class))
            .list();
    return list;

}

3 json參數，RestController用實體類型接受

注意，需要設置application/json 否則數據庫會返回。hibernate操作數據庫代碼暫時可以不用去管他。

/*
* 方法說明：添加數據
* 1:使用json數據提交，直接使用實體對象接收
* 2:hibernate 添加數據
* 請求參數： {"id":1,"userId":1,"pwd":"123","name":"123","pwd":"123","headPortait":"123","isEnable":"123","createDate":"2015-05-12","lastLogin":"2015-05-12"}
* 請求頭：Content-Type : application/json
* 請求ur：http://localhost:8091/demo/addUser
* */
@RequestMapping(value="/addUser",method = RequestMethod.POST)
@ResponseBody
public TbUserModel addUser(@RequestBody TbUserModel user) {

    Session context = DatabaseHelper.context();
    Transaction tran = context.beginTransaction();
    context.save(user);
    tran.commit();
    user.setId(user.getId());
    context.close();
    return user;
}

4 路徑參數

路徑參數不能設置是否必填，全部都是必須填，不能省略的

///方法說明：url參數的使用
///示例請求：http://localhost:8091/demo/searchListById/2
@RequestMapping(value="/searchListById/{id}",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@PathVariable("id") int id) {

     Session context = DatabaseHelper.context();
    //        String sql = "select * from tb_user where id ="+ id ;
     String sql = "select * from tb_user where tb_user.id = :id";
     System.out.println(sql);
     List list = context.createSQLQuery(sql).setInteger("id", id)
             .setResultTransformer(Transformers.aliasToBean(TbUserModel.class))
             .list();
     return list;
}

高級用法：路徑參數可以自由設置自己的規則，比如，你有個請求需要兩個參數，月和日，你可以寫成{month}-{day}

///方法說明：url參數的使用
///示例請求：http://localhost:8091/demo/searchListByDate/2-10
@RequestMapping(value="/searchListByDate/{month}-{day}",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@PathVariable("month") int month,
                                    @PathVariable("day") int day) {

}

5. 表單參數參數

注意，

這種方式傳參數不能設置參數選填
注意，參數寫在boby中，相當於表單參數，必須設置請求頭為：application/x-www-form-urlencoded
若參數不正確，是無法進入控制器的。

    /*
    * 方法說明：使用表單方式提交數據
    * 請求參數:isEnable=1&name=cool
    * 配置
    * 請求頭：Content-Type : application/x-www-form-urlencoded
    * 請求url：http://localhost:8091/demo/findUsersByName
    * */
    @RequestMapping(value="/findUsersByName",method = RequestMethod.POST)
    @ResponseBody
    public void findUsersByName(boolean isEnable , String name)
    {
        System.out.println(isEnable);
        System.out.println(name);
    }

6. 文件流參數

單個文件通過這種方式 @RequestParam(“file”) MultipartFile file獲得，這里是簡單的寫法,相當於 MultipartFile file = ((MultipartHttpServletRequest) request).getFile(“file”); 多個文件使用@RequestParam(“files”) MultipartFile[] files)

表單中文件的name屬性必須設置file（注意，不是文件名），例如，html中
這個是簡單獲取文件的方式，若不知道表單中文件的name屬性,可以通過request獲取文件
例子：

@RequestMapping("upload")
public Resp upload(HttpServletRequest request,
                   HttpServletResponse response, @RequestParam("file") MultipartFile file){

    try {
        //MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
        String filePath = FilesService.uploadFile(file, request);
        return Resp.succeedResp(filePath);
    }
    catch (Exception e){
        e.printStackTrace();
    }

    return Resp.failureResp("圖片上傳失敗");
}


@RequestMapping("batchUpload")
public Resp batchUpload(HttpServletRequest request,
                   HttpServletResponse response,
                   @RequestParam("files") MultipartFile[] files) throws IOException {
    List<String> list = new ArrayList<String>();
    try {
        for (MultipartFile file :files) {
            String filePath = FilesService.uploadFile(file, request);
            list.add(filePath);
            System.out.println("filePath:" + filePath);
        }
        return Resp.succeedResp(list);
    }
    catch (Exception e){
        e.printStackTrace();
    }
    return  Resp.failureResp("文件上傳失敗");
}

總結
想要把Rest風格的api用好，合理利用參數是必須的。不同功能的api使用不同類型的參數接收方式。每個人有不同的習慣，我的習慣是：

一般獲取內容，不涉及加密的用get方法，設計加密的用post
提交內容，例如添加，刪除，修改，使用post、delete、put方法
通過主鍵獲取內容的，我習慣用url參數，例如:/news/details/1,參數不是很多，組合起來有意義的也會用url路徑組合，例如前面的日期:/demo/searchListByDate/2-10
有時候接收參數組合起來用比較好，有的內容通過url參數，有的部分用表單內容。
所有的設計接收參數的原則就是，然你的api的url能讀通，看起來合理。
好了，就到這了，后面有時間我會再寫一些hibernate 數據操作的例子和hibernate獲取實體參數驗證的內容，有的問題我也還沒完全搞清楚，后面在研究看看。