Spring的@RequestParam物件繫結方式
目錄
- Spring @RequestParam物件繫結
- 解決方案
- 在POJO中對請求引數進行校驗
- SpringMvc引數繫結自定義物件
- on提交
- form提交
- 小結一下
Spring @RequestParam物件繫結
在Spring中,如果在方法引數列表中使用@RequestParam標註多個引數,會讓對映方法的可讀性大大降低。
如果對映請求的引數只有一兩個的話,使用@RequestParahttp://www.cppcns.comm會非常直觀,但是如果引數列表越來越長,就很容易暈菜。
解決方案
可以直接使用ParameterObject模式來處理【注:ParameterObject就是把引數組裝成物件】。
如果要傳參對操作,則引數對應資料庫中的某些欄位,此時表對應的entity物件可以直接作為ParameterObject。
其他情況下則可以使用一個POJO來包裝這些引數,這個POJO本身沒有要求額外的註解,但是POJO本身必須包含和請求引數完全匹配的欄位,標準的setter/getter,和一個無參的構造器:
class ProductCriteria {
private String query;
SURGVJgPOprivate int offset;
private int limit;
ProductCriteria() {
}
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
// other getters/setters
}
@GetMapping
List<Product> searchProducts(ProductCriteria productCriteria) {
return productRepository.search(productCriteria);
}
在POJO中對請求引數進行校驗
雖然上面的案例已經可以正常使用,但是我們知道,使用@RequestParam註解,不僅僅只是為了繫結請求引數,一個非常重要的功能是,我們可以對繫結的引數請求驗證,比如引數是否必要,如果請求中缺少該引數,則我們的服務端可以拒絕該請求。
想為我們的POJO中的欄位新增驗證規則。如果想模仿@RequestParam(required = false)的表現,可以使用@NotSURGVJgPONull註解在對應的欄位上即可。
在更多的情況下,我們一般使用@NotBlank多於@NotNull,因為@NotBlank考慮了空字串的情況。
final class ProductCriteria { @NotBlank private String query; @Min(0) private int offset; @Min(1) private int limi; // ... }
這裡務必注意一點:
僅僅只是在物件的欄位上新增驗證註解是不夠的。
一定要在controller的方法引數裡誒包中,在POJO對應的引數前加上@Valid註解。該註解會讓Spring在繫結引數前執行校驗動作。
@GetMapping List<Product> searchProducts(@Valid ProductCriteria productCriteria) { // ... }
@RequestParam註解的另一個非常有用的功能就是設定引數的預設值。
如果我們使用POJO的方式來繫結引數,只需要在定義引數的時候設定好欄位的預設值就行了。如果請求中沒有該引數,Spring不會把引數的預設值覆蓋為null的。
SpringMvc引數繫結自定義物件
springmvc我們經常在寫controller一般都接受兩種方式,一種是form提交,一種是json提交,下面就來介紹如何在這兩種方式中將提交的資料自動繫結到自定義物件中。
json提交
這個比較簡單,在網上搜一下一大把,這裡就簡單放一段程式碼:
@RequestMapping("/testjson") public String testjson(@RequestBody User user){ return "ok"; }
form提交
這個是比較頭疼的,一般form有很多的引數,我們可以像下面這樣寫:
@RequestMapping("/test") public String testParam(@RequestParam(name = "name") String name,@RequestParam(name = "sex") String sex) { return name + sex; }
但是如果我改成下面這樣會怎麼樣?然後用form提交引數 name=zack & sex=boy
@RequestMapping("/test") public String test(@RequestParam(name = "user") User user) { return user.getName(); }
結果是報錯:
{
"timestamp": "2018-05-29T11:58:37.450+0000",
"status": 400,
"error": "Bad Request",
"message": "Required User parameter 'user' is not present",
"path": "/test1"
}
我的引數裡確實是沒有user這個,其實我的原本目的是想讓spring把我傳遞的name和sex熟悉拼裝好生成一個user物件,因為剛好user物件就有這2個屬性,spring可沒有智慧。那該怎麼辦?
這個時候引入WebDataBinder,在你的controller里加上下面的程式碼:
@InitBinder
protected void initBinder(WebDataBinder binder) {
binder.registerCustomEditor(User.class,new UserFormatEditor());
}
public static class UserFormatEditor extends PropertiesEditor {
@Override
public void setAsText(String text) throws IllegalArgumentException {
setValue(JSONObject.parseObject(text,User.class));
}
@Override
puhttp://www.cppcns.comblic String getAsText() {
return getValue().toString();
}
}
然後在請求時將引數改為 user = {"name":"zack","sex":"boy"} ,之後就成功的獲取User物件,WebDataBinder幫我們告訴了spring,如果遇到了一個字串引數要被包裝成User.class,用我們自定義的UserFormatEditor就行。
小結一下
作為規範而言,form提交的方式本身就需要我們一個一個屬性的接收,而不能用一個物件統一接收,如果你想用一個物件統一接收,請採用json的方式提交。
以上為個人經驗,希望能給大家一個參考,也希望大家多多支援我們。