SpringBoot使用validator参数校验

什么是Validator

Bean Validation是Java定义的一套基于注解的数据校验规范，目前已经从JSR 303的1.0版本升级到JSR 349的1.1版本，再到JSR 380的2.0版本（2.0完成于2017.08），已经经历了三个版本 。在SpringBoot中已经集成在 starter-web中，所以无需在添加其他依赖。

引入依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

设置Validator全局异常处理

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.convert.ConversionFailedException;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.Set;

/**
 * @author sht
 * @date 11/7/2020 10:26 AM
 */
@ControllerAdvice
@RestController
public class GloabExceptionHandle extends BaseController {
    private static final Logger LOGGER = LoggerFactory.getLogger(GloabExceptionHandle.class);

    /**
     * 处理请求参数格式错误 @RequestBody上validate失败后抛出的异常
     *
     * @param e MethodArgumentNotValidException
     * @return
     */
    @ExceptionHandler(value = {MethodArgumentNotValidException.class})
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public RestResponse handleParamException(Exception e) {
        LOGGER.error(e.getMessage());

        MethodArgumentNotValidException exception = (MethodArgumentNotValidException) e;
        BindingResult bindingResult = exception.getBindingResult();
        if (bindingResult.hasErrors() && bindingResult.getAllErrors().size() > 0) {
            String defaultMessage = bindingResult.getAllErrors().get(0).getDefaultMessage();
            return ERROR(400, defaultMessage);
        } else {
            return ERROR(400, "参数不合法");
        }

    }

    /**
     * 处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常，详情继续往下看代码
     *
     * @param e BindException
     * @return
     */
    @ExceptionHandler(BindException.class)
    public RestResponse BindExceptionHandler(BindException e) {
        String result = "参数不合法";
        LOGGER.error(e.getMessage());
        if (e.getAllErrors() != null && !e.getAllErrors().isEmpty()) {
            result = e.getAllErrors().get(0).getDefaultMessage();
        }
        return ERROR(400, result);
    }

    /**
     * 处理请求参数格式错误 @RequestParam上validate失败后抛出的异常
     *
     * @param e ConstraintViolationException
     * @return must not be null
     */
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = ConstraintViolationException.class)
    public RestResponse handleUnauthorized(ConstraintViolationException e) {
        LOGGER.error(e.getMessage());
        String result = "参数不合法.";
        Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
        if (!constraintViolations.isEmpty()) {
            result = constraintViolations.stream().findFirst().get().getMessage();
        }
        return ERROR(400, result);
    }

    /**
     * 参数类型转换错误
     *
     * @param e
     * @return
     */
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = {ConversionFailedException.class, MethodArgumentTypeMismatchException.class})
    public RestResponse handleUnauthorized(Exception e) {
        LOGGER.error(e.getMessage(), e);
        String result = " 参数类型不正确.";
        return ERROR(400, result);
    }


    @ExceptionHandler(value = Exception.class)
    @ResponseStatus()
    public RestResponse handleException(Exception e) {
        LOGGER.error(e.getMessage(), e);
        RestResponse restResponse = new RestResponse();
        return ERROR("服务器异常，请稍后再试.");
    }

}

Controller层使用

//Controller类加该注解
@Validated
// 在参数项前加注解
@Valid @NotNull(message = "keywords is must not be null") 

常用的约束注解

@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式Hibernate Validator 附加的 constraint
@NotBlank(message =) 验证字符串非null，且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
@URL(protocol=,host=, port=, regexp=, flags=) 被注释的字符串必须是一个有效的url
@CreditCardNumber 被注释的字符串必须通过Luhn校验算法，银行卡，信用卡等号码一般都用Luhn计算合法性
@ScriptAssert(lang=, script=, alias=) 要有Java Scripting API 即JSR 223 (“Scripting for the JavaTM Platform”)的实现
@SafeHtml(whitelistType=, additionalTags=) classpath中要有jsoup包

Configuration配置

@Configuration
public class ValidatorConfig {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                .failFast(true)
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        return validator;
    }
}