@Valid 注解 在项目中的使用经验

简介

注解 @Valid 的主要作用是用于数据效验，可以在定义的实体中的属性上，添加不同的注解来完成不同的校验规则，而在接口类中的接收数据参数中添加 @valid 注解，这时实体将会开启一个校验的功能。

背景

前段时间项目开发的时候，前端传递的参数过多且都要校验，于是出现了

    @PostMapping("/user")
    public String addUserInfo(@RequestBody User user) {
        if (user.getName() == null || "".equals(user.getName()) {
            ......
        } else if(user.getSex() == null || "".equals(user.getSex())) {
            ......
        } else if(user.getUsername() == null || "".equals(user.getUsername())) {
            ......
        } else {
            ......
        }
        ......
    }

这样的代码如果按正常代码逻辑来说，是没有什么问题的，不过看起来极其臃肿，简直糟糕透了，可读性极差。

使用

相关注解

空检查
@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null 还有去掉前后空格的长度是否大于0, 只对 字符串 ,且会去掉前后空格
@NotEmpty 检查约束元素是否为 NULL 或者是 EMPTY ；不去除 String 前后空格
 
Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  
 
长度检查
@Size(min=, max=)  验证对象长度是否在给定的范围之内；可校验 Array,Collection,Map,String
@Length(min=, max=) 验证对象长度是否在给定的范围之内；只能校验 String
 
日期检查
@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 的构成是否合法 ，integer=, fraction 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度
 
@Valid 递归的对关联对象进行校验, 一般用于内部类
@Email  验证是否是邮件地址，如果为null,不进行验证，算通过验证。

简单演示

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class User {
	private Integer userId;
    @NotBlank(message = "用户名不能为空")
    @Length(min = 4, max = 8, message = "用户名长度在4-8个字符")
    private String userName;
    @NotEmpty(message = "密码不能为空")
    @Size(min = 4, max = 8, message = "密码长度在4-8个字符")
    private String password;
}

@PostMapping(value = "/insert/user")
public String addUser(@Valid User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            System.out.println("-----------------------------------------");
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getDefaultMessage());
            }
            return "fail";
        }
        return "success";
 }

Example：

console:

这样看起来清晰好多，少了很多 if 代码，但是新的问题随之而来。例如：用户注册时，user 类的 userId不需要做校验，因为 user 的 userId 肯定是由系统生成而不是让用户自己填写的。但是在更新用户信息时，又需要传入 userId 来作为where语句的条件去更新。

分组校验

public class UserValidationGroup {
    /**
     * 添加用户的时候校验
     */
    public interface AddUser{}
    /**
     * 添加用户的时候校验
     */
    public interface UpdateUser {}
}

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class User {
    /**
     * 注意看这里，只会针对更新用户的时候校验
     */
    @NotNull(groups = UserValidationGroup.UpdateUser.class, message = "用户Id不能为空")
    private Integer userId;

    @NotBlank(message = "用户名不能为空")
    @Length(min = 4, max = 8, message = "用户名长度在4-8个字符")
    private String userName;

    @NotEmpty(message = "密码不能为空")
    @Size(min = 4, max = 8, message = "密码长度在4-8个字符")
    private String password;
}

    @PostMapping(value = "/insert/user")
    public String addUser(@Valid User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            System.out.println("-----------------------------------------");
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getDefaultMessage());
            }
            return "fail";
        }

        return "success";
    }

	/**
     * 注意看校验注解，要与实体类需要校验的属性一致
     */
    @PostMapping(value = "/update/user")
    public String updateUser(@Validated(UserValidationGroup.UpdateUser.class) User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            System.out.println("-----------------------------------------");
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getDefaultMessage());
            }
            return "fail";
        }

        return "success";
    }

这样就可以分开校验了，解决了分开校验，但是又遇到新的麻烦；更新用户时候，userId 校验了，但是userName 和 password 校验失效了；如果将分组校验加到 userName 和password 上，那么更新用户没问题，添加用户就不会做任何校验了，问题还要解决啊。

提取分组校验公共部分：

public class UserValidationGroup {
    /**
     * 通用校验
     */
    public interface CommonValid{}
    /**
     * 添加用户的时候校验
     */
    public interface AddUser extends CommonValid{}
    /**
     * 添加用户的时候校验
     */
    public interface UpdateUser extends CommonValid {}
}

public class ValidController {

    @PostMapping(value = "/insert/user")
    public String addUser(@Validated(UserValidationGroup.AddUser.class) User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            System.out.println("-----------------------------------------");
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getDefaultMessage());
            }
            return "fail";
        }

        return "success";
    }

    /**
     * 注意看校验注解，要与实体类需要校验的属性一致
     */
    @PostMapping(value = "/update/user")
    public String updateUser(@Validated(UserValidationGroup.UpdateUser.class) User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            System.out.println("-----------------------------------------");
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getDefaultMessage());
            }
            return "fail";
        }

        return "success";
    }
}

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class User {
    /**
     * 注意看这里，只会针对更新用户的时候校验
     */
    @NotNull(groups = UserValidationGroup.UpdateUser.class, message = "用户Id不能为空")
    private Integer userId;

    @NotBlank(groups = UserValidationGroup.CommonValid.class, message = "用户名不能为空")
    @Length(groups = UserValidationGroup.CommonValid.class, min = 4, max = 8, message = "用户名长度在4-8个字符")
    private String userName;

    @NotEmpty(groups = UserValidationGroup.CommonValid.class, message = "密码不能为空")
    @Size(groups = UserValidationGroup.CommonValid.class, min = 4, max = 8, message = "密码长度在4-8个字符")
    private String password;
}

随笔记录下