使用SpringMVC时配合hibernate-validate进行参数的合法性校验,能节省一定的代码量.
使用步骤
1.搭建Web工程并引入hibernate-validate依赖
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>
Maven依赖传递,自动依赖validation-api、jboss-logging、classmate
2.使用校验注解标注在属性上(dto)
*每个注解都有message属性,该属性用于填写校验失败时的异常描述信息,当校验失败时可以获取对应的message属性值.
public class User {
@NotNull(message="id不能为空!")
private Integer id;
@NotBlank(message="用户名不能为空!")
@Size(min=4,max=12,message="用户名的长度在4~12之间!")
private String username;
@NotBlank(message="密码不能为空!")
private String password;
@Email(message="非法邮箱!")
private String email;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public User() {
super();
}
}
3.控制层中使用dto接收参数并使用@Validated/@Valid注解开启对参数的校验
*@Validated注解表示使用Spring的校验机制,支持分组校验,声明在入参上.
*@Valid注解表示使用Hibernate的校验机制,不支持分组校验,声明在入参上.
*在dto后面要紧跟BindingResult对象,该对象用于获取当校验失败时的异常信息.
@RestController
public class BaseController {
@RequestMapping("/test")
public User test(@Validated User user, BindingResult result) {
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
for (ObjectError error : errors) {
System.out.println(error.getDefaultMessage());
}
}
return user;
}
}
演示：
结果：
密码不能为空!
id不能为空!
用户名的长度在4~12之间!
*校验的顺序是随机的,因此程序不能依赖校验的顺序去做相关的逻辑处理.
4.分组校验
每个校验注解都有group属性用于指定校验所属的组,其值是Class数组,在Controller中使用@Validated注解开启对参数的校验时当指定要进行校验的组,那么只有组相同的属性才会被进行校验(默认全匹配).
Class<?>[] groups() default { };
一般定义标识接口作为组资源
public interface GroupA {
}
public interface GroupB {
}
使用校验注解标注在属性上并进行分组
public class User {
@NotNull(message="id不能为空!",groups = {GroupA.class})
private Integer id;
@NotBlank(message="用户名不能为空!",groups = {GroupB.class})
@Size(min=4,max=12,message="用户名的长度在4~12之间!")
private String username;
@NotBlank(message="密码不能为空!")
private String password;
@Email(message="非法邮箱!")
private String email;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public User() {
super();
}
}
Controller中使用@Validated注解开启对参数的校验并指定校验的组,那么只有组相同的属性才会被进行校验(默认全匹配),
@RestController
public class BaseController {
@RequestMapping("/test")
public User test(@Validated(value= {GroupB.class}) User user, BindingResult result) {
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
for (ObjectError error : errors) {
System.out.println(error.getDefaultMessage());
}
}
return user;
}
}
演示：
结果：
用户名不能为空!