SpringBoot参数校验Validator框架怎么使用

这篇“SpringBoot参数校验Validator框架怎么使用”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“SpringBoot参数校验Validator框架怎么使用”文章吧。

SpringBoot 如何进行参数校验

在日常的接口开发中，为了防止非法参数对业务造成影响，经常需要对接口的参数做校验，例如登录的时候需要校验用户名密码是否为空，创建用户的时候需要校验邮件、手机号码格式是否准确。靠代码对接口参数一个个校验的话就太繁琐了，代码可读性极差。

Validator框架就是为了解决开发人员在开发的时候少写代码，提升开发效率；Validator专门用来进行接口参数校验，例如常见的必填校验，email格式校验，用户名必须位于6到12之间 等等…

Validator校验框架遵循了JSR-303验证规范（参数校验规范）, JSR是Java Specification Requests的缩写。

1.集成Validator校验框架

1.1. 引入依赖包

<dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-web</artifactId></dependency><dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-validation</artifactId></dependency>

注：从springboot-2.3开始，校验包被独立成了一个starter组件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依赖就可以了。

注：此表格只是简单的对注解功能的说明，并没有对每一个注解的属性进行说明；可详见源码。

1.2. 定义要参数校验的实体类

@Datapublic class ValidVO {    private String id;    @Length(min = 6,max = 12,message = "appId长度必须位于6到12之间")    private String appId;    @NotBlank(message = "名字为必填项")    private String name;    @Email(message = "请填写正确的邮箱地址")    private String email;    private String sex;    @NotEmpty(message = "级别不能为空")    private String level;}

在实际开发中对于需要校验的字段都需要设置对应的业务提示，即message属性。

1.3. 定义校验类进行测试

@RestController@Slf4j@Validatedpublic class ValidController {    @ApiOperation("RequestBody校验")    @PostMapping("/valid/test1")       public String test1(@Validated @RequestBody ValidVO validVO){        log.info("validEntity is {}", validVO);        return "test1 valid success";    }    @ApiOperation("Form校验")    @PostMapping(value = "/valid/test2")    public String test2(@Validated ValidVO validVO){        log.info("validEntity is {}", validVO);        return "test2 valid success";    }    @ApiOperation("单参数校验")    @PostMapping(value = "/valid/test3")    public String test3(@Email String email){        log.info("email is {}", email);        return "email valid success";    }}

这里我们先定义三个方法test1，test2，test3，

test1使用了@RequestBody注解，用于接受前端发送的json数据，

test2模拟表单提交，

test3模拟单参数提交。

注意，当使用单参数校验时需要在Controller上加上@Validated注解，否则不生效。

1.4. 测试结果1

test1的测试结果

发送值

POST http://localhost:8080/valid/test1Content-Type: application/json{  "id": 1,  "level": "12",  "email": "47693899",  "appId": "ab1c"}

返回值

提示的是org.springframework.web.bind.MethodArgumentNotValidException异常

{  "status": 500,  "message": "Validation failed for argument [0] in public java.lang.String com.jianzh6.blog.valid.ValidController.test1(com.jianzh6.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一个合法的电子邮件地址]]...",  "data": null,  "timestamp": 1628239624332}

test2的测试结果

发送值

POST http://localhost:8080/valid/test2Content-Type: application/x-www-form-urlencodedid=1&level=12&email=476938977&appId=ab1c

返回值

提示的是org.springframework.validation.BindException异常

{  "status": 500,  "message": "org.springframework.validation.BeanPropertyBindingResult: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字为必填项]...",  "data": null,  "timestamp": 1628239301951}

test3的测试结果

发送值

POST http://localhost:8080/valid/test3Content-Type: application/x-www-form-urlencodedemail=476938977

返回值

提示的是javax.validation.ConstraintViolationException异常

{  "status": 500,  "message": "test3.email: 不是一个合法的电子邮件地址",  "data": null,  "timestamp": 1628239281022}

1.5. 问题

虽然我们之前定义了全局异常拦截器，也看到了拦截器确实生效了，但是Validator校验框架返回的错误提示太臃肿了，不便于阅读，为了方便前端提示，我们需要将其简化一下。

通过将参数异常加入全局异常来解决

1.6. 将参数异常加入全局异常

直接修改之前定义的RestExceptionHandler，单独拦截参数校验的三个异常：

javax.validation.ConstraintViolationException，

org.springframework.validation.BindException，

org.springframework.web.bind.MethodArgumentNotValidException，

@Slf4j@RestControllerAdvicepublic class RestExceptionHandler {        @ExceptionHandler(Exception.class)    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)    public ResultData<String> exception(Exception e) {        log.error("全局异常信息 ex={}", e.getMessage(), e);        return ResultData.fail(ReturnCode.RC500.getCode(),e.getMessage());    }        @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})    public ResponseEntity<ResultData<String>> handleValidatedException(Exception e) {        ResultData<String> resp = null;        if (e instanceof MethodArgumentNotValidException) {            // BeanValidation exception            MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;            resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),                    ex.getBindingResult().getAllErrors().stream()                            .map(ObjectError::getDefaultMessage)                            .collect(Collectors.joining("; "))            );        } else if (e instanceof ConstraintViolationException) {            // BeanValidation GET simple param            ConstraintViolationException ex = (ConstraintViolationException) e;            resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),                    ex.getConstraintViolations().stream()                            .map(ConstraintViolation::getMessage)                            .collect(Collectors.joining("; "))            );        } else if (e instanceof BindException) {            // BeanValidation GET object param            BindException ex = (BindException) e;            resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),                    ex.getAllErrors().stream()                            .map(ObjectError::getDefaultMessage)                            .collect(Collectors.joining("; "))            );        }        return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);    }    }

1.7. 测试结果2

test1测试结果

发送值

POST http://localhost:8080/valid/test1Content-Type: application/json{  "id": 1,  "level": "12",  "email": "47693899",  "appId": "ab1c"}

接收值

{  "status": 400,  "message": "名字为必填项; 不是一个合法的电子邮件地址; appId长度必须位于6到12之间",  "data": null,  "timestamp": 1628435116680}

2. 自定义注解

虽然Spring Validation 提供的注解基本上够用，但是面对复杂的定义，我们还是需要自己定义相关注解来实现自动校验。

比如上面实体类中的sex性别属性，只允许前端传递传 M，F 这2个枚举值，如何实现呢？

2.1. 第一步，创建自定义注解

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})@Retention(RUNTIME)@Repeatable(EnumString.List.class)@Documented@Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑public @interface EnumString {    String message() default "value not in enum values.";    Class<?>[] groups() default {};    Class<? extends Payload>[] payload() default {};        String[] value();        @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})    @Retention(RUNTIME)    @Documented    @interface List {        EnumString[] value();    }}

可以根据Validator框架定义好的注解来仿写，基本上一致

2.2. 第二步，自定义校验逻辑

public class EnumStringValidator implements ConstraintValidator<EnumString, String> {    private List<String> enumStringList;    @Override    public void initialize(EnumString constraintAnnotation) {        enumStringList = Arrays.asList(constraintAnnotation.value());    }    @Override    public boolean isValid(String value, ConstraintValidatorContext context) {        if(value == null){            return true;        }        return enumStringList.contains(value);    }}

2.3. 第三步，在字段上增加注解

@ApiModelProperty(value = "性别")@EnumString(value = {"F","M"}, message="性别只允许为F或M")private String sex;

2.4. 第四步，体验效果

POST http://localhost:8080/valid/test2Content-Type: application/x-www-form-urlencodedid=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N

{  "status": 400,  "message": "性别只允许为F或M",  "data": null,  "timestamp": 1628435243723}

3. 分组校验

一个VO对象在新增的时候某些字段为必填，在更新的时候又非必填。如上面的ValidVO中 id 和 appId 属性在新增操作时都是非必填，而在编辑操作时都为必填，name在新增操作时为必填，面对这种场景你会怎么处理呢？

在实际开发中我见到很多同学都是建立两个VO对象，ValidCreateVO，ValidEditVO来处理这种场景，这样确实也能实现效果，但是会造成类膨胀。

其实Validator校验框架已经考虑到了这种场景并且提供了解决方案，就是分组校验，只不过很多同学不知道而已。

要使用分组校验，只需要三个步骤

3.1. 第一步，定义分组接口

public interface ValidGroup extends Default {    interface Crud extends ValidGroup{        interface Create extends Crud{        }        interface Update extends Crud{        }        interface Query extends Crud{        }        interface Delete extends Crud{        }    }}

这里我们定义一个分组接口ValidGroup让其继承javax.validation.groups.Default，再在分组接口中定义出多个不同的操作类型，Create，Update，Query，Delete。

3.2. 第二步，在模型中给参数分配分组

@Datapublic class ValidVO {    @Null(groups = ValidGroup.Crud.Create.class)    @NotNull(groups = ValidGroup.Crud.Update.class, message = "应用ID不能为空")    private String id;    @Length(min = 6,max = 12,message = "appId长度必须位于6到12之间")    @Null(groups = ValidGroup.Crud.Create.class)    @NotNull(groups = ValidGroup.Crud.Update.class, message = "应用ID不能为空")    private String appId;    @NotBlank(message = "名字为必填项")    @NotBlank(groups = ValidGroup.Crud.Create.class,message = "名字为必填项")    private String name;    @Email(message = "请填写正确的邮箱地址")    private String email;    @EnumString(value = {"F","M"}, message="性别只允许为F或M")    private String sex;    @NotEmpty(message = "级别不能为空")    private String level;}

给参数指定分组，对于未指定分组的则使用的是默认分组。

3.3. 第三步，给需要参数校验的方法指定分组

    @PostMapping(value = "/valid/add")    public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){        log.info("validEntity is {}", validVO);        return "test3 valid success";    }    @PostMapping(value = "/valid/update")    public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){        log.info("validEntity is {}", validVO);        return "test4 valid success";    }

这里我们通过value属性给add()和update()方法分别指定Create和Update分组

3.4. 测试

POST http://localhost:8080/valid/addContent-Type: application/x-www-form-urlencodedname=javadaily&level=12&email=476938977@qq.com&sex=F

Create操作

在Create时我们没有传递id和appId参数，校验通过。

{"status": 100,"message": "操作成功","data": "test3 valid success","timestamp": 1652186105359}

update操作

使用同样的参数调用update方法时则提示参数校验错误

{"status": 400,"message": "ID不能为空; 应用ID不能为空","data": null,"timestamp": 1652186962377}

默认校验生效操作

由于email属于默认分组，而我们的分组接口ValidGroup已经继承了Default分组，所以也是可以对email字段作参数校验的。

故意写错email格式

POST http://localhost:8080/valid/addContent-Type: application/x-www-form-urlencoded/valid/update?name=javadaily&level=12&email=476938977&sex=F

{"status": 400,"message": "请填写正确的邮箱地址; ID不能为空; 应用ID不能为空","data": null,"timestamp": 1652187273865}

4. 业务规则校验

业务规则校验指接口需要满足某些特定的业务规则，举个例子：业务系统的用户需要保证其唯一性，用户属性不能与其他用户产生冲突，不允许与数据库中任何已有用户的用户名称、手机号码、邮箱产生重复。

这就要求在创建用户时需要校验用户名称、手机号码、邮箱是否被注册；编辑用户时不能将信息修改成已有用户的属性。

最优雅的实现方法应该是参考 Bean Validation 的标准方式，借助自定义校验注解完成业务规则校验。

4.1. 自定义注解

首先我们需要创建两个自定义注解，用于业务规则校验：

• UniqueUser:表示一个用户是唯一的，唯一性包含：用户名，手机号码、邮箱

  @Documented@Retention(RUNTIME)@Target({FIELD, METHOD, PARAMETER, TYPE})@Constraint(validatedBy = UserValidation.UniqueUserValidator.class)public @interface UniqueUser {    String message() default "用户名、手机号码、邮箱不允许与现存用户重复";    Class<?>[] groups() default {};    Class<? extends Payload>[] payload() default {};}

• NotConflictUser:表示一个用户的信息是无冲突的，无冲突是指该用户的敏感信息与其他用户不重合

  @Documented@Retention(RUNTIME)@Target({FIELD, METHOD, PARAMETER, TYPE})@Constraint(validatedBy = UserValidation.NotConflictUserValidator.class)public @interface NotConflictUser {    String message() default "用户名称、邮箱、手机号码与现存用户产生重复";    Class<?>[] groups() default {};    Class<? extends Payload>[] payload() default {};}

4.2. 实现业务校验规则

想让自定义验证注解生效，需要实现 ConstraintValidator 接口。

接口的第一个参数是 自定义注解类型，第二个参数是 被注解字段的类，因为需要校验多个参数，我们直接传入用户对象。需要提到的一点是 ConstraintValidator 接口的实现类无需添加 @Component 它在启动的时候就已经被加载到容器中了。

@Slf4jpublic class UserValidation<T extends Annotation> implements ConstraintValidator<T, User> {    protected Predicate<User> predicate = c -> true;    @Resource    protected UserRepository userRepository;    @Override    public boolean isValid(User user, ConstraintValidatorContext constraintValidatorContext) {        return userRepository == null || predicate.test(user);    }        public static class UniqueUserValidator extends UserValidation<UniqueUser>{        @Override        public void initialize(UniqueUser uniqueUser) {            predicate = c -> !userRepository.existsByUserNameOrEmailOrTelphone(c.getUserName(),c.getEmail(),c.getTelphone());        }    }        public static class NotConflictUserValidator extends UserValidation<NotConflictUser>{        @Override        public void initialize(NotConflictUser notConflictUser) {            predicate = c -> {                log.info("user detail is {}",c);                Collection<User> collection = userRepository.findByUserNameOrEmailOrTelphone(c.getUserName(), c.getEmail(), c.getTelphone());                // 将用户名、邮件、电话改成与现有完全不重复的，或者只与自己重复的，就不算冲突                return collection.isEmpty() || (collection.size() == 1 && collection.iterator().next().getId().equals(c.getId()));            };        }    }}

这里使用Predicate函数式接口对业务规则进行判断。

4.3. 测试代码

@RestController@RequestMapping("/senior/user")@Slf4j@Validatedpublic class UserController {    @Autowired    private UserRepository userRepository;        @PostMapping    public User createUser(@UniqueUser @Valid User user){        User savedUser = userRepository.save(user);        log.info("save user id is {}",savedUser.getId());        return savedUser;    }    @SneakyThrows    @PutMapping    public User updateUser(@NotConflictUser @Valid @RequestBody User user){        User editUser = userRepository.save(user);        log.info("update user is {}",editUser);        return editUser;    }}

使用很简单，只需要在方法上加入自定义注解即可，业务逻辑中不需要添加任何业务规则的代码。

POST http://localhost:8080/valid/addContent-Type: application/json/senior/user{    "userName" : "100001"}

{"status": 400,"message": "用户名、手机号码、邮箱不允许与现存用户重复","data": null,"timestamp": 1652196524725}

以上就是关于“SpringBoot参数校验Validator框架怎么使用”这篇文章的内容，相信大家都有了一定的了解，希望小编分享的内容对大家有帮助，若想了解更多相关的知识内容，请关注编程网行业资讯频道。