1.概述#
本文我们将重点介绍Spring中 @Valid和@Validated注解的区别 。
验证用户输入是否正确是我们应用程序中的常见功能。Spring提供了@Valid和@Validated两个注解来实现验证功能,下面我们来详细介绍它们。
2. @Valid和@Validate注解#
在Spring中,我们使用@Valid 注解进行方法级别验证,同时还能用它来标记成员属性以进行验证。
但是,此注释不支持分组验证。@Validated则支持分组验证。
3.例子#
让我们考虑一个使用Spring Boot开发的简单用户注册表单。首先,我们只有名称和密码属性:
Copypublic class UserAccount { @NotNull @Size(min = 4, max = 15) private String password; @NotBlank private String name; // standard constructors / setters / getters / toString}
接下来,让我们看一下控制器。在这里,我们将使用带有@Valid批注的saveBasicInfo方法来验证用户输入:
Copy@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";}
现在让我们测试一下这个方法:
Copy@Testpublic void givenSaveBasicInfo_whenCorrectInput`thenSuccess() throws Exception { this.mockMvc.perform(MockMvcRequestBuilders.post("/saveBasicInfo") .accept(MediaType.TEXT_HTML) .param("name", "test123") .param("password", "pass")) .andExpect(view().name("success")) .andExpect(status().isOk()) .andDo(print());}
在确认测试成功运行之后,现在让我们扩展功能。下一步的逻辑步骤是将其转换为多步骤注册表格,就像大多数向导一样。第一步,名称和密码保持不变。在第二步中,我们将获取其他信息,例如age 和 phone。因此,我们将使用以下其他字段更新域对象:
Copypublic 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
可以建立两个空接口:
Copypublic interface BasicInfo {}
Copypublic interface AdvanceInfo {}
第一步将具有BasicInfo接口,第二步 将具有AdvanceInfo 。此外,我们将更新UserAccount类以使用这些标记接口,如下所示:
Copypublic 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; // standard constructors / setters / getters / toString }
另外,我们现在将更新控制器以使用@Validated注释而不是@Valid:
Copy@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";}
更新后,再次执行测试,现在可以成功运行。现在,我们还要测试这个新方法:
Copy@Testpublic void givenSaveBasicInfoStep1`whenCorrectInput`thenSuccess() throws Exception { this.mockMvc.perform(MockMvcRequestBuilders.post("/saveBasicInfoStep1") .accept(MediaType.TEXT_HTML) .param("name", "test123") .param("password", "pass")) .andExpect(view().name("success")) .andExpect(status().isOk()) .andDo(print());}
也成功运行!
接下来,让我们看看@Valid对于触发嵌套属性验证是必不可少的。
4.使用@Valid批注标记嵌套对象#
@Valid 可以用于嵌套对象。例如,在我们当前的场景中,让我们创建一个 UserAddress 对象:
Copypublic class UserAddress { @NotBlank private String countryCode; // standard constructors / setters / getters / toString}
为了确保验证此嵌套对象,我们将使用@Valid批注装饰属性:
Copypublic class UserAccount { //... @Valid @NotNull(groups = AdvanceInfo.class) private UserAddress useraddress; // standard constructors / setters / getters / toString }
5. 总结#
@Valid保证了整个对象的验证, 但是它是对整个对象进行验证,当仅需要部分验证的时候就会出现问题。 这时候,可以使用@Validated 进行分组验证。
参考#
- https://www.baeldung.com/spring-valid-vs-validated
作者: JadePeng
出处:https://www.cnblogs.com/xiaoqi/p/spring-valid.html
版权:本文采用「署名-非商业性使用-相同方式共享 4.0 国际(欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接) 」知识共享许可协议进行许可。
分类: java编程
标签: Spring Boot, java