Spring @Valid @Validated实现验证
作者：麦穗儿
对于属性的验证有如下一些注解
@NotBlank：只用在String上，值不能为null，并且trim后长度大于零。不为null，不是全为空格的字符串
@NotNull: 不能为null,但可以是长度为零的字符串
@NotEmpty: 不能为null，长度大于零
@Null：必须为null
@Min(value): 数字，值必须大于等于指定的值
@Max(value): 数字，值必须小雨等于指定的值
@DecimalMin(value): 数字，值必须大于等于指定的值
@DecimalMax(value): 数字，值必须小雨等于指定的值
@Digits(integer, fraction)：数字，值必须在可接收的范围内@Digits(integer=3, fraction=2) 111.22是符合要求的，1111.22不符合，整数部分4位所以不符合要求
@Size(min=v1,max=v2): v1<=值<=v2
@AssertTrue: 必须为true
@AssertFalse: 必须为false
@Past: 必须是过去的日期
@Future: 必须是将来的日期
@Pattern(regex=, flag=): 符合指定的正则表达式
@Valid：可以用在方法参数，方法，属性上。用来进行嵌套验证。嵌套验证就是在ClassA的属性中有ClassB，而ClassB的属性也需要进行验证。
@Validated:可以用在方法参数，方法上，不能用在属性上。提供了分组的功能，在参数传入时根据分组采用不同的验证机制。说明一下分组，例如对于User的userID，在新建用户时userID必须要为null。在更新用户时userID必须要不为空并且不能都是空格（blank）。这就对userID进行了分组功能，Add和Update两个组。
@Valid实例
Book定义
public class Book {
@NotBlank(message = "bookID is mandatory, can not be blank")
public String bookID;
@Size(min=5, max=20)
@NotBlank(message = "bookName is mandatory, can not be blank")
public String bookName;
public String author;
@Valid
public List<ChapterInfo> chapterList;
public Book(String id, String name, String auth) {
bookName = name;
author = auth;
bookID = id;
}
}
ChapterInfo定义
public class ChapterInfo {
@Min(0)
public Long chapterID;
@NotBlank
@Size(min=5, max=50)
public String chapterName;
@Size(min=5, max=20)
public String contentID;
}
BookController
@RestController
@RequestMapping("/bookcontroller")
public class BookController {
private List<Book> bookList = new ArrayList();
@ResponseBody
@RequestMapping("/addBookToList")
public boolean addBookToList(@Valid @RequestBody Book b) {
System.out.println(b.bookName);
bookList.add(b);
return true;
}
@InitBinder
private void activateDirectFieldAccess(DataBinder dataBinder) {
dataBinder.initDirectFieldAccess();
}
}
Postman验证
可以看到chapterList中的ChapterInfo的chapterName为blank，验证不通过
@Validated实例
public class User {
@NotBlank
public String name;
@NotBlank
public String address;
@Min(1)
public int age;
public boolean isMan;
@NotBlank(groups = {Update.class})
@Null(groups = {Add.class})
public String usrID;
public interface Add{}
public interface Update{}
public User(String name, String addr, int age, boolean isMan) {
this.name = name;
this.address = addr;
this.age = age;
this.isMan = isMan;
}
}
其中对usrID属性使用了@NotBlank(groups = {Update.class})和@Null(groups = {Add.class})注释。意思是：
(1)Update user时usrID不能为blank（要通过usrID查找user去update）
(2)Add user时usrID必须为空（要生成新的user，会分配user ID）
@RestController
@RequestMapping("/registcontroller")
public class RegistController {
List<User> usrList = new ArrayList();
@PostMapping(path="/adduser")
@ResponseBody
public User addUser(@RequestBody @Validated({User.Add.class}) User usr, BindingResult result) {
if (result.hasErrors()) {
List<ObjectError> list = result.getAllErrors();
FieldError error = (FieldError)list.get(0);
System.out.println(error.getObjectName() + "," + error.getField() + "," + error.getDefaultMessage());
return null;
}
User user = new User(usr.name, usr.address, usr.age, usr.isMan);
String usrID = usrList.size() + "";
user.usrID = usrID;
return user;
}
}
在addUser的传入参数进行了Validated的分组验证（Add)，如果传入User的usrID不为blank则会出错。
PostMan验证
usrID不存在时
正常返回新添加的user
指定usrID时
出错
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。