SpringBoot使用validation做參數校驗的實現步驟
直接添加 hibernate-validator
<dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.2.Final</version></dependency>
添加spring-boot-starter-validation
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> <version>1.4.0.RELEASE</version></dependency>
添加spring-boot-starter-web
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>2. 配置文件,如果想要設置fail_fast屬性的話,true表示有一個參數出錯即返回,默認的時檢驗所有的參數,那么必須要有配置文件
import org.hibernate.validator.HibernateValidator;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;import org.springframework.validation.beanvalidation.SpringValidatorAdapter;import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;import javax.validation.Validation;import javax.validation.Validator;import javax.validation.ValidatorFactory;/** * hibernate參數驗證配置 */@Configurationpublic class ValidatorConfig extends WebMvcConfigurerAdapter { @Bean public Validator validator() {ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure()// 將fail_fast設置為true即可,如果想驗證全部,則設置為false或者取消配置即可.failFast(true)//.addProperty('hibernate.validator.fail_fast', 'true').buildValidatorFactory();return validatorFactory.getValidator(); } /** * requestParam方式的校驗 * @return */ @Bean public MethodValidationPostProcessor methodValidationPostProcessor() {MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();methodValidationPostProcessor.setValidator(validator());return methodValidationPostProcessor; } @Override public org.springframework.validation.Validator getValidator() {return new SpringValidatorAdapter(validator()); }}
其中methodValidationPostProcessor是對requestParam起作用
繼承WebMvcConfigurerAdapter 并且重寫getValidator()方法,是讓spring的請求校驗Validator使用我們上邊的validator,讓設置的failFast生效,具體可參考org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport#mvcValidator方法
3.統一異常處理/** * hibernate-valid實體類形式接受參數驗證失敗 * @param ex * @return */ @ExceptionHandler(BindException.class) @ResponseBody public WebResult validationErrorHandler(BindException ex) {List<String> collect = ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.toList());return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(), StringUtils.join(collect, ';')); } /** * hibernate-valid實體類形式接受參數驗證失敗 * @param ex * @return */ @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseBody public WebResult validationErrorHandler(MethodArgumentNotValidException ex) {List<String> collect = ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.toList());return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(), StringUtils.join(collect, ';')); } /** * RequestParam方式參數校驗 * @param ex * @return */ @ExceptionHandler(ConstraintViolationException.class) @ResponseBody public WebResult validationErrorHandler(ConstraintViolationException ex) {List<String> errorInformation = ex.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.toList());return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(),StringUtils.join(errorInformation, ';')); }4.使用
如果是@RequestParam這樣直接寫參數校驗的話,在類上或者對應方法上加上Validated注解,如果是實體類接受的話,在參數中的實體前加上@Valid即可
以上就是SpringBoot使用validation做參數校驗的實現步驟的詳細內容,更多關于SpringBoot使用validation做參數校驗的資料請關注好吧啦網其它相關文章!
相關文章:
