Springboot 使用校验框架validation校验

b/s系统中对http请求数据的校验多数在客户端进行，这也是出于简单及用户体验性上考虑，但是在一些安全性要求高的系统中服务端校验是不可缺少的。

Spring3支持JSR-303验证框架，JSR-303 是Java EE 6 中的一项子规范，叫做BeanValidation，官方参考实现是hibernate Validator（与Hibernate ORM 没有关系），JSR 303 用于对Java Bean 中的字段的值进行验证。

validation与 springboot 结合

依赖

  <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.0.16.Final</version>
        </dependency>

1. bean 中添加标签

部分代码：

标签需要加在属性上，@NotBlank 标签含义文章末尾有解释

public class User {
 private Integer id;
 @NotBlank(message = "{user.name.notBlank}")
 private String name;
 private String username;

2. Controller中开启验证

在Controller 中 请求参数上添加@Validated 标签开启验证

    @RequestMapping(method = RequestMethod.POST)
    public User create(@RequestBody @Validated User user) {
  return userService.create(user);
    }

  @RequestMapping(method = RequestMethod.GET)
    public User  getUserById(@NotNull(message = "id不能为空")  int userId)  {
       return userService.getUserById(userId);
    }

3. resource 下新建错误信息配置文件

当然 message 信息也可以配置在标签后面例如

public class User {
 private Integer id;
 @NotBlank(message = "名字不能为空")
 private String name;
 private String username;

也可以在resource 目录下新建提示信息配置文件“ValidationMessages.properties“ 这样可以全局统一管理错误消息

注意：名字必须为“ValidationMessages.properties“ 因为SpringBoot自动读取classpath中的ValidationMessages.properties里的错误信息

ValidationMessages.properties 文件的编码为ASCII。数据类型为 key value 。

• key“user.name.notBlank“为第一步 bean的标签 大括号里面对应message的值

• value 为提示信息 ，但是是ASCII 。（内容为“名字不能为空“）

4. 自定义异常处理器，捕获错误信息

当验证不通过时会抛异常出来，异常的message 就是 ValidationMessages.properties 中配置的提示信息。

此处定义异常处理器。捕获异常信息（因为验证不通过的项可能是多个所以统一捕获处理），并抛给前端。（此处是前后端分离开发）

 @ExceptionHandler(MethodArgumentNotValidException.class)
    public void MethodArgumentNotValidException(Exception ex, HttpServletRequest request, HttpServletResponse response) {
        logger.error( ":" + CommonUtil.getHttpClientInfo(request), ex);
        MethodArgumentNotValidException c = (MethodArgumentNotValidException) ex;
        List<ObjectError> errors =c.getBindingResult().getAllErrors();
        StringBuffer errorMsg=new StringBuffer();
        errors.stream().forEach(x -> errorMsg.append(x.getDefaultMessage()).append(";"));
        pouplateExceptionResponse(response, HttpStatus.INTERNAL_SERVER_ERROR, errorMsg.toString());
    }


 private void pouplateExceptionResponse(HttpServletResponse response, HttpStatus errorCode, String errorMessage) {
        try {
            response.sendError(errorCode.value(), errorMessage);
        } catch (IOException e) {
            logger.error("failed to populate response error", e);
        }
    }

5. 附上部分标签含义

示例

 @Pattern(regexp="^[a-zA-Z0-9]+$",message="{account.username.space}")
 @Size(min=3,max=20,message="{account.username.size}")

如果上述的参数校验不满足要求可以 考虑自定义注解

自定义注解校验

步骤：

1、定义注解， 2、实现校验逻辑

用法

public class MySaveArgs {
    @NotEmpty
    @MustBeMyCode
    private String code;

定义注解

@Constraint(
        validatedBy = {MyCodeConstraintValidator.class}
)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MustBeMyCode {

    String message() default "编码校验不通过";

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

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

实现ConstraintValidator 接口，编写自己的校验逻辑，

public class MyCodeConstraintValidator implements ConstraintValidator<MustBeMyCode, String> {
  
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
  //此处编写自己的校验逻辑，并返回
        return value != null;
    }
}

注意：ConstraintValidator<MustBeMyCode, String> 此处应填写你自己的校验注解名 和 需校验参数类型