在Spring中,如果在方法參數列表中使用@RequestParam標注多個參數,會讓映射方法的可讀性大大降低。
如果映射請求的參數只有一兩個的話,使用@RequestParam會非常直觀,但是如果參數列表越來越長,就很容易暈菜。
解決方案:
可以直接使用ParameterObject模式來處理【注:ParameterObject就是把參數組裝成對象】。
如果要傳參對數據庫操作,則參數對應數據庫中的某些字段,此時表對應的entity對象可以直接作為ParameterObject。
其他情況下則可以使用一個POJO來包裝這些參數,這個POJO本身沒有要求額外的注解,但是POJO本身必須包含和請求參數完全匹配的字段,標准的setter/getter,和一個無參的構造器:
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中對請求參數進行校驗
雖然上面的案例已經可以正常使用,但是我們知道,使用@RequestParam注解,不僅僅只是為了綁定請求參數,一個非常重要的功能是,我們可以對綁定的參數請求驗證,比如參數是否必要,如果請求中缺少該參數,則我們的服務端可以拒絕該請求。
想為我們的POJO中的字段添加驗證規則。如果想模仿@RequestParam(required = false)的表現,可以使用@NotNull注解在對應的字段上即可。
在更多的情況下,我們一般使用@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的。
