javax.validation.constraints 参数校验

很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者 不断的返回异常时的校验信息,在代码中相当冗长, 充满了if-else这种校验代码,今天我们就来学习spring的javax.validation 注解式参数校验.

 

为什么要用validator

  1. javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验

    不然我们的代码就像下面这样:

 1     /**
 2      * 走串行校验
 3      *
 4      * @param userVO
 5      * @return
 6      */
 7     @PostMapping("/save/serial")
 8     public Object save(@RequestBody UserVO userVO) {
 9         String mobile = userVO.getMobile();
10 
11         //手动逐个 参数校验~ 写法
12         if (StringUtils.isBlank(mobile)) {
13             return RspDTO.paramFail("mobile:手机号码不能为空");
14         } else if (!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)) {
15             return RspDTO.paramFail("mobile:手机号码格式不对");
16         }
17 
18         //抛出自定义异常等~写法
19         if (StringUtils.isBlank(userVO.getUsername())) {
20             throw new BizException(Constant.PARAM_FAIL_CODE, "用户名不能为空");
21         }
22 
23         // 比如写一个map返回
24         if (StringUtils.isBlank(userVO.getSex())) {
25             Map<String, Object> result = new HashMap<>(5);
26             result.put("code", Constant.PARAM_FAIL_CODE);
27             result.put("msg", "性别不能为空");
28             return result;
29         }
30         //.........各种写法 ...
31         userService.save(userVO);
32         return RspDTO.success();
33     }

这被大佬看见,一定说,都9102了还这么写,然后被劝退了.....

  1. 什么是javax.validation

JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:

 1 <!--jsr 303-->
 2         <dependency>
 3             <groupId>javax.validation</groupId>
 4             <artifactId>validation-api</artifactId>
 5             <version>1.1.0.Final</version>
 6         </dependency>
 7         <!-- hibernate validator-->
 8         <dependency>
 9             <groupId>org.hibernate</groupId>
10             <artifactId>hibernate-validator</artifactId>
11             <version>5.2.0.Final</version>
12         </dependency> 

 

  1. 注解说明

     1.@NotNull：不能为null，但可以为empty(""," ","   ")      
 2.@NotEmpty：不能为null，而且长度必须大于0 (" ","  ")
 3.@NotBlank：只能作用在String上，不能为null，而且调用trim()后，长度必须大于0("test")    即：必须有实际字符
验证注解验证的数据类型说明
@AssertFalse Boolean,boolean 验证注解的元素值是false
@AssertTrue Boolean,boolean 验证注解的元素值是true
@NotNull 任意类型 验证注解的元素值不是null
@Null 任意类型 验证注解的元素值是null
@Min(value=值) BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型 验证注解的元素值大于等于@Min指定的value值
@Max（value=值） 和@Min要求一样 验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值) 和@Min要求一样 验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值) 和@Min要求一样 验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数) 和@Min要求一样 验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限) 字符串、Collection、Map、数组等 验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past java.util.Date,java.util.Calendar;Joda Time类库的日期类型 验证注解的元素值（日期类型）比当前时间早
@Future 与@Past要求一样 验证注解的元素值（日期类型）比当前时间晚
@NotBlank CharSequence子类型 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限) CharSequence子类型 验证注解的元素值长度在min和max区间内
@NotEmpty CharSequence子类型、Collection、Map、数组 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值) BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型 验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式) CharSequence子类型（如String） 验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式) String，任何CharSequence的子类型 验证注解的元素值与指定的正则表达式匹配
@Valid 任何非原子类型 指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

此处只列出Hibernate Validator提供的大部分验证约束注解，请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。

实战演练

话不多说,直接走实践路线,同样使用的是SpringBoot的快速框架,详细代码见:github.com/leaJone/myb…

1. @Validated 声明要检查的参数

这里我们在控制器层进行注解声明

 1  　　/**
 2      * 走参数校验注解
 3      *
 4      * @param userDTO
 5      * @return
 6      */
 7     @PostMapping("/save/valid")
 8     public RspDTO save(@RequestBody @Validated UserDTO userDTO) {
 9         userService.save(userDTO);
10         return RspDTO.success();
11     }

2. 对参数的字段进行注解标注

 1 import lombok.Data;
 2 import org.hibernate.validator.constraints.Length;
 3 
 4 import javax.validation.constraints.*;
 5 import java.io.Serializable;
 6 import java.util.Date;
 7 
 8 /**
 9  * @author LiJing
10  * @ClassName: UserDTO
11  * @Description: 用户传输对象
12  * @date 2019/7/30 13:55
13  */
14 @Data
15 public class UserDTO implements Serializable {
16 
17     private static final long serialVersionUID = 1L;
18 
19     /*** 用户ID*/
20     @NotNull(message = "用户id不能为空")
21     private Long userId;
22     
23     /** 用户名*/
24     @NotBlank(message = "用户名不能为空")
25     @Length(max = 20, message = "用户名不能超过20个字符")
26     @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")
27     private String username;
28     
29     /** 手机号*/
30     @NotBlank(message = "手机号不能为空")
31     @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
32     private String mobile;
33 
34     /**性别*/
35     private String sex;
36 
37     /** 邮箱*/
38     @NotBlank(message = "联系邮箱不能为空")
39     @Email(message = "邮箱格式不对")
40     private String email;
41 
42     /** 密码*/
43     private String password;
44 
45     /*** 创建时间 */
46     @Future(message = "时间必须是将来时间")
47     private Date createTime;
48 
49 }

3. 在全局校验中增加校验异常

MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异常,需要在springBoot中处理,其他需要 处理ConstraintViolationException异常进行处理.

  • 为了优雅一点,我们将参数异常,业务异常,统一做了一个全局异常,将控制层的异常包装到我们自定义的异常中
  • 为了优雅一点,我们还做了一个统一的结构体,将请求的code,和msg,data一起统一封装到结构体中,增加了代码的复用性
 1 import com.boot.lea.mybot.dto.RspDTO;
 2 import org.slf4j.Logger;
 3 import org.slf4j.LoggerFactory;
 4 import org.springframework.dao.DuplicateKeyException;
 5 import org.springframework.web.bind.MethodArgumentNotValidException;
 6 import org.springframework.web.bind.annotation.ExceptionHandler;
 7 import org.springframework.web.bind.annotation.RestControllerAdvice;
 8 import org.springframework.web.servlet.NoHandlerFoundException;
 9 
10 import javax.validation.ConstraintViolationException;
11 import javax.validation.ValidationException;
12 
13 
14 /**
15  * @author LiJing
16  * @ClassName: GlobalExceptionHandler
17  * @Description: 全局异常处理器
18  * @date 2019/7/30 13:57
19  */
20 @RestControllerAdvice
21 public class GlobalExceptionHandler {
22 
23     private Logger logger = LoggerFactory.getLogger(getClass());
24 
25     private static int DUPLICATE_KEY_CODE = 1001;
26     private static int PARAM_FAIL_CODE = 1002;
27     private static int VALIDATION_CODE = 1003;
28 
29     /**
30      * 处理自定义异常
31      */
32     @ExceptionHandler(BizException.class)
33     public RspDTO handleRRException(BizException e) {
34         logger.error(e.getMessage(), e);
35         return new RspDTO(e.getCode(), e.getMessage());
36     }
37 
38     /**
39      * 方法参数校验
40      */
41     @ExceptionHandler(MethodArgumentNotValidException.class)
42     public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
43         logger.error(e.getMessage(), e);
44         return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult().getFieldError().getDefaultMessage());
45     }
46 
47     /**
48      * ValidationException
49      */
50     @ExceptionHandler(ValidationException.class)
51     public RspDTO handleValidationException(ValidationException e) {
52         logger.error(e.getMessage(), e);
53         return new RspDTO(VALIDATION_CODE, e.getCause().getMessage());
54     }
55 
56     /**
57      * ConstraintViolationException
58      */
59     @ExceptionHandler(ConstraintViolationException.class)
60     public RspDTO handleConstraintViolationException(ConstraintViolationException e) {
61         logger.error(e.getMessage(), e);
62         return new RspDTO(PARAM_FAIL_CODE, e.getMessage());
63     }
64 
65     @ExceptionHandler(NoHandlerFoundException.class)
66     public RspDTO handlerNoFoundException(Exception e) {
67         logger.error(e.getMessage(), e);
68         return new RspDTO(404, "路径不存在，请检查路径是否正确");
69     }
70 
71     @ExceptionHandler(DuplicateKeyException.class)
72     public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {
73         logger.error(e.getMessage(), e);
74         return new RspDTO(DUPLICATE_KEY_CODE, "数据重复，请检查后提交");
75     }
76 
77 
78     @ExceptionHandler(Exception.class)
79     public RspDTO handleException(Exception e) {
80         logger.error(e.getMessage(), e);
81         return new RspDTO(500, "系统繁忙,请稍后再试");
82     }
83 }

4. 测试

如下文:确实做到了参数校验时返回异常信息和对应的code,方便了我们不再繁琐的处理参数校验

 

在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析

自定义参数注解

1. 比如我们来个 自定义身份证校验 注解

 1 @Documented
 2 @Target({ElementType.PARAMETER, ElementType.FIELD})
 3 @Retention(RetentionPolicy.RUNTIME)
 4 @Constraint(validatedBy = IdentityCardNumberValidator.class)
 5 public @interface IdentityCardNumber {
 6 
 7     String message() default "身份证号码不合法";
 8 
 9     Class<?>[] groups() default {};
10 
11     Class<? extends Payload>[] payload() default {};
12 }

这个注解是作用在Field字段上，运行时生效，触发的是IdentityCardNumber这个验证类。

  • message 定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定制
  • groups 这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作
  • payload 主要是针对bean的，使用不多。

2. 然后自定义Validator

这个是真正进行验证的逻辑代码：

 1 public class IdentityCardNumberValidator implements ConstraintValidator<IdentityCardNumber, Object> {
 2 
 3     @Override
 4     public void initialize(IdentityCardNumber identityCardNumber) {
 5     }
 6 
 7     @Override
 8     public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
 9         return IdCardValidatorUtils.isValidate18Idcard(o.toString());
10     }
11 }

IdCardValidatorUtils在项目源码中,可自行查看

3. 使用自定义的注解

1     @NotBlank(message = "身份证号不能为空")
2     @IdentityCardNumber(message = "身份证信息有误,请核对后提交")
3     private String clientCardNo;

4.使用groups的校验

有的宝宝说同一个对象要复用,比如UserDTO在更新时候要校验userId,在保存的时候不需要校验userId,在两种情况下都要校验username,那就用上groups了:

先定义groups的分组接口Create和Update

import javax.validation.groups.Default;

public interface Create extends Default {
}

import javax.validation.groups.Default;

public interface Update extends Default{
}

再在需要校验的地方@Validated声明校验组

  
　　 /**
     * 走参数校验注解的 groups 组合校验
     *
     * @param userDTO
     * @return
     */
    @PostMapping("/update/groups")
    public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
        userService.updateById(userDTO);
        return RspDTO.success();
    }

在DTO中的字段上定义好groups = {}的分组类型

  
 1 @Data
 2 public class UserDTO implements Serializable {
 3 
 4     private static final long serialVersionUID = 1L;
 5 
 6     /*** 用户ID*/
 7     @NotNull(message = "用户id不能为空", groups = Update.class)
 8     private Long userId;
 9 
10     /**
11      * 用户名
12      */
13     @NotBlank(message = "用户名不能为空")
14     @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})
15     @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")
16     private String username;
17 
18     /**
19      * 手机号
20      */
21     @NotBlank(message = "手机号不能为空")
22     @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误", groups = {Create.class, Update.class})
23     private String mobile;
24 
25     /**
26      * 性别
27      */
28     private String sex;
29 
30     /**
31      * 邮箱
32      */
33     @NotBlank(message = "联系邮箱不能为空")
34     @Email(message = "邮箱格式不对")
35     private String email;
36 
37     /**
38      * 密码
39      */
40     private String password;
41 
42     /*** 创建时间 */
43     @Future(message = "时间必须是将来时间", groups = {Create.class})
44     private Date createTime;
45 
46 }

注意:在声明分组的时候尽量加上 extend javax.validation.groups.Default 否则,在你声明@Validated(Update.class) 的时候,就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮箱格式不对"),会不去校验,因为默认的校验组是groups = {Default.class}.

5.restful风格用法

在多个参数校验,或者@RequestParam 形式时候,需要在controller上加注@Validated

1  　　@GetMapping("/get")
2     public RspDTO getUser(@RequestParam("userId") @NotNull(message = "用户id不能为空") Long userId) {
3         User user = userService.selectById(userId);
4         if (user == null) {
5             return new RspDTO<User>().nonAbsent("用户不存在");
6         }
7         return new RspDTO<User>().success(user);
8     }
1 @RestController
2 @RequestMapping("user/")
3 @Validated
4 public class UserController extends AbstractController {
5 
6 ....圣洛代码...

总结

用起来很简单,soEasy,重点参与的统一结构体返回,统一参数校验,是减少我们代码大量的try catch 的法宝,我觉得在项目中,将异常处理好,并将异常做好日志管理,才是很好的升华,文章浅显,只是一个菜鸟的进阶笔记....

这里只是个人见解,技术菜,欢迎大佬不吝赐教... 我是一个小白,技术在不断的更新迭代,我只有不断的填充自己的空白才能....跟上大佬们的步伐...


作者：锦成同学
链接：https://juejin.cn/post/6844903902811275278
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

posted on 2023-05-22 17:23  天军  阅读(1416)  评论(0)  编辑  收藏  举报

导航