Springboot中如何优雅的进行字段校验

Springboot中如何优雅的进行字段校验

在开发中到底应该如何做参数校验呢?

1、Controller层 VS Service层

去网上查阅了一些资料，一般推荐与业务无关的放在Controller层中进行校验，而与业务有关的放在Service层中进

行校验。那么如何将参数校验写的优雅美观呢，如果都是if - else，就感觉代码写的很low，还好有轮子可以使用。

2、javax.validation

JSR303 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们

JavaBean 的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了，在 SpringBoot 中已经包含在

starter-web 中，在其他项目中可以引用依赖，并自行调整版本。

<!--jsr 303-->
<dependency>
	<groupId>javax.validation</groupId>
	<artifactId>validation-api</artifactId>
	<version>1.1.0.Final</version>
</dependency>
        
<!-- hibernate validator-->
<dependency>
	<groupId>org.hibernate</groupId>
	<artifactId>hibernate-validator</artifactId>
	<version>5.2.0.Final</version>
</dependency>

3、常用校验工具类

3.1 使用Hibernate Validate

引入依赖：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.3.1.Final</version>
</dependency>

常用注解说明：

注解	说明
@Length(min=,max=)	检查所属的字段的长度是否在min和max之间，只能用于字符串
@Range(min=,max=,message=)	被注释的元素必须在合适的范围内
@Max	该字段的值只能小于或等于该值
@Min	该字段的值只能大于或等于该值
@NotNull	不能为null
@NotBlank	不能为空，检查时会将空格忽略
@NotEmpty	不能为空，这里的空是指空字符串
@Pattern(regex=,flag=)	被注释的元素必须符合指定的正则表达式

此处只列出 Hibernate Validator 提供的大部分验证约束注解，请参考 hibernate validator 官方文档了解其他验

证约束注解和进行自定义的验证约束注解定义。

使用姿势需要搭配在Controller中搭配@Validated或@Valid注解一起使用，@Validated和@Valid注解区别不是很

大，一般情况下任选一个即可，区别如下：

注解	@Validated	@Valid
所属的包	属于org.springframework.validation.annotation包下的，是spring提供的	属于javax.validation包下，是jdk给提供的
是否支持分组和排序	是	否

虽然@Validated比@Valid更加强大，在@Valid之上提供了分组功能和验证排序功能，不过在实际项目中一直没有

用到过，Hibernate-validate框架中的注解是需要加在实体中一起使用的。

• 定义一个实体

public class DataSetSaveVO {
    
    //唯一标识符为空
    @NotBlank(message = "user uuid is empty")
    
    //用户名称只能是字母和数字
    @Pattern(regexp = "^[a-z0-9]+$", message = "user names can only be alphabetic and numeric")
    @Length(max = 48, message = "user uuid length over 48 byte")
    private String userUuid;

    //数据集名称只能是字母和数字
    @Pattern(regexp = "^[A-Za-z0-9]+$", message = "data set names can only be letters and Numbers")
    
    //文件名称过长
    @Length(max = 48, message = "file name too long")
    
    //文件名称为空
    @NotBlank(message = "file name is empty")
    private String name;

    //数据集描述最多为256字节
    @Length(max = 256, message = "data set description length over 256 byte")
    
    //数据集描述为空
    @NotBlank(message = "data set description is null")
    private String description;
}

说明：message字段为不符合校验规则时抛出的异常信息

• Controller层中的方法

@PostMapping
public ResponseVO createDataSet(@Valid @RequestBody DataSetSaveVO dataSetVO) {
    return ResponseUtil.success(dataSetService.saveDataSet(dataSetVO));
}

说明：在校验的实体DataSetSaveVO旁边添加@Valid或@Validated注解

• 在全局校验中增加校验异常

MethodArgumentNotValidException 是 SpringBoot 中进行绑定参数校验时的异常，需要在 SpringBoot 中处

理。为了优雅一点，我们将参数异常，业务异常统一做了一个全局异常，将控制层的异常包装到我们自定义的异常

中。

@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 方法参数校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {}

}

2.2 使用commons-lang3

引入依赖：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.4</version>
</dependency>

常用方法说明：

方法	说明
CollectionUtils.isEmpty	判断集合是否为空，为null或者size==0，返回true
CollectionUtils.isNotEmpty	判断集合是否为非空
StringUtils.isEmpty	判断字符串是否为空
StringUtils.isNotEmpty	判断字符串是否非空
StringUtils.isBlank	判断字符串是否为空，为null或者size==0或者只存在空白字符(如" ")，则返回true
StringUtils.isNotBlank	判断字符串是否为非空

• 测试代码

//StringUtils.isEmpty
System.out.println(StringUtils.isEmpty(""));  //true
System.out.println(StringUtils.isEmpty("  "));  //false
//StringUtils.isNotEmpty
System.out.println(StringUtils.isNotEmpty(""));  //false

//StringUtils.isBlank
System.out.println(StringUtils.isBlank(""));  //true
System.out.println(StringUtils.isBlank(" "));  //true
//StringUtils.isNotBlank
System.out.println(StringUtils.isNotBlank(" "));  //false

List<Integer> emptyList = new ArrayList<>();
List<Integer> nullList = null;
List<Integer> notEmptyList = new ArrayList<>();
notEmptyList.add(1);

//CollectionUtils.isEmpty
System.out.println(CollectionUtils.isEmpty(emptyList));   //true
System.out.println(CollectionUtils.isEmpty(nullList));   //true
System.out.println(CollectionUtils.isEmpty(notEmptyList));   //false

//CollectionUtils.isNotEmpty
System.out.println(CollectionUtils.isNotEmpty(emptyList));   //false
System.out.println(CollectionUtils.isNotEmpty(nullList));   //false
System.out.println(CollectionUtils.isNotEmpty(notEmptyList));   //true

2.3 自定义注解

当上面的方面都无法满足校验的需求以后，可以考虑使用自定义注解。

2.3.1 自定义身份证校验注解

@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdentityCardNumberValidator.class)
public @interface IdentityCardNumber {

    String message() default "身份证号码不合法";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

这个注解是作用在 Field 字段上，运行时生效，触发的是 IdentityCardNumber 这个验证类。

• message 定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定

  制。

• groups 这里主要进行将 validator 进行分类，不同的类 group 中会执行不同的 validator 操作。

• payload 主要是针对 bean 的，使用不多。

2.3.2 自定义Validator

这个是真正进行验证的逻辑代码：

public class IdentityCardNumberValidator implements ConstraintValidator<IdentityCardNumber, Object> {

    @Override
    public void initialize(IdentityCardNumber identityCardNumber) {
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        return IdCardValidatorUtils.isValidate18Idcard(o.toString());
    }
}

2.3.3 使用自定义的注解

@NotBlank(message = "身份证号不能为空")
@IdentityCardNumber(message = "身份证信息有误,请核对后提交")
private String clientCardNo;

2.3.4 使用groups的校验

同一个对象要复用，比如 UserDTO 在更新时候要校验userId，在保存的时候不需要校验 userId，在两种情况下都

要校验 username，那就用上 groups了。

先定义 groups 的分组接口 Create 和 Update：

import javax.validation.groups.Default;

public interface Create extends Default {
}

import javax.validation.groups.Default;

public interface Update extends Default{
}

再在需要校验的地方@Validated声明校验组：

 /**
     * 走参数校验注解的 groups 组合校验
     *
     * @param userDTO
     * @return
*/
@PostMapping("/update/groups")
public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
	userService.updateById(userDTO);
 	return RspDTO.success();
}

在DTO中的字段上定义好groups = {}的分组类型

@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用户ID*/
    @NotNull(message = "用户id不能为空", groups = Update.class)
    private Long userId;

    /**
     * 用户名
     */
    @NotBlank(message = "用户名不能为空")
    @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")
    private String username;

    /**
     * 手机号
     */
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误", groups = {Create.class, Update.class})
    private String mobile;

    /**
     * 性别
     */
    private String sex;

    /**
     * 邮箱
     */
    @NotBlank(message = "联系邮箱不能为空")
    @Email(message = "邮箱格式不对")
    private String email;

    /**
     * 密码
     */
    private String password;

    /*** 创建时间 */
    @Future(message = "时间必须是将来时间", groups = {Create.class})
    private Date createTime;

}

注意：在声明分组的时候尽量加上 extend javax.validation.groups.Default ，否则，在你声明

@Validated(Update.class) 的时候，就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮

箱格式不对")，会不去校验，因为默认的校验组是groups = {Default.class}。

2.3.5 restful风格用法

在多个参数校验，或者@RequestParam 形式时候，需要在controller上加注@Validated：

@GetMapping("/get")
public RspDTO getUser(@RequestParam("userId") @NotNull(message = "用户id不能为空") Long userId) {
        User user = userService.selectById(userId);
        if (user == null) {
            return new RspDTO<User>().nonAbsent("用户不存在");
        }
        return new RspDTO<User>().success(user);
    }

@RestController
@RequestMapping("user/")
@Validated
public class UserController extends AbstractController {}