使用JSR-303进行后台数据校验

一、JSR本身定义的校验

1.加入依赖

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

2.编写需要校验的bean

@NotNull(message="名字不能为空")
private String userName;

@Max(value=120,message="年龄最大不能查过120")
private int age;

@Email(message="邮箱格式错误")
private String email;

3.检验方法

@RequestMapping("/login")
    public String testValid(@Valid User user, BindingResult result){
        if (result.hasErrors()){
            List<ObjectError> errorList = result.getAllErrors();
            for(ObjectError error : errorList){
                System.out.println(error.getDefaultMessage());
            }
        }
           
        return "test";
  }

JSR303定义的校验类型

空检查

@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

 

Booelan检查

@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  

 

长度检查

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内  
@Length(min=, max=) Validates that the annotated string is between min and max included.

 

日期检查

@Past           验证 Date 和 Calendar 对象是否在当前时间之前  
@Future     验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern    验证 String 对象是否符合正则表达式的规则

 

数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null

@Min            验证 Number 和 String 对象是否大等于指定的值  
@Max            验证 Number 和 String 对象是否小等于指定的值  
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits     验证 Number 和 String 的构成是否合法  
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。

 
@Range(min=, max=) 检查数字是否介于min和max之间.
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;

 

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email  验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)

二、自定义参数校验（这边以校验手机号为例）

编写注解类

package com.bosssoft.bes.base.argstarget;

import com.bosssoft.bes.base.validator.IsMobileValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @author lujinshan
 */
//说明该注解将被包含在javadoc中
@Documented
// 注解的作用目标 类上、方法上、属性上
@Target({ElementType.FIELD, ElementType.PARAMETER})
// 注解的保留位置　　
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {IsMobileValidator.class }) // 与约束注解关联的验证器
public @interface IsMobile {

    boolean required() default true;

    String message() default "手机号不正确";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

}

编写校验规则

package com.bosssoft.bes.base.validator;

import com.bosssoft.bes.base.argstarget.IsMobile;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Pattern;

/**
 * @ClassName: IsMobileValidator
 * @Description: TODO
 * @Author: lujinshan
 * @Date: 2019/9/16 0:53
 * @Version: 1.0.0
 */
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
    private boolean required;

    /**
     * 重写initialize方法获取注解实例
     * @param ca
     */
    @Override
    public void initialize(IsMobile ca) {
        // 重注解实例中获信息
        required = ca.required();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // value就是要校验的数据了
        if (value != null && required) {
            // 手机号校验规则
            System.out.println(value);
            String regexp= "^(((\\+\\d{2}-)?0\\d{2,3}-\\d{7,8})|((\\+\\d{2}-)?(\\d{2,3}-)?([1][3,4,5,7,8][0-9]\\d{8})))$";
            boolean matches = Pattern.matches(regexp, value);
            System.out.println(matches);
            return matches;
        }
        return false;
    }
}

使用方法（在bean上直接使用即可）

    /**
     * 手机号
     */
    @IsMobile
    private String tel;

也可以自己定义错误信息

    /**
     * 手机号
     */
    @IsMobile(message = "用户手机号不正确")
    private String tel;

三、异常捕获

当定义了JSR303校验器后，校验不通过都会产生一个BindException，输出错误信息。若要对异常处理，我们可以定义一个全局异常处理的拦截器。

package com.bosssoft.bes.base.resolver;

import com.bosssoft.bes.base.coredata.vo.CommonResponse;
import com.bosssoft.bes.base.utils.ResultUtils;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.BindException;
import org.springframework.validation.ObjectError;
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.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * 统一异常全局异常处理类
 * @ClassName: GlobalExceptionResolver
 * @Description: TODO
 * @Author: lujinshan
 * @Date: 2019/8/10 17:47
 * @Version: 1.0.0
 */
@Slf4j
@ControllerAdvice(annotations = {RestController.class})
public class GlobalExceptionResolver {

    private final static Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionResolver.class);

    @ExceptionHandler({Exception.class})
    @ResponseBody
    public CommonResponse handleException(Exception e) {
  
        //判断是否是参数异常,并且没有使用@RequestBody
        if (e instanceof BindException) {
            //此处的BindException为Spring框架抛出的Validation异常
            BindException bindException = (BindException) e;
            //抛出的异常可能不止一个
            List<ObjectError> errors = bindException.getAllErrors();
            //获取第一个异常
            ObjectError error = errors.get(0);
            //获取异常信息
            String errorMsg = error.getDefaultMessage();
            return ResultUtils.error(20001, errorMsg);

        }
        //判断是否是参数异常,并且使用@RequestBody
        if (e instanceof MethodArgumentNotValidException) {
            LOGGER.info(((MethodArgumentNotValidException) e).getBindingResult().getAllErrors().toString());
            MethodArgumentNotValidException methodArgumentNotValidException = (MethodArgumentNotValidException) e;
            //抛出的异常可能不止一个
            List<ObjectError> errorList = methodArgumentNotValidException.getBindingResult().getAllErrors();
            List<String> result = new ArrayList<>();
            for (ObjectError objectError : errorList) {
                result.add(objectError.getDefaultMessage());
            }
            return ResultUtils.error(20000, result.toString());
        }
        LOGGER.error("【系统异常】{}", e);
        return ResultUtils.error(SystemExceptionEnum.SYSTEM_ERROR.getCode(), SystemExceptionEnum.SYSTEM_ERROR.getMessage());
    }

}

MethodArgumentNotValidException 和 BindException 都是为了处理JSR303异常
BindException是为了处理使用@RequestBody的参数异常
MethodArgumentNotValidException是为了处理没有使用@RequestBody的参数异常