Spring的@RequestParam對(duì)象綁定方式

更新時(shí)間：2021年10月25日 14:35:12 作者：學(xué)無止境2019

這篇文章主要介紹了Spring的@RequestParam對(duì)象綁定方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Spring @RequestParam對(duì)象綁定

在Spring中，如果在方法參數(shù)列表中使用@RequestParam標(biāo)注多個(gè)參數(shù)，會(huì)讓映射方法的可讀性大大降低。

如果映射請(qǐng)求的參數(shù)只有一兩個(gè)的話，使用@RequestParam會(huì)非常直觀，但是如果參數(shù)列表越來越長(zhǎng)，就很容易暈菜。

解決方案

可以直接使用ParameterObject模式來處理【注：ParameterObject就是把參數(shù)組裝成對(duì)象】。

如果要傳參對(duì)數(shù)據(jù)庫(kù)操作，則參數(shù)對(duì)應(yīng)數(shù)據(jù)庫(kù)中的某些字段，此時(shí)表對(duì)應(yīng)的entity對(duì)象可以直接作為ParameterObject。

其他情況下則可以使用一個(gè)POJO來包裝這些參數(shù)，這個(gè)POJO本身沒有要求額外的注解，但是POJO本身必須包含和請(qǐng)求參數(shù)完全匹配的字段，標(biāo)準(zhǔn)的setter/getter，和一個(gè)無參的構(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中對(duì)請(qǐng)求參數(shù)進(jìn)行校驗(yàn)

雖然上面的案例已經(jīng)可以正常使用，但是我們知道，使用@RequestParam注解，不僅僅只是為了綁定請(qǐng)求參數(shù)，一個(gè)非常重要的功能是，我們可以對(duì)綁定的參數(shù)請(qǐng)求驗(yàn)證，比如參數(shù)是否必要，如果請(qǐng)求中缺少該參數(shù)，則我們的服務(wù)端可以拒絕該請(qǐng)求。

想為我們的POJO中的字段添加驗(yàn)證規(guī)則。如果想模仿@RequestParam(required = false)的表現(xiàn)，可以使用@NotNull注解在對(duì)應(yīng)的字段上即可。

在更多的情況下，我們一般使用@NotBlank多于@NotNull，因?yàn)锧NotBlank考慮了空字符串的情況。

final class ProductCriteria {
   @NotBlank
   private String query;
   @Min(0)
   private int offset;
   @Min(1)
   private int limi;
   // ...
}

這里務(wù)必注意一點(diǎn)：

僅僅只是在對(duì)象的字段上添加驗(yàn)證注解是不夠的。

一定要在controller的方法參數(shù)里誒包中，在POJO對(duì)應(yīng)的參數(shù)前加上@Valid注解。該注解會(huì)讓Spring在綁定參數(shù)前執(zhí)行校驗(yàn)動(dòng)作。

@GetMapping
List<Product> searchProducts(@Valid ProductCriteria productCriteria) {
   // ...
}

@RequestParam注解的另一個(gè)非常有用的功能就是設(shè)置參數(shù)的默認(rèn)值。

如果我們使用POJO的方式來綁定參數(shù)，只需要在定義參數(shù)的時(shí)候設(shè)置好字段的默認(rèn)值就行了。如果請(qǐng)求中沒有該參數(shù)，Spring不會(huì)把參數(shù)的默認(rèn)值覆蓋為null的。

SpringMvc參數(shù)綁定自定義對(duì)象

springmvc我們經(jīng)常在寫controller一般都接受兩種方式，一種是form提交，一種是json提交，下面就來介紹如何在這兩種方式中將提交的數(shù)據(jù)自動(dòng)綁定到自定義對(duì)象中。

json提交

這個(gè)比較簡(jiǎn)單，在網(wǎng)上搜一下一大把，這里就簡(jiǎn)單放一段代碼：

@RequestMapping("/testjson")
public String testjson(@RequestBody User user){
    return "ok";
}

form提交

這個(gè)是比較頭疼的，一般form有很多的參數(shù)，我們可以像下面這樣寫：

@RequestMapping("/test")
public String testParam(@RequestParam(name = "name") String name, @RequestParam(name = "sex") String sex) {
    return name + sex;
}

但是如果我改成下面這樣會(huì)怎么樣？然后用form提交參數(shù) name=zack & sex=boy

@RequestMapping("/test")
public String test(@RequestParam(name = "user") User user) {
    return user.getName();
}

結(jié)果是報(bào)錯(cuò)：

{
"timestamp": "2018-05-29T11:58:37.450+0000",
"status": 400,
"error": "Bad Request",
"message": "Required User parameter 'user' is not present",
"path": "/test1"
}

我的參數(shù)里確實(shí)是沒有user這個(gè)，其實(shí)我的原本目的是想讓spring把我傳遞的name和sex熟悉拼裝好生成一個(gè)user對(duì)象，因?yàn)閯偤胾ser對(duì)象就有這2個(gè)屬性，spring可沒有智能。那該怎么辦？

這個(gè)時(shí)候引入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();
    }
}

然后在請(qǐng)求時(shí)將參數(shù)改為 user = {"name":"zack","sex":"boy"} ，之后就成功的獲取User對(duì)象，WebDataBinder幫我們告訴了spring，如果遇到了一個(gè)字符串參數(shù)要被包裝成User.class，用我們自定義的UserFormatEditor就行。