【SpringBoot】接口参数校验

前言

在我们编写后端接口时，不能相信用户给我们的东西，我们需要尽可能的将所有特殊情况考虑到，并且给出回避方案。例如：

/**
* 用户BO
*/
@Data
public class UserBo {

    // 年龄
    private Integer age;

    // 性别
    private String name;

}

/**
* 测试接口
*/
@PostMapping
public void saveUser(@RequestBody UserBo userBo) {
    UserBoMapStruct userBoMapStruct = new UserBoMapStruct();
    User user = userBoMapStruct.Entity(userBo);
	userMapper.insert(user);
}

当用户不按照正常逻辑，传入空的姓名或者负数年龄时，明显是不正确的。这并非是很大的错误，但是它很有可能影响我们之后的业务逻辑。

这时我们应当给接受到的参数加上验证，检验参数是否合理、正确。

@Valid

这里我推荐使用 javax.validation 包，无需引入依赖。

操作

/**
* 用户BO
*/
@Data
public class UserBo {

    // 年龄
    @Max(value = 200, message = "年龄太大了⑧")
    @Min(value = 0, message = "年龄太小了⑧")
    private Integer age;

    // 性别
    @NotBlank
    private String name;

}

/**
* 测试接口
*/
@PostMapping
public void saveUser(@Valid @RequestBody UserBo userBo) {
    UserBoMapStruct userBoMapStruct = new UserBoMapStruct();
    User user = userBoMapStruct.Entity(userBo);
	userMapper.insert(user);
}

如上，在 BO 的每个成员变量前面加上验证条件，在接口的参数前添加 @Valid 注解。当接收的参数不满足验证条件时就会抛出异常，通过统一异常处理将错误返回给前端。

验证条件参考

限制	说明
@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Size(max,min)	限制字符长度必须在min到max之间
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Pattern(value)	限制必须符合指定的正则表达式
@Past	限制必须是一个过去的日期
@Future	限制必须是一个将来的日期
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格