什么是javax.validation?
JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了。
常用注解
@Null | 被注解元素必须为null |
@NotNull | 被注解元素必须不为null |
@AssertTrue | 被注解元素必须为true |
@AssertFalse | 被注解元素必须为false |
@Min(value,message) | 被注解元素必须为数字,其值>=value |
@Max(value,message) | 被注解元素必须为数字,其值<=value |
@Size(min,max,message) | 被注解元素长度在min和max之间 |
@Past | 被注解元素必须为过去的一个时间 |
@Future | 被注解元素必须为未来的一个时间 |
@Pattern | 被注解的元素必须符合指定的正则表达式 |
被注解的元素必须为邮箱地址格式 |
部分示例
package com.example.validdemo;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.*;
/**
* 用户实体
* 数据传输对象
*/
@Data
public class User {
/**
* 用户名
*/
@NotBlank(message = "用户名不能为空!")
@Size(min = 1,max = 20,message = "username max length is 20")
private String username;
/**
* 性别
*/
@NotBlank(message = "性别不能为空!")
private String gender;
/**
* 年龄
*/
@Min(value = 1, message = "年龄有误!")
@Max(value = 120, message = "年龄有误!")
private int age;
/**
* 地址
*/
@NotBlank(message = "地址不能为空!")
private String address;
/**
* 邮箱
*/
@Email(message = "邮箱有误!")
private String email;
/**
* 手机号码
*/
@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 mobile;
}
@Validated 声明要检查的参数
@PostMapping(path = "hello",consumes = "application/json")
public String test(@RequestBody @Validated User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return "参数错误相关处理";
}
return "请求成功相关处理:";
}
* spring boot版本2.3.x环境下需导入依赖 spring-boot-starter-validation
<!--spring boot版本2.3.x需引入该依赖做校验-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>