简介:
SpringBoot 提供了优雅的参数校验方式,即使用 validation-api,关于 validation-api 内置的注解这里不作详细的解释,主要为以下几种:
注解 | 说明 |
---|---|
@Null | 限制只能为null |
@NotNull | 限制必须不为null |
@AssertFalse | 限制必须为false |
@AssertTrue | 限制必须为true |
@DecimalMax(value) | 限制必须为一个不大于指定值的数字 |
@DecimalMin(value) | 限制必须为一个不小于指定值的数字 |
@Digits(integer,fraction) | 限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction |
@Future | 限制必须是一个将来的日期 |
@Max(value) | 限制必须为一个不大于指定值的数字 |
@Min(value) | 限制必须为一个不小于指定值的数字 |
@Past | 验证注解的元素值(日期类型)比当前时间早 |
@Pattern(value) | 限制必须符合指定的正则表达式 |
@Size(max,min) | 限制字符长度必须在min到max之间 |
@NotEmpty | 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0) |
@NotBlank | 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格 |
验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式 |
但有些时候,内置的并不能满足业务的需要,这里就介绍一下如何扩展 validation-api 实现自定义注解,以校验上传的文件类型为例子,如何实现自定义扩展的注解。
一、注解定义
要实现扩展 validate 框架的注解比较简单,直接在注解上添加 @Constraint 并指定校验的实现类即可
@Inherited
@Target({
PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {
MultipartFilesValidator.class, MultipartFileValidator.class})
public @interface MultipartFileVerify {
String message() default "文件校验失败";
Class<?>[] groups() default {
};
Class<? extends Payload>[] payload() default {
};
/**
* 文件类型限制
*/
FileType[] value() default {
};
/**
* 不允许上传的文件类型,不指定则不作限制
*/
Fil