SpringBoot参数校验

为什么需要参数校验

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

@RestController
@RequestMapping("/user")
public class UserController {

    @PostMapping("add")
    public ResponseEntity<String> add(User user) {
        if(user.getName()==null) {
            return ResponseResult.fail("user name should not be empty");
        } else if(user.getName().length()<5 || user.getName().length()>50){
            return ResponseResult.fail("user name length should between 5-50");
        }
        if(user.getAge()< 1 || user.getAge()> 150) {
            return ResponseResult.fail("invalid age");
        }
        // ...
        return ResponseEntity.ok("success");
    }
}

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

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

hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。

Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。

Spring Validation的使用

引入依赖

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

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

请求参数封装

@Data
@ApiModel(value = "User")
public class User {

    private String userId;

    @NotEmpty(message = "不能为空")
    @Email(message = "邮箱格式不正确")
    private String email;

    @NotEmpty(message = "不能为空")
    @Pattern(regexp = "^(\\d{6})(\\d{4})(\\d{2})(\\d{2})(\\d{3})([0-9]|X)$", message = "身份证不合法")
    private String cardNo;

    @NotEmpty(message = "不能为空")
    @Length(min = 1, max = 10, message = "昵称不得超过10个字符")
    private String nickName;

    @NotEmpty(message = "不能为空")
    @Range(min = 0, max = 1, message = "性别代码为0或1")
    private int sex;

    @Max(value = 100, message = "请输入合法年龄")
    private int age;

}

Controller中获取参数绑定结果

使用@Valid或者@Validated注解，参数校验的值放在BindingResult中

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @PostMapping("add")
    public ResponseEntity<String> add(@Valid @RequestBody User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<ObjectError> errors = bindingResult.getAllErrors();
            errors.forEach(p -> {
                FieldError fieldError = (FieldError) p;
                log.error("Invalid Parameter : object - {},field - {},errorMessage - {}", fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
            });
            return ResponseEntity.badRequest().body("invalid parameter");
        }
        return ResponseEntity.ok("success");
    }
}

分组校验

定义分组

在上边的User类中定义分组，接口不需要实现

	//定义分组
	public interface AddValidationGroup {
	}
	public interface EditValidationGroup {
	}

添加分组

@Data
public class User {

    @NotEmpty(message = "{user.msg.userId.notEmpty}", groups = {EditValidationGroup.class}) // 这里
    private String userId;
	
	//定义分组
	public interface AddValidationGroup {
	}
	public interface EditValidationGroup {
	}

}

使用分组

PS: 需要使用@Validated注解

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

   
    @PostMapping("add")
    public ResponseEntity<User> add(@Validated(AddValidationGroup.class) @RequestBody User user) {
        return ResponseEntity.ok(user);
    }

    
    @PostMapping("edit")
    public ResponseEntity<User> edit(@Validated(EditValidationGroup.class) @RequestBody User user) {
        return ResponseEntity.ok(user);
    }
}

@Validated和@Valid区别

在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

分组

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制，这个网上也有资料，不详述。@Valid：作为标准JSR-303规范，还没有吸收分组的功能。

注解地方

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上

@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上

嵌套类型

Address是User类中的一个嵌套属性，只能用@Valid

@Data
public class User {

    @Valid // 这里只能用@Valid
    private Address address;

}

常见的约束注解

JSR303/JSR-349: JSR303是一项标准,只提供规范不提供实现，规定一些校验规范即校验注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下。JSR-349是其的升级版本，添加了一些新特性。

hibernate validation：hibernate validation是对这个规范的实现，并增加了一些其他校验注解，如@Email，@Length，@Range等等