validation

JSR303 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们 JavaBean 的属性上面
javax.validation主要用于进行提交表单时的参数校验，通过注解的形式进行校验，可以免于大量冗余的if-else工作

快速入门

以下为关于validation再实际开发中的简单应用

package com.fischer.data;
@Getter
@JsonRootName("user")
@AllArgsConstructor
@NoArgsConstructor
@Validated
public class RegisterParam {
    @NotBlank(message = "邮箱不能为空")
    @Email(message = "请填写格式正确的邮箱")
    @DuplicatedEmailConstraint
    private String email;
    @NotBlank(message = "请给自己起个名字")
    @DuplicatedUsernameConstraint
    private String username;
    @NotBlank(message = "密码不能为空")
    @Pattern(regexp = "[a-zA-Z0-9]{3,20}",message = "密码格式应为：3到20位的大小写字母以及数字的组合")
    private String password;
}

在成员变量的上方添加注解，其中涉及到了validation自带的注解和自定义的验证注解，对成员变量按照注解的规则进行校验，当验证不通过时，便抛出异常MethodArgumentNotValidException,之后便可以对异常进行处理，满足开发需求

依赖

JSR303可以视为只是一套用于验证的规范，真正的数据校验要依赖于Hibernate校验框架，因此导入依赖时应当将二者一同导入，在 SpringBoot 中已经包含在 starter-web 中, 再其他项目中可以引用依赖, 并自行调整版本:

<!--jsr 303-->
        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>1.1.0.Final</version>
        </dependency>
        <!-- hibernate validator-->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>5.2.0.Final</version>
        </dependency>

常用注解

hibernate validator官方文档：Documentation - Hibernate Validator
以下只给出较为常用的注解，详细情况可以去官方文档查找

实际应用

pojo

创建实体类并添加认证

package com.fischer.pojo;
@Data
public class User {
    @NotNull(message = "用户Id不能为空")
    private Long userId;
    @NotBlank(message = "用户名不能为空")
    @Length(max = 12,message = "用户名最长为12个字符")
    private String username;
    @NotBlank(message = "手机号码不能为空")
    @Pattern(regexp = "1[3-9]\\d{9}",message = "手机号码格式有误")
    private String mobile;
    private String sex;
    @Email(message = "邮箱格式有误")
    private String email;
    @Pattern(regexp = "[a-zA-Z0-9]{6,20}",message = "密码格式不正确")
    private String password;
}

Controller

创建Controller用于测试

package com.fischer.api;
@RestController
@RequestMapping(path = "user")
public class UserApi {
    @PostMapping
    public ResponseEntity addUser(@Validated @RequestBody User user){
        return ResponseEntity.ok(user);
    }
}

异常处理

创建全局异常处理类，抓取校验失败异常，直接在控制台输出即可

package com.fischer.exception;
@ControllerAdvice
public class GlobalExceptionHandler {
Logger logger= LoggerFactory.getLogger(GlobalExceptionHandler.class);
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity MotValidHandler(HttpServletRequest req, MethodArgumentNotValidException e){
        for (ObjectError allError : e.getAllErrors()) {
            String defaultMessage = allError.getDefaultMessage();
            logger.error("验证未通过！原因为："+defaultMessage);
        }
        return new ResponseEntity(HttpStatus.BAD_REQUEST);
    }
}

测试

提交的表单数据：

{
    "userId": null,
    "username": "",
    "mobile": "186690031",
    "sex": "ut",
    "email": "2388231qq.com",
    "password": "litangdingzhendianziyanwangzi"
}

可以看到，userId,username,moblie,email,password均不满足要求
在控制台输出结果：

达到了预期的验证效果
此外，还可以在类上面标注@Validated，表示开启全局认证，然后再需要认证的地方添加@Valid，表示对该数据进行认证，如下：

package com.fischer.api;
@RestController
@RequestMapping(path = "user")
@Validated
public class UserApi {
    @PostMapping
    public ResponseEntity addUser(@Valid @RequestBody User user){
        return ResponseEntity.ok(user);
    }
}

自定义参数注解

当hibernate validator提供的默认注解无法满足我们的需求时，便可以添加自定义注解
自定义注解分为两部分，分别是返回信息的Constraint和用于逻辑验证的Validator

• Contraint

  package com.fischer.service.article;
  @Documented
  @Constraint(validatedBy = DuplicatedArticleValidator.class)
  @Target({ElementType.METHOD,ElementType.FIELD,ElementType.PARAMETER,ElementType.TYPE_USE})
  @Retention(RetentionPolicy.CLASS)
  public @interface DuplicatedArticleConstraint {
    String message() default "该文章的标题已存在";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
  }

• @Constraint指定提供逻辑验证的类

  • message定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定制
  • groups 这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作
  • payload 主要是针对bean的，使用不多。
• group的使用方式暂时还为大看懂，等待后续再进行补充
  
• Validator

  class DuplicatedArticleValidator
  implements ConstraintValidator<DuplicatedArticleConstraint,String> {
    @Autowired
    private ArticleQueryService articleQueryService;
    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        return !articleQueryService.findBySlug(Article.toSlug(value),null).isPresent();
    }
  }

参考：这么写参数校验(validator)就不会被劝退了~ - 掘金 (juejin.cn)