JSR303

简介

JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现。 Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。
下载 JSR 303 – Bean Validation 规范 http://jcp.org/en/jsr/detail?id=303
如果想了解更多有关 Hibernate Validator 的信息，请查看 http://www.hibernate.org/subprojects/validator.html

Bean Validation 中的 constraint

Hibernate Validator 附加的 constraint

空检查
@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=)

使用步骤

导包

    <dependency>
      <groupId>org.hibernate.validator</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>6.0.16.Final</version>
      <scope>compile</scope>
    </dependency>

配置

1. 在controller的类上加上@Validated注解

@Validated
@RestController
public class ClauseInfoController {}

1. 当时基本类型请求参数

@GetMapping("/xxxx")
public ObjectRestResponse<String> 
  queryAllStaffList(@RequestParam @NotBlank(message = "部门ID不能为空") String departmentKey) {
    List<ResultDataVO> staff = clauseInfoService.queryAllStaffList(departmentKey);
    return ObjectRestResponse.success().data(staff);
}

1. 对象参数

@PostMapping("/xxxxx")
public ObjectRestResponse<String> 
addSppiTableList(@RequestBody @Valid ProjectClauseParam projectClauseParam) {
     clauseInfoService.addSppiTableList(projectClauseParam);
     return ObjectRestResponse.success().data(ConfigConstant.RESULT_SUCCESS);
}
@Data
public class ProjectClauseParam {
    @NotBlank(message = "项目名称不能为空")
    @Length(max = 100, message = "项目名称长度不能超过100")
    private String projectName;
    @NotBlank(message = "参与人不能为空")
    private String participantKey;
}

异常处理

import com.clamc.common.msg.ObjectRestResponse;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.stream.Collectors;
/**
 * @author guojianfeng.
 * @date 2019/11/7
 */
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
    @ExceptionHandler({ConstraintViolationException.class,BindException.class})
    public ObjectRestResponse<String> exceptionHandler1(HttpServletRequest request, Exception exception) {
        ObjectRestResponse response = new ObjectRestResponse();
        response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
        if (exception instanceof ConstraintViolationException){
            ConstraintViolationException ex = (ConstraintViolationException) exception;
            String errorMsg = ex.getConstraintViolations().iterator().next().getMessage();
            response.setMessage(errorMsg);
        }else {
            /*注意：此处的BindException 是 Spring 框架抛出的Validation异常*/
            BindException ex = (BindException) exception;
            /*抛出异常可能不止一个 输出为一个List集合*/
            List<String> errors = ex.getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.toList());
            /*获取异常信息*/
            String errorMsg = StringUtils.join(errors);
            response.setMessage(errorMsg);
        }
        return response.rel(false);
    }
}

自动定义参数校验

定义注解

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {
    boolean required() default true;
    String message() default "手机号码格式错误";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

继承 ConstraintValidator

ConstraintValidator

• IsMobile 是我们定义的注解
• String 是这个注解修改时类型

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
    private boolean required = false;
    @Override
    public void initialize(IsMobile constraintAnnotation) {
        required = constraintAnnotation.required();
    }
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (required) {
            return ValidatorUtil.isMobile(value);
        } else {
            if (StringUtils.isEmpty(value)) {
                return true;
            } else {
                return ValidatorUtil.isMobile(value);
            }
        }
    }
}
 ----------------------------------------------------------------------------------- 
public class ValidatorUtil {
    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
    public static boolean isMobile(String src) {
        if (StringUtils.isEmpty(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }
}