本文會詳細介紹Spring Validation各類場景下的最佳實踐及其實現原理,死磕到底!
項目源碼:spring-validationjava
Java API規範(JSR303)定義了Bean校驗的標準validation-api,但沒有提供實現。hibernate validation是對這個規範的實現,並增長了校驗註解如@Email、@Length等。Spring Validation是對hibernate validation的二次封裝,用於支持spring mvc參數自動校驗。接下來,咱們以spring-boot項目爲例,介紹Spring Validation的使用。web
若是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層必定要作參數校驗的!大部分狀況下,請求參數分爲以下兩種形式:spring
1.POST、PUT請求,使用requestBody傳遞參數;編程
2.GET請求,使用requestParam/PathVariable傳遞參數。json
下面咱們簡單介紹下requestBody和requestParam/PathVariable的參數校驗實戰!後端
POST、PUT請求通常會使用requestBody傳遞參數,這種狀況下,後端使用DTO對象進行接收。只要給DTO對象加上@Validated註解就能實現自動參數校驗。好比,有一個保存User的接口,要求userName長度是2-10,account和password字段長度是6-20。若是校驗失敗,會拋出MethodArgumentNotValidException異常,Spring默認會將其轉爲400(Bad Request)請求。api
DTO表示數據傳輸對象(Data Transfer Object),用於服務器和客戶端之間交互傳輸使用的。在spring-web項目中能夠表示用於接收請求參數的Bean對象。數組
在DTO字段上聲明約束註解spring-mvc
@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均可以。
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) @ResponseBody public 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) @ResponseBody public Result handleConstraintViolationException(ConstraintViolationException ex) { return Result.fail(BusinessCode.參數校驗失敗, ex.getMessage()); } }
在實際項目中,可能多個方法須要使用同一個DTO類來接收參數,而不一樣方法的校驗規則極可能是不同的。這個時候,簡單地在DTO類的字段上加約束註解沒法解決這個問題。所以,spring-validation支持了分組校驗的功能,專門用來解決這類問題。仍是上面的例子,好比保存User的時候,UserId是可空的,可是更新User的時候,UserId的值必須>=10000000000000000L;其它字段的校驗規則在兩種狀況下同樣。
這個時候使用分組校驗的代碼示例以下:
@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 { } }
@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}) @Valid private Job job; @Data public 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
若是請求體直接傳遞了json數組給後臺,並但願對數組中的每一項都進行參數校驗。此時,若是咱們直接使用java.util.Collection下的list或者set來接收數據,參數校驗並不會生效!咱們可使用自定義list集合來接收參數:
public class ValidationList<E> implements List<E> { @Delegate // @Delegate是lombok註解 @Valid // 必定要加@Valid註解 public List<E> list = new ArrayList<>(); // 必定要記得重寫toString方法 @Override public 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 {}; }
public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> { private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$"); @Override public 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(); }
Spring Validation默認會校驗完全部字段,而後才拋出異常。能夠經過一些簡單的配置,開啓Fali Fast模式,一旦校驗失敗就當即返回。
@Bean public Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) .configure() // 快速失敗模式 .failFast(true) .buildValidatorFactory(); return validatorFactory.getValidator(); }
@Valid和@Validated區別
在spring-mvc中,RequestResponseBodyMethodProcessor是用於解析@RequestBody標註的參數以及處理@ResponseBody標註方法的返回值的。顯然,執行參數校驗的邏輯確定就在解析參數的方法resolveArgument()中:
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor { @Override public 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、@Validated Annotation[] 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 { @Override public 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 { @Override public 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相關資料文檔以及知識圖譜、Java的系統化資料,(包括Java核心知識點、面試專題和20年最新的互聯網真題、電子書等)有須要的朋友能夠關注公衆號【程序媛小琬】便可獲取。