优雅代码-参数校验

参数校验

web开发无法避免的参数校验，大量的参数校验很容易导致代码中有大量的if判断，如下

 if (StringUtils.isBlank(user.getUsername())) {
    return new Result("用户名不能为空");
 }
 if (StringUtils.isBlank(user.getPhone())) {
    return new Result("手机号不能为空");
 }

不想写这么多的的判断代码，可以借助spring的几个注解，将一些常用的校验封装起来，交给框架统一去处理

涉及到的注解

• @validated
• @valid
• @NotBlank
• @NotNull
• @Email
• @Pattern
• ....

示例

Dto中标注校验规则

如果接口入参是一个Dto，就可以在bean的内部对需要校验的属性标上校验规则

@Data
public class UserDto {
    /**
     * 姓名
     */
    @NotBlank(message = "姓名不能为空")
    @Length(min = 2, max = 5, message = "姓名长度只能在{min}和{max}之前")
    private String ame;

    /**
     * 手机号
     */
    @NotBlank(message = "手机号不能为空")
    @Length(min = 11, max = 11, message = "手机号格式不正确")
    @Pattern(regexp = "^(((13[0-9])|(14[579])|(15([0-3]|[5-9]))|(16[6])|(17[0135678])|(18[0-9])|(19[89]))\d{8})$", message = "手机号格式不正确")
    private String phone;

    /**
     * 邮箱
     */
    @NotBlank(message = "邮箱不能为空")
    @Length(min = 3, max = 50, message = "邮箱长度最大{max}位")
    @Email(message = "邮箱格式不正确")
    private String email;

    @NotNull(message = "类型不能为空")
    @Min(value = 1, message = "类型不正确")
    @Max(value = 9, message = "类型不正确")
    private Integer type;
}

接口方法上开启校验

在方法的参数前标上@Validated就可以开启校验

    @PostMapping("saveUser")
    public Result saveUser(@RequestBody @Validated UserDto dto) {
        // TODO userService.saveUser();
        return new Result();
    }

@Validated会在进入方法的时候进行参数校验，如果违背了校验规则，则会抛出MethodArgumentNotValidException，此时在Dto中自定义的message就会被封装到这个异常中。剩下的只需要在全局异常中捕获MethodArgumentNotValidException，就可以完成参数校验的接轨返回了。

对参数校验的统一返回

    /**
     * 参数校验异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public Result methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException exception) {
        String message = exception.getBindingResult().getFieldError().getDefaultMessage();
        log.warn("参数校验不通过 message={}", message);
        Result result = new Result(Result.Error, message);
        result.setRequestId(RequestUtils.getRequestId());
        return result;
    }

一套参数校验基本就这是这样三步：

1. 为属性标注校验规则
2. 开启校验
3. 捕获并处理参数异常

以上对常用的封装bean进行参数校验，特点是校验的注解标在java对象内部，开启校验@Validated标注在方法入参前。

还有另一种常见的接口方法注解使用略有差异，如get方法一般是参数直接在方法上，没有使用Dto进行属性封装。这种情况对参数的校验需要标注在方法参数前，开启校验的@Validated则需要标注在方法所在的类上，比如controlller上。

方法上标注校验规则

@Validated
@RestController
public class UserController {

    @GetMapping("getUSerById")
    public Result<User> getUSerById(
    @NotNull(message = "id不可以为空")  
    @Min(value = 1, message = "id不合法")
     Long id) {
        // TODO userService.getUSerById(id);
        return new Result();
    }
}

关于注解

@Validated VS @Valid

这两个注解功能类似，都可以在controller上开启参数校验，也有一些不同的的地方

1. @Valid属于javax，@Validated属于springframework
2. @Valid只能用于controller中，@Validated可以用于所有spring的类上
3. @Validated可以根据分组选择性校验，@Valid不支持
4. @Valid支持嵌套校验，@Validated不支持嵌套校验

常用的参数校验注解

注解	校验对象	解释
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=10）	~	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=10)	~	验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=5)	~	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	~	验证注解的元素值的整数位数和小数位数上限
@Size(min=1, max=2)	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	~	验证注解的元素值（日期类型）比当前时间晚
@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的子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象；如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

除了这些已经定义好的校验注解，也可以自定义一些校验注解

NotNull ，NotEmpty ，NotBlank 特别提醒

• @NotNull 适用于任何类型被注解的元素必须不能与NULL
• @NotEmpty 适用于String Map或者数组不能为Null且长度必须大于0
• @NotBlank 只能用于String上面 不能为null,调用trim()后，长度必须大于0

CLC