Spring的@RequestParam對象綁定方式
Spring @RequestParam對象綁定
在Spring中,如果在方法參數(shù)列表中使用@RequestParam標(biāo)注多個參數(shù),會讓映射方法的可讀性大大降低。
如果映射請求的參數(shù)只有一兩個的話,使用@RequestParam會非常直觀,但是如果參數(shù)列表越來越長,就很容易暈菜。
解決方案
可以直接使用ParameterObject模式來處理【注:ParameterObject就是把參數(shù)組裝成對象】。
如果要傳參對數(shù)據(jù)庫操作,則參數(shù)對應(yīng)數(shù)據(jù)庫中的某些字段,此時表對應(yīng)的entity對象可以直接作為ParameterObject。
其他情況下則可以使用一個POJO來包裝這些參數(shù),這個POJO本身沒有要求額外的注解,但是POJO本身必須包含和請求參數(shù)完全匹配的字段,標(biāo)準(zhǔn)的setter/getter,和一個無參的構(gòu)造器:
class ProductCriteria { private String query; private 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中對請求參數(shù)進行校驗
雖然上面的案例已經(jīng)可以正常使用,但是我們知道,使用@RequestParam注解,不僅僅只是為了綁定請求參數(shù),一個非常重要的功能是,我們可以對綁定的參數(shù)請求驗證,比如參數(shù)是否必要,如果請求中缺少該參數(shù),則我們的服務(wù)端可以拒絕該請求。
想為我們的POJO中的字段添加驗證規(guī)則。如果想模仿@RequestParam(required = false)的表現(xiàn),可以使用@NotNull注解在對應(yīng)的字段上即可。
在更多的情況下,我們一般使用@NotBlank多于@NotNull,因為@NotBlank考慮了空字符串的情況。
final class ProductCriteria { @NotBlank private String query; @Min(0) private int offset; @Min(1) private int limi; // ... }
這里務(wù)必注意一點:
僅僅只是在對象的字段上添加驗證注解是不夠的。
一定要在controller的方法參數(shù)里誒包中,在POJO對應(yīng)的參數(shù)前加上@Valid注解。該注解會讓Spring在綁定參數(shù)前執(zhí)行校驗動作。
@GetMapping List<Product> searchProducts(@Valid ProductCriteria productCriteria) { // ... }
@RequestParam注解的另一個非常有用的功能就是設(shè)置參數(shù)的默認值。
如果我們使用POJO的方式來綁定參數(shù),只需要在定義參數(shù)的時候設(shè)置好字段的默認值就行了。如果請求中沒有該參數(shù),Spring不會把參數(shù)的默認值覆蓋為null的。
SpringMvc參數(shù)綁定自定義對象
springmvc我們經(jīng)常在寫controller一般都接受兩種方式,一種是form提交,一種是json提交,下面就來介紹如何在這兩種方式中將提交的數(shù)據(jù)自動綁定到自定義對象中。
json提交
這個比較簡單,在網(wǎng)上搜一下一大把,這里就簡單放一段代碼:
@RequestMapping("/testjson") public String testjson(@RequestBody User user){ return "ok"; }
form提交
這個是比較頭疼的,一般form有很多的參數(shù),我們可以像下面這樣寫:
@RequestMapping("/test") public String testParam(@RequestParam(name = "name") String name, @RequestParam(name = "sex") String sex) { return name + sex; }
但是如果我改成下面這樣會怎么樣?然后用form提交參數(shù) name=zack & sex=boy
@RequestMapping("/test") public String test(@RequestParam(name = "user") User user) { return user.getName(); }
結(jié)果是報錯:
{
"timestamp": "2018-05-29T11:58:37.450+0000",
"status": 400,
"error": "Bad Request",
"message": "Required User parameter 'user' is not present",
"path": "/test1"
}
我的參數(shù)里確實是沒有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 public String getAsText() { return getValue().toString(); } }
然后在請求時將參數(shù)改為 user = {"name":"zack","sex":"boy"} ,之后就成功的獲取User對象,WebDataBinder幫我們告訴了spring,如果遇到了一個字符串參數(shù)要被包裝成User.class,用我們自定義的UserFormatEditor就行。
小結(jié)一下
作為規(guī)范而言,form提交的方式本身就需要我們一個一個屬性的接收,而不能用一個對象統(tǒng)一接收,如果你想用一個對象統(tǒng)一接收,請采用json的方式提交。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Redis?+?Java攔截器實現(xiàn)用戶匿名和非匿名訪問
本文主要介紹了Redis?+?Java攔截器實現(xiàn)用戶匿名和非匿名訪問,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06Java并發(fā)教程之Callable和Future接口詳解
Java從發(fā)布的第一個版本開始就可以很方便地編寫多線程的應(yīng)用程序,并在設(shè)計中引入異步處理,這篇文章主要給大家介紹了關(guān)于Java并發(fā)教程之Callable和Future接口的相關(guān)資料,需要的朋友可以參考下2021-07-07MyBatis異常-Property ''configLocation'' not specified, using d
今天小編就為大家分享一篇關(guān)于MyBatis異常-Property 'configLocation' not specified, using default MyBatis Configuration,小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧2019-03-03