概述
验证用户输入是否正确是我们应用程序中的常见功能。Spring提供了@Valid和@Validated两个注解来实现验证功能，下面我们来详细介绍它们。
@Valid和@Validate注解
@Valid是javax.validation下的注解，它的作用是验证一个类或对象的所有属性，如果检测到错误，则抛出一个ConstraintViolationException异常。
@Validated是org.springframework.validation提供的注解，他是对javaEE的javax.validation增强。
通过定义可知：@Valid支持：
1
|
ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE
|
@Validated支持：
1
|
ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER
|
同时多了Class<?>[] value() default {};定义；
经过测试，基本使用二者并无区别，而@Valid则可以使用更多场景，比如：属性、构造器等。
而Validated通过Class<?>[] value() default {};属性可以分组验证，更加灵活。所以二者可以结合使用。
基本例子
让我们考虑一个使用Spring Boot开发的简单用户注册表单。首先，我们只有名称和密码属性：
1
2
3
4
5
6
7
8
9
10
11
12
|
public class UserAccount {
@NotNull
@Size(min = 4, max = 15)
private String password;
@NotBlank
private String name;
// standard constructors / setters / getters / toString
}
|
接下来，让我们看一下控制器。在这里，我们将使用带有@Valid批注的saveBasicInfo方法来验证用户输入：
1
2
3
4
5
6
7
8
9
10
|
@RequestMapping(value = "/saveBasicInfo", method = RequestMethod.POST)
public String saveBasicInfo(
@Valid @ModelAttribute("useraccount") UserAccount useraccount,
BindingResult result,
ModelMap model) {
if (result.hasErrors()) {
return "error";
}
return "success";
}
|
现在让我们测试一下这个方法,在确认测试成功运行之后，现在让我们扩展功能。下一步的逻辑步骤是将其转换为多步骤注册表格，就像大多数向导一样。第一步，名称和密码保持不变。在第二步中，我们将获取其他信息，例如age 和 phone。因此，我们将使用以下其他字段更新域对象：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
public class UserAccount {
@NotNull
@Size(min = 4, max = 15)
private String password;
@NotBlank
private String name;
@Min(value = 18, message = "Age should not be less than 18")
private int age;
@NotBlank
private String phone;
// standard constructors / setters / getters / toString
}
|
相同的请求测试失败。这是因为我们没有传递年龄和电话字段。
分组验证
为了支持此行为，我们引入支持分组验证的@Validated批注。
分组验证,就是将字段分组，分别验证，比如我们将用户信息分为两组：BasicInfo和AdvanceInfo
可以建立两个空接口：
1
2
3
4
|
public interface BasicInfo {
}
public interface AdvanceInfo {
}
|
第一步将具有BasicInfo接口，第二步 将具有AdvanceInfo 。此外，我们将更新UserAccount类以使用这些标记接口，如下所示：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
public class UserAccount {
@NotNull(groups = BasicInfo.class)
@Size(min = 4, max = 15, groups = BasicInfo.class)
private String password;
@NotBlank(groups = BasicInfo.class)
private String name;
@Min(value = 18, message = "Age should not be less than 18", groups = AdvanceInfo.class)
private int age;
@NotBlank(groups = AdvanceInfo.class)
private String phone;
}
|
另外，我们现在将更新控制器以使用@Validated注释而不是@Valid：
1
2
3
4
5
6
7
8
9
10
|
@RequestMapping(value = "/saveBasicInfoStep1", method = RequestMethod.POST)
public String saveBasicInfoStep1(
@Validated(BasicInfo.class)
@ModelAttribute("useraccount") UserAccount useraccount,
BindingResult result, ModelMap model) {
if (result.hasErrors()) {
return "error";
}
return "success";
}
|
更新后，再次执行测试，现在可以成功运行,但是遇到复杂的嵌套对象怎么办？
复杂嵌套对象验证
@Valid 可以用于嵌套对象。例如，在我们当前的场景中，让我们创建一个 UserAddress 对象：
1
2
3
4
5
|
public class UserAddress {
@NotBlank
private String countryCode;
// standard constructors / setters / getters / toString
}
|
@Valid可以作用于属性，则验证就会作用到嵌套对象
1
2
3
4
5
6
7
|
public class UserAccount {
//...
@Valid
@NotNull(groups = AdvanceInfo.class)
private UserAddress useraddress;
// standard constructors / setters / getters / toString
}
|
总结
@Valid保证了整个对象的验证, 但是它是对整个对象进行验证，当仅需要部分验证的时候就会出现问题。 这时候，可以使用Spring提供的@Validated 进行分组验证。
