之前也寫過一篇關于Spring Validation使用的文章，不過自我感覺還是浮于表面，本次打算徹底搞懂Spring Validation。本文會詳細介紹Spring Validation各種場景下的最佳實踐及其實現原理，死磕到底！

“

項目源碼：https://github.com/chentianming11/spring-validation

簡單使用

Java API規范(JSR303)定義了Bean校驗的標準validation-api，但沒有提供實現。hibernate validation是對這個規范的實現，并增加了校驗注解如@Email、@Length等。

Spring Validation是對hibernate validation的二次封裝，用于支持spring mvc參數自動校驗。接下來，我們以spring-boot項目為例，介紹Spring Validation的使用。

引入依賴

如果spring-boot版本小于2.3.x，spring-boot-starter-web會自動傳入hibernate-validator依賴。如果spring-boot版本大于2.3.x，則需要手動引入依賴：

<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.1.Final</version> </dependency>

對于web服務來說，為防止非法參數對業務造成影響，在Controller層一定要做參數校驗的！大部分情況下，請求參數分為如下兩種形式：

• POST、PUT請求，使用requestBody傳遞參數；

• GET請求，使用requestParam/PathVariable傳遞參數。

下面我們簡單介紹下requestBody和requestParam/PathVariable的參數校驗實戰！

requestBody參數校驗

POST、PUT請求一般會使用requestBody傳遞參數，這種情況下，后端使用DTO對象進行接收。只要給DTO對象加上@Validated注解就能實現自動參數校驗。比如，有一個保存User的接口，要求userName長度是2-10，account和password字段長度是6-20。

如果校驗失敗，會拋出MethodArgumentNotValidException異常，Spring默認會將其轉為400（Bad Request）請求。

“

DTO表示數據傳輸對象（Data Transfer Object），用于服務器和客戶端之間交互傳輸使用的。在spring-web項目中可以表示用于接收請求參數的Bean對象。

在DTO字段上聲明約束注解

@Data public?class?UserDTO?{private?Long?userId;@NotNull@Length(min?=?2,?max?=?10)private?String?userName;@NotNull@Length(min?=?6,?max?=?20)private?String?account;@NotNull@Length(min?=?6,?max?=?20)private?String?password; }

在方法參數上聲明校驗注解

@PostMapping("/save") public?Result?saveUser(@RequestBody?@Validated?UserDTO?userDTO)?{//?校驗通過，才會執行業務邏輯處理return?Result.ok(); }

這種情況下，使用@Valid和@Validated都可以。

requestParam/PathVariable參數校驗

GET請求一般會使用requestParam/PathVariable傳參。如果參數比較多(比如超過6個)，還是推薦使用DTO對象接收。

否則，推薦將一個個參數平鋪到方法入參中。在這種情況下，必須在Controller類上標注@Validated注解，并在入參上聲明約束注解(如@Min等)。如果校驗失敗，會拋出ConstraintViolationException異常。

代碼示例如下：

@RequestMapping("/api/user") @RestController @Validated public?class?UserController?{//?路徑變量@GetMapping("{userId}")public?Result?detail(@PathVariable("userId")?@Min(10000000000000000L)?Long?userId)?{//?校驗通過，才會執行業務邏輯處理UserDTO?userDTO?=?new?UserDTO();userDTO.setUserId(userId);userDTO.setAccount("11111111111111111");userDTO.setUserName("xixi");userDTO.setAccount("11111111111111111");return?Result.ok(userDTO);}//?查詢參數@GetMapping("getByAccount")public?Result?getByAccount(@Length(min?=?6,?max?=?20)?@NotNull?String??account)?{//?校驗通過，才會執行業務邏輯處理UserDTO?userDTO?=?new?UserDTO();userDTO.setUserId(10000000000000003L);userDTO.setAccount(account);userDTO.setUserName("xixi");userDTO.setAccount("11111111111111111");return?Result.ok(userDTO);} }

統一異常處理

前面說過，如果校驗失敗，會拋出MethodArgumentNotValidException或者ConstraintViolationException異常。在實際項目開發中，通常會用統一異常處理來返回一個更友好的提示。

比如我們系統要求無論發送什么異常，http的狀態碼必須返回200，由業務碼去區分系統的異常情況。

@RestControllerAdvice public?class?CommonExceptionHandler?{@ExceptionHandler({MethodArgumentNotValidException.class})@ResponseStatus(HttpStatus.OK)@ResponseBodypublic?Result?handleMethodArgumentNotValidException(MethodArgumentNotValidException?ex)?{BindingResult?bindingResult?=?ex.getBindingResult();StringBuilder?sb?=?new?StringBuilder("校驗失敗:");for?(FieldError?fieldError?:?bindingResult.getFieldErrors())?{sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(",?");}String?msg?=?sb.toString();return?Result.fail(BusinessCode.參數校驗失敗,?msg);}@ExceptionHandler({ConstraintViolationException.class})@ResponseStatus(HttpStatus.OK)@ResponseBodypublic?Result?handleConstraintViolationException(ConstraintViolationException?ex)?{return?Result.fail(BusinessCode.參數校驗失敗,?ex.getMessage());} } “

推薦一個艿艿寫的 6000+ Star 的 SpringBoot + SpringCloud + Dubbo 教程的倉庫：https://github.com/YunaiV/SpringBoot-Labs

進階使用

分組校驗

在實際項目中，可能多個方法需要使用同一個DTO類來接收參數，而不同方法的校驗規則很可能是不一樣的。這個時候，簡單地在DTO類的字段上加約束注解無法解決這個問題。因此，spring-validation支持了分組校驗的功能，專門用來解決這類問題。

還是上面的例子，比如保存User的時候，UserId是可空的，但是更新User的時候，UserId的值必須>=10000000000000000L；其它字段的校驗規則在兩種情況下一樣。這個時候使用分組校驗的代碼示例如下：

約束注解上聲明適用的分組信息groups

@Data public?class?UserDTO?{@Min(value?=?10000000000000000L,?groups?=?Update.class)private?Long?userId;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?2,?max?=?10,?groups?=?{Save.class,?Update.class})private?String?userName;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?6,?max?=?20,?groups?=?{Save.class,?Update.class})private?String?account;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?6,?max?=?20,?groups?=?{Save.class,?Update.class})private?String?password;/***?保存的時候校驗分組*/public?interface?Save?{}/***?更新的時候校驗分組*/public?interface?Update?{} }

@Validated注解上指定校驗分組

@PostMapping("/save") public?Result?saveUser(@RequestBody?@Validated(UserDTO.Save.class)?UserDTO?userDTO)?{//?校驗通過，才會執行業務邏輯處理return?Result.ok(); }@PostMapping("/update") public?Result?updateUser(@RequestBody?@Validated(UserDTO.Update.class)?UserDTO?userDTO)?{//?校驗通過，才會執行業務邏輯處理return?Result.ok(); }

嵌套校驗

前面的示例中，DTO類里面的字段都是基本數據類型和String類型。但是實際場景中，有可能某個字段也是一個對象，這種情況先，可以使用嵌套校驗。

比如，上面保存User信息的時候同時還帶有Job信息。需要注意的是，此時DTO類的對應字段必須標記@Valid注解。

@Data public?class?UserDTO?{@Min(value?=?10000000000000000L,?groups?=?Update.class)private?Long?userId;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?2,?max?=?10,?groups?=?{Save.class,?Update.class})private?String?userName;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?6,?max?=?20,?groups?=?{Save.class,?Update.class})private?String?account;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?6,?max?=?20,?groups?=?{Save.class,?Update.class})private?String?password;@NotNull(groups?=?{Save.class,?Update.class})@Validprivate?Job?job;@Datapublic?static?class?Job?{@Min(value?=?1,?groups?=?Update.class)private?Long?jobId;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?2,?max?=?10,?groups?=?{Save.class,?Update.class})private?String?jobName;@NotNull(groups?=?{Save.class,?Update.class})@Length(min?=?2,?max?=?10,?groups?=?{Save.class,?Update.class})private?String?position;}/***?保存的時候校驗分組*/public?interface?Save?{}/***?更新的時候校驗分組*/public?interface?Update?{} }

嵌套校驗可以結合分組校驗一起使用。還有就是嵌套集合校驗會對集合里面的每一項都進行校驗，例如List<Job>字段會對這個list里面的每一個Job對象都進行校驗

集合校驗

如果請求體直接傳遞了json數組給后臺，并希望對數組中的每一項都進行參數校驗。此時，如果我們直接使用java.util.Collection下的list或者set來接收數據，參數校驗并不會生效！我們可以使用自定義list集合來接收參數：

包裝List類型，并聲明@Valid注解

public?class?ValidationList<E>?implements?List<E>?{@Delegate?//?@Delegate是lombok注解@Valid?//?一定要加@Valid注解public?List<E>?list?=?new?ArrayList<>();//?一定要記得重寫toString方法@Overridepublic?String?toString()?{return?list.toString();} }

@Delegate注解受lombok版本限制，1.18.6以上版本可支持。如果校驗不通過，會拋出NotReadablePropertyException，同樣可以使用統一異常進行處理。

比如，我們需要一次性保存多個User對象，Controller層的方法可以這么寫：

@PostMapping("/saveList") public?Result?saveList(@RequestBody?@Validated(UserDTO.Save.class)?ValidationList<UserDTO>?userList)?{//?校驗通過，才會執行業務邏輯處理return?Result.ok(); }

自定義校驗

業務需求總是比框架提供的這些簡單校驗要復雜的多，我們可以自定義校驗來滿足我們的需求。

自定義spring validation非常簡單，假設我們自定義加密id（由數字或者a-f的字母組成，32-256長度）校驗，主要分為兩步：

自定義約束注解

@Target({METHOD,?FIELD,?ANNOTATION_TYPE,?CONSTRUCTOR,?PARAMETER}) @Retention(RUNTIME) @Documented @Constraint(validatedBy?=?{EncryptIdValidator.class}) public?@interface?EncryptId?{//?默認錯誤消息String?message()?default?"加密id格式錯誤";//?分組Class<?>[]?groups()?default?{};//?負載Class<??extends?Payload>[]?payload()?default?{}; }

實現ConstraintValidator接口編寫約束校驗器

public?class?EncryptIdValidator?implements?ConstraintValidator<EncryptId,?String>?{private?static?final?Pattern?PATTERN?=?Pattern.compile("^[a-f\\d]{32,256}$");@Overridepublic?boolean?isValid(String?value,?ConstraintValidatorContext?context)?{//?不為null才進行校驗if?(value?!=?null)?{Matcher?matcher?=?PATTERN.matcher(value);return?matcher.find();}return?true;} }

這樣我們就可以使用@EncryptId進行參數校驗了！

編程式校驗

上面的示例都是基于注解來實現自動校驗的，在某些情況下，我們可能希望以編程方式調用驗證。這個時候可以注入javax.validation.Validator對象，然后再調用其api。

@Autowired private?javax.validation.Validator?globalValidator;//?編程式校驗 @PostMapping("/saveWithCodingValidate") public?Result?saveWithCodingValidate(@RequestBody?UserDTO?userDTO)?{Set<ConstraintViolation<UserDTO>>?validate?=?globalValidator.validate(userDTO,?UserDTO.Save.class);//?如果校驗通過，validate為空；否則，validate包含未校驗通過項if?(validate.isEmpty())?{//?校驗通過，才會執行業務邏輯處理}?else?{for?(ConstraintViolation<UserDTO>?userDTOConstraintViolation?:?validate)?{//?校驗失敗，做其它邏輯System.out.println(userDTOConstraintViolation);}}return?Result.ok(); }

快速失敗(Fail Fast)

Spring Validation默認會校驗完所有字段，然后才拋出異常。可以通過一些簡單的配置，開啟Fali Fast模式，一旦校驗失敗就立即返回。

@Bean public?Validator?validator()?{ValidatorFactory?validatorFactory?=?Validation.byProvider(HibernateValidator.class).configure()//?快速失敗模式.failFast(true).buildValidatorFactory();return?validatorFactory.getValidator(); }

@Valid和@Validated區別

“

推薦一個艿艿寫的 3000+ Star 的 SpringCloud Alibaba 電商開源項目的倉庫：https://github.com/YunaiV/onemall

實現原理

requestBody參數校驗實現原理

在spring-mvc中，RequestResponseBodyMethodProcessor是用于解析@RequestBody標注的參數以及處理@ResponseBody標注方法的返回值的。顯然，執行參數校驗的邏輯肯定就在解析參數的方法resolveArgument()中：

public?class?RequestResponseBodyMethodProcessor?extends?AbstractMessageConverterMethodProcessor?{@Overridepublic?Object?resolveArgument(MethodParameter?parameter,?@Nullable?ModelAndViewContainer?mavContainer,NativeWebRequest?webRequest,?@Nullable?WebDataBinderFactory?binderFactory)?throws?Exception?{parameter?=?parameter.nestedIfOptional();//將請求數據封裝到DTO對象中Object?arg?=?readWithMessageConverters(webRequest,?parameter,?parameter.getNestedGenericParameterType());String?name?=?Conventions.getVariableNameForParameter(parameter);if?(binderFactory?!=?null)?{WebDataBinder?binder?=?binderFactory.createBinder(webRequest,?arg,?name);if?(arg?!=?null)?{//?執行數據校驗validateIfApplicable(binder,?parameter);if?(binder.getBindingResult().hasErrors()?&&?isBindExceptionRequired(binder,?parameter))?{throw?new?MethodArgumentNotValidException(parameter,?binder.getBindingResult());}}if?(mavContainer?!=?null)?{mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX?+?name,?binder.getBindingResult());}}return?adaptArgumentIfNecessary(arg,?parameter);} }

可以看到，resolveArgument()調用了validateIfApplicable()進行參數校驗。

protected?void?validateIfApplicable(WebDataBinder?binder,?MethodParameter?parameter)?{//?獲取參數注解，比如@RequestBody、@Valid、@ValidatedAnnotation[]?annotations?=?parameter.getParameterAnnotations();for?(Annotation?ann?:?annotations)?{//?先嘗試獲取@Validated注解Validated?validatedAnn?=?AnnotationUtils.getAnnotation(ann,?Validated.class);//如果直接標注了@Validated，那么直接開啟校驗。//如果沒有，那么判斷參數前是否有Valid起頭的注解。if?(validatedAnn?!=?null?||?ann.annotationType().getSimpleName().startsWith("Valid"))?{Object?hints?=?(validatedAnn?!=?null???validatedAnn.value()?:?AnnotationUtils.getValue(ann));Object[]?validationHints?=?(hints?instanceof?Object[]???(Object[])?hints?:?new?Object[]?{hints});//執行校驗binder.validate(validationHints);break;}} }

看到這里，大家應該能明白為什么這種場景下@Validated、@Valid兩個注解可以混用。我們接下來繼續看WebDataBinder.validate()實現。

@Override public?void?validate(Object?target,?Errors?errors,?Object...?validationHints)?{if?(this.targetValidator?!=?null)?{processConstraintViolations(//此處調用Hibernate?Validator執行真正的校驗this.targetValidator.validate(target,?asValidationGroups(validationHints)),?errors);} }

最終發現底層最終還是調用了Hibernate Validator進行真正的校驗處理。

方法級別的參數校驗實現原理

上面提到的將參數一個個平鋪到方法參數中，然后在每個參數前面聲明約束注解的校驗方式，就是方法級別的參數校驗。

實際上，這種方式可用于任何Spring Bean的方法上，比如Controller/Service等。其底層實現原理就是AOP，具體來說是通過MethodValidationPostProcessor動態注冊AOP切面，然后使用MethodValidationInterceptor對切點方法織入增強。

public?class?MethodValidationPostProcessor?extends?AbstractBeanFactoryAwareAdvisingPostProcessorimplements?InitializingBean?{@Overridepublic?void?afterPropertiesSet()?{//為所有`@Validated`標注的Bean創建切面Pointcut?pointcut?=?new?AnnotationMatchingPointcut(this.validatedAnnotationType,?true);//創建Advisor進行增強this.advisor?=?new?DefaultPointcutAdvisor(pointcut,?createMethodValidationAdvice(this.validator));}//創建Advice，本質就是一個方法攔截器protected?Advice?createMethodValidationAdvice(@Nullable?Validator?validator)?{return?(validator?!=?null???new?MethodValidationInterceptor(validator)?:?new?MethodValidationInterceptor());} }

接著看一下MethodValidationInterceptor：

public?class?MethodValidationInterceptor?implements?MethodInterceptor?{@Overridepublic?Object?invoke(MethodInvocation?invocation)?throws?Throwable?{//無需增強的方法，直接跳過if?(isFactoryBeanMetadataMethod(invocation.getMethod()))?{return?invocation.proceed();}//獲取分組信息Class<?>[]?groups?=?determineValidationGroups(invocation);ExecutableValidator?execVal?=?this.validator.forExecutables();Method?methodToValidate?=?invocation.getMethod();Set<ConstraintViolation<Object>>?result;try?{//方法入參校驗，最終還是委托給Hibernate?Validator來校驗result?=?execVal.validateParameters(invocation.getThis(),?methodToValidate,?invocation.getArguments(),?groups);}catch?(IllegalArgumentException?ex)?{...}//有異常直接拋出if?(!result.isEmpty())?{throw?new?ConstraintViolationException(result);}//真正的方法調用Object?returnValue?=?invocation.proceed();//對返回值做校驗，最終還是委托給Hibernate?Validator來校驗result?=?execVal.validateReturnValue(invocation.getThis(),?methodToValidate,?returnValue,?groups);//有異常直接拋出if?(!result.isEmpty())?{throw?new?ConstraintViolationException(result);}return?returnValue;} }

實際上，不管是requestBody參數校驗還是方法級別的校驗，最終都是調用Hibernate Validator執行校驗，Spring Validation只是做了一層封裝。

總結

以上是生活随笔為你收集整理的Spring Validation 最佳实践及其实现原理，参数校验没那么简单！的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。