前不久开发了代码生成器,通过Mybatis-plus的模板插件引擎动态生成crud模板。搞定后,就想对请求参数进行校验。由于我这个模板是通过表来生成的,也就是说在新增与编辑的时候,我也是会把相关的字段生成的,由于这表是从数据库读取的,那么这些字段的非空约束,字段长度约束...是可以进行参数校验,进行优化。 最近从网上查找了Spring的validate相关资料,学习一下哈。
validator
-
的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验javax.validation
- 什么是
javax.validation
JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:
3: 注解说明
[email protected]:不能为null,但可以为empty(""," "," ")
[email protected]:不能为null,而且长度必须大于0 (" "," ")
[email protected]:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0("test") 即:必须有实际字符
验证注解 | 验证的数据类型 | 说明 |
---|---|---|
@AssertFalse | Boolean,boolean | 验证注解的元素值是false |
@AssertTrue | Boolean,boolean | 验证注解的元素值是true |
@NotNull | 任意类型 | 验证注解的元素值不是null |
@Null | 任意类型 | 验证注解的元素值是null |
@Min(value=值) | BigDecimal,BigInteger, byte,short, int, long,等任何Number或CharSequence(存储的是数字)子类型 | 验证注解的元素值大于等于@Min指定的value值 |
@Max(value=值) | 和@Min要求一样 | 验证注解的元素值小于等于@Max指定的value值 |
@DecimalMin(value=值) | 和@Min要求一样 | 验证注解的元素值大于等于@ DecimalMin指定的value值 |
@DecimalMax(value=值) | 和@Min要求一样 | 验证注解的元素值小于等于@ DecimalMax指定的value值 |
@Digits(integer=整数位数, fraction=小数位数) | 和@Min要求一样 | 验证注解的元素值的整数位数和小数位数上限 |
@Size(min=下限, max=上限) | 字符串、Collection、Map、数组等 | 验证注解的元素值的在min和max(包含)指定区间之内,如字符长度、集合大小 |
@Past | java.util.Date,java.util.Calendar;Joda Time类库的日期类型 | 验证注解的元素值(日期类型)比当前时间早 |
@Future | 与@Past要求一样 | 验证注解的元素值(日期类型)比当前时间晚 |
@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注解即可级联验证 |
此处只列出Hibernate Validator提供的大部分验证约束注解,请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。
实战练习
依赖:
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
</dependency>
实体类
import java.math.BigDecimal;
import java.util.Date;
import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Future;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import lombok.Data;
/**
* @author : dengbin
* @date : 2019/11/14
*/
@Data
public class User {
@NotNull(message = "名字不能为空")
private String name;
@Size(min = 6, max = 30, message = "地址应该在6-30字符之间")
private String address;
@DecimalMax(value = "100.00", message = "体重有些超标哦")
@DecimalMin(value = "60.00", message = "多吃点饭吧")
private BigDecimal weight;
@Future(message = "生日必须在当前实践之前")
private Date birthday;
@Pattern(regexp = "^(.+)@(.+)$", message = "邮箱的格式不合法")
private String email;
}
demo测试
@ApiOperation("添加用户")
@PostMapping("/add")
public ApiResp add(@Valid @RequestBody User user) throws Exception {
return userService.add(user);
}
定义全局异常,接受validate所抛出的异常。
@ControllerAdvice
@Slf4j
public class ExceptionConfig {
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseBody
public EmptyResp handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
StringBuilder builder = new StringBuilder();
BindingResult bindingResult = ex.getBindingResult();
for (FieldError fieldError : bindingResult.getFieldErrors()) {
builder.append(fieldError.getField());
builder.append("(");
builder.append(fieldError.getRejectedValue());
builder.append(",");
builder.append(fieldError.getDefaultMessage());
builder.append(")");
}
return new EmptyResp(RetCode.REQ_PARAM_INVALID, builder.toString());
}
}
先写到这,接下来再补充学到的知识点。