@Valid注解实现字段校验
前言
? 每一个应用软件都离不开数据的校验，比如在提交表单时需要对用户提交的字段内容进行长度验证、非空验证等等。有的小伙伴在做字段内容校验时采用的依然是最原始的校验方式——获取字段内容，用 if-else 对内容进行验证。这种校验方式当然没问题，但是却需要写很多行代码去实现校验的功能，也就让我们的编码效率和代码可读性都降低了很多，那么今天就给各位小伙伴介绍另一种方式——使用 @Valid 注解实现字段校验。
先创建几个基础类
学生类
import lombok.Data;
@Data
public class Student {
private String name;
private Integer age;
}
StudentController
import com.***.Student;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/student")
public class StudentController {
@GetMapping("/add")
public String add(Student student){
return student.toString();
}
}
从返回结果来看，一切正常
开始使用 if-else 进行字段校验
假如学生姓名不能为空且年龄不能小于18，那么我们按照以前的校验方式（if-else）来写就是这样子的
import com.***.Student;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/student")
public class StudentController {
@GetMapping("/add")
public String add(Student student){
if (student.getName()==null||student.getName().trim().isEmpty()){
return "名字不符合要求";
}
if (student.getAge()==null||student.getAge()<18){
return "年龄不符合要求";
}
return student.toString();
}
}
从返回结果来看，校验正常
我们可以看到校验完全没问题，满足了对学生姓名的限制需求。如果这时又来了一个新的需求：要求年龄字段要求大于18小于100就目前我们可以对代码改造一下，但多处需要需要改造的呢，此时怎么办?
Valid 注解使用
在使用 @Valid 注解之前，我们需要先引入依赖
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
引入之后，那么接下来我们需要对学生类以及Controller类进行修改
学生类
import lombok.Data;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.NotNull;
@Data
public class Student {
@NotNull(message ="名字不能为空" )
private String name;
@NotNull(message ="年龄不能为空" )
@Range(message = "年龄只允许在18到100之间",min = 18,max = 100)
private Integer age;
}
StudentController
import com.***.Student;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
@RestController
@RequestMapping("/student")
public class StudentController {
@GetMapping("/add")
public String add(@Valid Student student, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return bindingResult.getAllErrors().get(0).getDefaultMessage();
}
return student.toString();
}
}
我们可以看到，字段校验的结果和我们预期一样，而且还让代码的可读性提高了一大截
最后再给大家总结一下实体类中常用的校验注解：
- @Null：被注释的元素必须为null
- @NotNull：被注释的元素不能为null
- @AssertTrue：该字段只能为true
- @AssertFalse：该字段的值只能为false
- @Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值
- @Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值
- @DecimalMin(“value”)：被注释的元素必须是一个数字，验证小数的最小值
- @DecimalMax(“value”)：被注释的元素必须是一个数字，验证小数的最大值
- @Size(max,min)：查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
- @Past：被注释的元素必须是一个过去的日期
- @Future：被注释的元素必须是一个将来的日期
- @Pattern(regexp = “[abc]”)：被注释的元素必须符合指定的正则表达式。
- @Email：被注释的元素必须是电子邮件地址
- @Length(max=5,min=1,message=“长度在1~5”)：检查所属的字段的长度是否在min和max之间，只能用于字符串
- @NotEmpty：被注释的字符串必须非空
- @Range：被注释的元素必须在合适的范围内
- @NotBlank：不能为空，检查时会将空格忽略
- @NotEmpty：不能为空，这里的空是指空字符串
