[[400097]]
永川網(wǎng)站制作公司哪家好，找成都創(chuàng)新互聯(lián)公司！從網(wǎng)頁設(shè)計(jì)、網(wǎng)站建設(shè)、微信開發(fā)、APP開發(fā)、響應(yīng)式網(wǎng)站等網(wǎng)站項(xiàng)目制作，到程序開發(fā)，運(yùn)營維護(hù)。成都創(chuàng)新互聯(lián)公司2013年開創(chuàng)至今到現(xiàn)在10年的時(shí)間，我們擁有了豐富的建站經(jīng)驗(yàn)和運(yùn)維經(jīng)驗(yàn)，來保證我們的工作的順利進(jìn)行。專注于網(wǎng)站建設(shè)就選成都創(chuàng)新互聯(lián)公司。
本文轉(zhuǎn)載自微信公眾號(hào)「JAVA日知錄」，作者單一色調(diào)。轉(zhuǎn)載本文請聯(lián)系JAVA日知錄公眾號(hào)。
對于 web服務(wù)來說，為防止非法參數(shù)對業(yè)務(wù)造成影響，在 Controller層一定要對參數(shù)進(jìn)行校驗(yàn)!本章我們以SpringBoot項(xiàng)目為例，介紹參數(shù)校驗(yàn)的基本用法以及一些高級技巧，希望能對你有所幫助。
簡單使用
1.要在Springboot項(xiàng)目中加入?yún)?shù)校驗(yàn)功能首先得加入spring-boot-starter-validation依賴
-
- org.springframework.boot
- spring-boot-starter-validation
-
2.然后給需要校驗(yàn)的字段添加上約束性注解，如我們對實(shí)體類參數(shù)進(jìn)行校驗(yàn)
- @Data
- public class ValidEntity{
- private int id;
- @NotBlank
- private String appId;
-
- @NotBlank
- private String name;
-
- @Email
- private String email;
- }
常見約束注解如下：
| 注解 |
功能 |
| @AssertFalse |
可以為null,如果不為null的話必須為false |
| @AssertTrue |
可以為null,如果不為null的話必須為true |
| @DecimalMax |
設(shè)置不能超過最大值 |
| @DecimalMin |
設(shè)置不能超過最小值 |
| @Digits |
設(shè)置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi) |
| @Future |
日期必須在當(dāng)前日期的未來 |
| @Past |
日期必須在當(dāng)前日期的過去 |
| @Max |
最大不得超過此最大值 |
| @Min |
最大不得小于此最小值 |
| @NotNull |
不能為null，可以是空 |
| @Null |
必須為null |
| @Pattern |
必須滿足指定的正則表達(dá)式 |
| @Size |
集合、數(shù)組、map等的size()值必須在指定范圍內(nèi) |
| @Email |
必須是email格式 |
| @Length |
長度必須在指定范圍內(nèi) |
| @NotBlank |
字符串不能為null,字符串trim()后也不能等于“” |
| @NotEmpty |
不能為null，集合、數(shù)組、map等size()不能為0；字符串trim()后可以等于“” |
| @Range |
值必須在指定范圍內(nèi) |
| @URL |
必須是一個(gè)URL |
注：此表格只是簡單的對注解功能的說明，并沒有對每一個(gè)注解的屬性進(jìn)行說明;可詳見源碼。
3.在Controller層對需要參數(shù)校驗(yàn)的方法加上@Validated注解
參數(shù)校驗(yàn)一般分為兩類：在Controller使用模型接收數(shù)據(jù)時(shí)， @Validated注解直接放在該模型參數(shù)前即可。
- @PostMapping(value = "test1")
- public String test1(@Validated @RequestBody ValidEntity validEntity){
- return "test1 valid success";
- }
-
- @PostMapping(value = "test3")
- public String test3(@Validated ValidEntity validEntity){
- return "test3 valid success";
- }
當(dāng)我們是直接在Controller層中的參數(shù)前，使用約束注解時(shí)，@Validated要直接放在類上
- @PostMapping(value = "test2")
- public String test2(@Email String email){
- return "test2 valid success";
- }
此時(shí)需要在主類上增加@Validated注解
- @Validated
- @RestController
- @RequestMapping("/demo/valid")
- public class ValidController {
- ...
- }
在參數(shù)校驗(yàn)時(shí)我們既可以使用@Validated也可以使用@Valid注解，兩者功能大部分類似;
主要區(qū)別在于：
@Valid屬于javax下的，而@Validated屬于spring下;
@Valid支持嵌套校驗(yàn)、而@Validated不支持，@Validated支持分組，而@Valid不支持。
統(tǒng)一異常處理
如果參數(shù)校驗(yàn)未通過Spring會(huì)拋出三種類型的異常
1.當(dāng)對@RequestBody需要的參數(shù)進(jìn)行校驗(yàn)時(shí)會(huì)出現(xiàn)org.springframework.web.bind.MethodArgumentNotValidException
當(dāng)直接校驗(yàn)具體參數(shù)時(shí)會(huì)出現(xiàn)javax.validation.ConstraintViolationException，也屬于ValidationException異常
當(dāng)直接校驗(yàn)對象時(shí)會(huì)出現(xiàn)org.springframework.validation.BindException
在SpringBoot中統(tǒng)一攔截處理只需要在配置類上添加 @RestControllerAdvice注解，然后在具體方法中通過 @ExceptionHandler指定需要處理的異常，具體代碼如下：
- @RestControllerAdvice
- @Slf4j
- public class GlobalExceptionHandler {
- public static final String ERROR_MSG = "系統(tǒng)異常，請聯(lián)系管理員。";
-
- @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
- public ResponseEntity> handleValidatedException(Exception e) {
- Result resp = null;
-
- if (e instanceof MethodArgumentNotValidException) {
- // BeanValidation exception
- MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
- resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()),
- ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", "))
- , getStackTrace(ex));
- } else if (e instanceof ConstraintViolationException) {
- // BeanValidation GET simple param
- ConstraintViolationException ex = (ConstraintViolationException) e;
- resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()),
- ex.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining(", "))
- , getStackTrace(ex));
- } else if (e instanceof BindException) {
- // BeanValidation GET object param
- BindException ex = (BindException) e;
- resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()),
- ex.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", "))
- , getStackTrace(ex));
- }
-
- return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
- }
-
-
- private String getStackTrace(Exception e) {
- //打印日志開關(guān)，可通過配置讀取
- boolean printStrackTrace = false;
- if(printStrackTrace){
- StringWriter sw = new StringWriter();
- e.printStackTrace(new PrintWriter(sw));
- return sw.toString();
- }else{
- return ERROR_MSG;
- }
-
- }
-
- }
最終實(shí)現(xiàn)效果如下：
參數(shù)分組
有下面一個(gè)實(shí)體類，我們需要對其進(jìn)行參數(shù)校驗(yàn)。
- @Data
- public class ValidEntity {
- private int id;
-
- @NotBlank
- private String appId;
-
- @NotBlank
- private String name;
-
- @Email
- private String email;
- }
但是實(shí)際業(yè)務(wù)是在編輯的時(shí)候 appId才是必填，在新增的時(shí)候 name必填，這時(shí)候可以用groups分組功能來實(shí)現(xiàn)：同一個(gè)模型在不同場景下，動(dòng)態(tài)區(qū)分校驗(yàn)?zāi)Ｐ椭械牟煌侄巍?/p>
使用方式
首先我們定義一個(gè)分組接口ValidGroup，再在分組接口總定義出多個(gè)不同的操作類型，Create，Update，Query，Delete
- public interface ValidGroup extends Default{
-
- interface Crud extends ValidGroup{
-
- interface Create extends Crud{
-
- }
-
- interface Update extends Crud{
-
- }
-
- interface Query extends Crud{
-
- }
-
- interface Delete extends Crud{
-
- }
- }
- }
這里的 ValidGroup繼承了Default，當(dāng)然也可以不繼承，具體區(qū)別我們后面再說。
在模型中給校驗(yàn)參數(shù)分配分組
- @Data
- @ApiModel(value="ValidEntity")
- public class ValidEntity {
- private int id;
-
- @NotBlank(groups = ValidGroup.Crud.Update.class)
- private String appId;
-
- @NotBlank(groups = ValidGroup.Crud.Create.class)
- private String name;
-
- @Email
- private String email;
- }
tips：這里@Email注解未指定分組，默認(rèn)會(huì)屬于Default分組，appId和name指定了分組就不會(huì)再屬于Default分組了。
在參數(shù)校驗(yàn)時(shí)通過value屬性指定分組
這里通過 @Validated(value = ValidGroup.Crud.Update.class)指定了具體的分組，上面提到的是否繼承Default的區(qū)別在于：
如果繼承了Default，@Validated標(biāo)注的注解也會(huì)校驗(yàn)未指定分組或者Default分組的參數(shù)，比如email
如果不繼承Default則不會(huì)校驗(yàn)未指定分組的參數(shù)，需要加上@Validated(value = {ValidGroup.Crud.Update.class, Default.class}才會(huì)校驗(yàn)
快速失敗(Fali Fast)
默認(rèn)情況下在對參數(shù)進(jìn)行校驗(yàn)時(shí)Spring Validation會(huì)校驗(yàn)完所有字段然后才拋出異常，可以通過配置開啟 Fali Fast模式，一旦校驗(yàn)失敗就立即返回。
- @Configuration
- public class ValidatedConfig {
-
- @Bean
- public Validator validator() {
- ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
- .configure()
- // 快速失敗模式
- .failFast(true)
- .buildValidatorFactory();
- return validatorFactory.getValidator();
- }
- }
以上，希望對你有所幫助!
標(biāo)題名稱：SpringBoot開發(fā)秘籍-集成參數(shù)校驗(yàn)及高階技巧
本文鏈接：
http://uogjgqi.cn/article/djpecis.html
