优秀网文 / 从零搭建开发脚手架 从零搭建开发脚手架（二） 2021-04-22 # 从零搭建开发脚手架 Spring Boot 输入参数校验多种方式整理 [TOC] ## 文章背景 当涉及到用户输入时，就需要对输入的内容做校验，例如：姓名不能为空，年龄范围为0-150等等。我们使用Spring Boot内置的验证来实现此功能。 > 从Spring Boot 2.3开始，我们需要显式添加spring-boot-starter-validation依赖项： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` ## 常见场景 ### 一、场景A 简单方法参数验证 **控制器：** > 控制类：加注解@Validated；方法参数：加特定验证注解 ```java @RestController @Slf4j @Validated public class ValidatorController { @RequestMapping("/validator") public Response validatorParam(@NotBlank(message = "姓名不能为空") String name, @Min(value = 0, message = "年龄应大于等于0") @Max(value = 150, message = "年龄应小于等于150") String age) { return Response.ok(); } ``` **验证：**  ### 二、场景B 对带有验证注解的实体Bean参数验证 **待验证实体：** ```java @Data @Builder public class LakerUser { /** * 姓名 */ @NotBlank(message = "姓名不能为空") private String name; /** * 年龄 */ @Min(value = 0, message = "年龄应大于等于0") @Min(value = 150, message = "年龄应小于等于150") private int age; /** * 手机号 */ @NotBlank(message = "手机号不能为空") @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误") private String mobile; } ``` > 注：@Builder注释为你的类生成相对略微复杂的构建器API，@Builder可以让你以： ```java Student.builder() .sno( "001" ) .sname( "admin" ) .sage( 18 ) .sphone( "110" ) .build(); ``` 的方式实例化对象。 具体参考（待）： - https://www.jianshu.com/p/d08e255312f9 - https://blog.csdn.net/djrm11/article/details/104653877/ #### 1.入参为实体Bean **控制器：** > 方法入参：加上@Validated ```java @RequestMapping("/lakeruser") public Response validatorBean(@RequestBody @Validated LakerUser lakerUser) { return Response.ok(); } ``` **全局异常处理:** ```java @RestControllerAdvice("com.laker.notes") @Slf4j public class GlobalExceptionHandler { /** * 验证bean类型 */ @ExceptionHandler(MethodArgumentNotValidException.class) public Response handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { log.error(e.getMessage(), e); List<Map> result = new ArrayList<>(); e.getBindingResult().getFieldErrors().forEach((fieldError) -> { result.add(Dict.create().set("field", fieldError.getField()).set("msg", fieldError.getDefaultMessage())); }); return Response.error(result); } ... ``` **验证：**   #### 2.入参为List<实体Bean> **控制器：** > 方法入参：加@Valid，同时在控制层：添加@Validated注解 ```java @RestController @Slf4j @Validated public class ValidatorController { @RequestMapping("/lakerusers") public Response validatorListBean(@RequestBody @Valid List<LakerUser> lakerUser) { return Response.ok(); } ``` **验证：**   #### 3.手工验证 **创建工具类：** ```java public class ValidatorUtils { private static Validator validator; static { // 正常模式 validator = Validation.byProvider(HibernateValidator.class) .configure() //快速故障模式。启用快速失败时，验证将在检测到第一个约束违规时停止 .failFast(false) .buildValidatorFactory() .getValidator(); } /** * 校验对象 */ public static <T> void validate(T object, Class<?>... groups) { Set<ConstraintViolation<T>> constraintViolationSet = validator.validate(object, groups); if (!constraintViolationSet.isEmpty()) { throw new ConstraintViolationException(constraintViolationSet); } } } ``` **控制器：**手工调用 ```java @RequestMapping("/util") public Response validatorUtil(@RequestBody LakerUser lakerUser) { ValidatorUtils.validate(lakerUser);// 任意业务逻辑前后调用 return Response.ok(); } ```   ## 扩展知识 ### 1.@Validated 和 @Valid 的异同 - @Validated 是 Spring 实现的JSR-303@Valid的变体 ，支持验证组的规范。 - @Valid 是JSR-303标准实现的校验注解。 | 注解 | 范围 |嵌套 |校验组 | | -----| ----- | ---- | ------| | @Validated | 可以标记类、方法、方法参数，不能用在成员属性（字段）上 | 不支持 | 支持 | | @Valid | 可以标记方法、构造函数、方法参数和成员属性（字段）上 | 支持 | 不支持 | > 两者都可以用在方法入参上，但都无法单独提供嵌套验证功能，都能配合嵌套验证注解@Valid进行嵌套验证。 **嵌套验证示例:** ```java public class ClassRoom{ @NotNull String name; @Valid // 嵌套校验，校验参数内部的属性 @NotNull Student student; } @GetMapping("/room") // 此处可使用 @Valid 或 @Validated, 将会进行嵌套校验 public String validator(@Validated ClassRoom classRoom, BindingResult result) { if (result.hasErrors()) { return result.getFieldError().getDefaultMessage(); } return "ok"; } ``` ### 2.快速故障模式 快速故障模式：启用快速失败时，验证将在检测到第一个约束违规时停止，**默认是非快速故障模式。** ```java // 正常模式 validator = Validation.byProvider(HibernateValidator.class) .configure() //快速故障模式。启用快速失败时，验证将在检测到第一个约束违规时停止 .failFast(true) .buildValidatorFactory() .getValidator(); ``` ### 3.验证相关注解和说明 | 验证注解 | 验证的数据类型 | 说明 | | -------- | -------------- | ---- | | @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的子类型 |验证注解的元素值与指定的正则表达式匹配 | ### 4.自定义验证注解 **1.创建自定义注解** ```java @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD,ElementType.PARAMETER}) @Constraint(validatedBy = FlagValidatorClass.class) // 绑定对应校验器 public @interface FlagValidator { String[] value() default {}; String message() default "flag is not found"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` **2.编写对应校验器** ```java /** * 标志位校验器 */ public class FlagValidatorClass implements ConstraintValidator<FlagValidator, Integer> { private String[] values; /** * 初始化 * * @param flagValidator 注解上设置的值 */ @Override public void initialize(FlagValidator flagValidator) { this.values = flagValidator.value(); } /** * 校验 * * @param value 被校验的值，即输入 * @param constraintValidatorContext 校验上下文 * @return 返回true证明校验通过，false校验失败 */ @Override public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) { boolean isValid = false; // 当value为null，校验失败 if (value == null) { return false; } //遍历校验 for (int i = 0; i < values.length; i++) { if (values[i].equals(String.valueOf(value))) { isValid = true; break; } } return isValid; } } ``` **3.属性注解** ```java @NotNull(message = "标识位不能为空") @FlagValidator(value = {"0", "1"}, message = "标志位有误") private Integer flag; ``` /** ## 参考： - https://www.cnblogs.com/sueyyyy/p/12865578.html - https://blog.csdn.net/abu935009066/article/details/114001409
