参数校验

参数校验在日常开发中十分常见，在本框架中引入了 spring-boot-starter-validation 依赖，底层基于 hibernate-validator，可以对参数进行校验。

参数校验使用

方法一：使用 @Validated 注解

步骤一：标注 @Validated

@Validated 可以标注在类上，或者是参数前。

/** 标注在类上 **/
@Validated
@RestController
@RequestMapping("/auth")
public class AuthController {

    @PostMapping("/login")
    public R<LoginVo> login(@RequestBody LoginBody body) {
        // ...
    }

}

/** 标注在参数前 **/
@PostMapping
public R<Void> add(@Validated @RequestBody SysUserBo user) {
    // ...
}

步骤二：标注校验注解

在参数中加入校验注解。

public class SysUserBo {

    @NotBlank(message = "用户账号不能为空")
    @Size(min = 0, max = 30, message = "用户账号长度不能超过{max}个字符")
    private String userName;
    
    @NotBlank(message = "用户昵称不能为空")
    @Size(min = 0, max = 30, message = "用户昵称长度不能超过{max}个字符")
    private String nickName;
    
    @Email(message = "邮箱格式不正确")
    @Size(min = 0, max = 50, message = "邮箱长度不能超过{max}个字符")
    private String email;
    
}

常见校验注解见文末附表。

注：message 支持 EL 表达式，{max} 直接读取前面的参数值。

方法二：使用校验工具类 ValidatorUtils

org.dromara.common.core.utils.ValidatorUtils

使用方式 1：校验所有带有校验注解的属性

// 校验所有带有校验注解的属性
ValidatorUtils.validate(object);

使用方式 2：按照分组校验属性（可以传多个分组）

// 按照分组校验属性（可以传多个分组）
ValidatorUtils.validate(object, group);

扩展使用

扩展一：自定义校验注解

除了已有的校验注解以外，可以结合业务进行自定义。

以框架中的 @Xss 注解为例进行说明。

@Xss(message = "用户账号不能包含脚本字符")
@NotBlank(message = "用户账号不能为空")
@Size(min = 0, max = 30, message = "用户账号长度不能超过{max}个字符")
private String userName;

1：新增 @Xss 注解

org.dromara.common.core.xss.Xss

2：自定义校验器

自定义校验器实现 jakarta.validation.ConstraintValidator 接口。

org.dromara.common.core.xss.XssValidator

扩展二：自定义分组校验

同一个对象在不同的请求中需要校验的参数不同，则可以使用分组校验。

1：自定义分组

2：@Validated 注解指定分组

3：校验注解中指定分组

附录：常用校验注解

更多注解可参考包： org.hibernate.validator