https://howtodoinjava.com/spring-mvc/spring-bean-validation-example-with-jsr-303-annotations/

JSR-303 bean 验证是一个规范,其目的是通过注解标准化 Java bean 的验证。 JSR-303 标准的目的是在 Java bean 类中直接使用注解。 这允许直接在要验证的代码中指定验证规则,而不是在单独的类中创建验证规则。 到目前为止,我们了解了使用BindingResult.rejectValue()自定义验证器实现在 spring mvc 中进行的验证。 在本示例中,我们将学习使用基于 JSR-303 标准的注解来验证 Spring 管理的 bean。

阅读更多:提交表单示例 & 自定义验证程序示例

应用验证后,前端 UI 上的错误消息将如下所示:

Spring Bean 验证 – JSR-303 注解 - 图1

Spring MVC JSR 303 验证注解示例

添加 JSR-303 和 Hibernate 验证器依赖关系

要使与 Spring 一起使用 JSR-303 注解,您需要在pom.xml中添加以下依赖项。

  1. <dependency>
  2. <groupId>javax.validation</groupId>
  3. <artifactId>validation-api</artifactId>
  4. <version>1.0.0.GA</version>
  5. </dependency>

为了使验证真正起作用,您还需要一个实现,例如 Hibernate 验证器

  1. <dependency>
  2. <groupId>org.hibernate</groupId>
  3. <artifactId>hibernate-validator</artifactId>
  4. <version>4.3.1.Final</version>
  5. </dependency>

应用 JSR-303 注解

添加 JSR-303 依赖关系后,您需要做的第一件事是用必要的 JSR-303 注解装饰 Java bean。 参见下面的EmployeeVO类,其字段使用诸如@Size@Pattern之类的注解进行注解。

  1. package com.howtodoinjava.demo.model;
  2. import java.io.Serializable;
  3. import javax.validation.constraints.Pattern;
  4. import javax.validation.constraints.Size;
  5. public class EmployeeVO implements Serializable
  6. {
  7. private static final long serialVersionUID = 1L;
  8. private Integer id;
  9. @Size(min = 3, max = 20)
  10. private String firstName;
  11. @Size(min = 3, max = 20)
  12. private String lastName;
  13. @Pattern(regexp=".+@.+\\.[a-z]+")
  14. private String email;
  15. //Setters and Getters
  16. @Override
  17. public String toString() {
  18. return "EmployeeVO [id=" + id + ", firstName=" + firstName
  19. + ", lastName=" + lastName + ", email=" + email + "]";
  20. }
  21. }

阅读更多:所有受支持的 JSR-303 注解的列表

控制器变更

要应用此验证器,您需要对控制器执行以下修改。

1)包括对控制器类的验证器引用,以便您可以跨控制器中的所有方法访问它。

  1. private Validator validator;

2)下一个更改是在控制器的post方法中,该方法在用户提交表单时调用。

  1. @RequestMapping(method = RequestMethod.POST)
  2. public String submitForm(@ModelAttribute("employee") EmployeeVO employeeVO,
  3. BindingResult result, SessionStatus status) {
  4. Set<ConstraintViolation<EmployeeVO>> violations = validator.validate(employeeVO);
  5. for (ConstraintViolation<EmployeeVO> violation : violations)
  6. {
  7. String propertyPath = violation.getPropertyPath().toString();
  8. String message = violation.getMessage();
  9. // Add JSR-303 errors to BindingResult
  10. // This allows Spring to display them in view via a FieldError
  11. result.addError(new FieldError("employee",propertyPath,
  12. "Invalid "+ propertyPath + "(" + message + ")"));
  13. }
  14. if (result.hasErrors()) {
  15. return "addEmployee";
  16. }
  17. // Store the employee information in database
  18. // manager.createNewRecord(employeeVO);
  19. // Mark Session Complete
  20. status.setComplete();
  21. return "redirect:addNew/success";
  22. }

请注意,与早期的 Spring 特定验证方法不同,validator字段未分配给任何 bean,而是分配了javax.validation.ValidatorFactory类型的工厂类。 这就是 JSR-303 验证的工作方式。 分配过程在控制器的构造函数中完成。

submitForm()方法中,第一步包括创建javax.validation.ConstraintViolation类型的Set,以保存从验证EmployeeVO对象的实例而检测到的所有错误。 分配给此Set的值来自执行validator.validate(employeeVO)的结果,该validator.validate(employeeVO)用于在作为EmployeeVO对象实例的employeeVO字段上运行验证过程。

验证过程完成后,将在违反集上声明一个循环,以提取EmployeeVO对象中遇到的任何可能的验证错误。 由于违规集包含特定于 JSR-303 的错误,因此有必要提取原始错误消息并将其以 Spring MVC 特定格式放置。 这样就可以将验证错误显示在 Spring 管理的视图中,就像它们是由 Spring 验证程序生成的一样。

测试应用

就这样。 JSR-303 验证配置已完成。 现在测试应用程序。

1)输入网址:http://localhost:8080/springmvcexample/employee-module/addNew它将显示空白表格。

Spring Bean 验证 – JSR-303 注解 - 图2

Spring MVC 表单示例 – 空白表单

2)在不填写任何字段的情况下,提交表格。您将得到特定于每个字段的错误。

Spring Bean 验证 – JSR-303 注解 - 图3

Spring MVC JSR 303 验证注解示例

3)填写所有字段,然后按Submit按钮。 将显示成功页面。

Spring Bean 验证 – JSR-303 注解 - 图4

Spring MVC 表单示例 – 成功消息

作为参考,完整的pom.xml文件如下:

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3. <modelVersion>4.0.0</modelVersion>
  4. <groupId>com.howtodoinjava.demo</groupId>
  5. <artifactId>springmvcexample</artifactId>
  6. <packaging>war</packaging>
  7. <version>1.0-SNAPSHOT</version>
  8. <name>springmvcexample Maven Webapp</name>
  9. <url>http://maven.apache.org</url>
  10. <dependencies>
  11. <dependency>
  12. <groupId>junit</groupId>
  13. <artifactId>junit</artifactId>
  14. <version>4.12</version>
  15. <scope>test</scope>
  16. </dependency>
  17. <!-- Spring MVC support -->
  18. <dependency>
  19. <groupId>org.springframework</groupId>
  20. <artifactId>spring-webmvc</artifactId>
  21. <version>4.1.4.RELEASE</version>
  22. </dependency>
  23. <dependency>
  24. <groupId>org.springframework</groupId>
  25. <artifactId>spring-web</artifactId>
  26. <version>4.1.4.RELEASE</version>
  27. </dependency>
  28. <!-- Tag libs support for view layer -->
  29. <dependency>
  30. <groupId>javax.servlet</groupId>
  31. <artifactId>jstl</artifactId>
  32. <version>1.2</version>
  33. <scope>runtime</scope>
  34. </dependency>
  35. <dependency>
  36. <groupId>taglibs</groupId>
  37. <artifactId>standard</artifactId>
  38. <version>1.1.2</version>
  39. <scope>runtime</scope>
  40. </dependency>
  41. <!-- JSR 303 Dependencies -->
  42. <dependency>
  43. <groupId>javax.validation</groupId>
  44. <artifactId>validation-api</artifactId>
  45. <version>1.0.0.GA</version>
  46. </dependency>
  47. <dependency>
  48. <groupId>org.hibernate</groupId>
  49. <artifactId>hibernate-validator</artifactId>
  50. <version>4.3.1.Final</version>
  51. </dependency>
  52. </dependencies>
  53. <build>
  54. <finalName>springmvcexample</finalName>
  55. </build>
  56. </project>

EmployeeController类如下:

  1. package com.howtodoinjava.demo.controller;
  2. import java.util.Set;
  3. import javax.validation.ConstraintViolation;
  4. import javax.validation.Validation;
  5. import javax.validation.Validator;
  6. import javax.validation.ValidatorFactory;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.stereotype.Controller;
  9. import org.springframework.ui.Model;
  10. import org.springframework.validation.BindingResult;
  11. import org.springframework.validation.FieldError;
  12. import org.springframework.web.bind.annotation.ModelAttribute;
  13. import org.springframework.web.bind.annotation.RequestMapping;
  14. import org.springframework.web.bind.annotation.RequestMethod;
  15. import org.springframework.web.bind.annotation.SessionAttributes;
  16. import org.springframework.web.bind.support.SessionStatus;
  17. import com.howtodoinjava.demo.model.EmployeeVO;
  18. import com.howtodoinjava.demo.service.EmployeeManager;
  19. @Controller
  20. @RequestMapping("/employee-module/addNew")
  21. @SessionAttributes("employee")
  22. public class EmployeeController {
  23. @Autowired
  24. EmployeeManager manager;
  25. private Validator validator;
  26. public EmployeeController()
  27. {
  28. ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
  29. validator = validatorFactory.getValidator();
  30. }
  31. @RequestMapping(method = RequestMethod.GET)
  32. public String setupForm(Model model) {
  33. EmployeeVO employeeVO = new EmployeeVO();
  34. model.addAttribute("employee", employeeVO);
  35. return "addEmployee";
  36. }
  37. @RequestMapping(method = RequestMethod.POST)
  38. public String submitForm(@ModelAttribute("employee") EmployeeVO employeeVO,
  39. BindingResult result, SessionStatus status) {
  40. Set<ConstraintViolation<EmployeeVO>> violations = validator.validate(employeeVO);
  41. for (ConstraintViolation<EmployeeVO> violation : violations)
  42. {
  43. String propertyPath = violation.getPropertyPath().toString();
  44. String message = violation.getMessage();
  45. // Add JSR-303 errors to BindingResult
  46. // This allows Spring to display them in view via a FieldError
  47. result.addError(new FieldError("employee",propertyPath,
  48. "Invalid "+ propertyPath + "(" + message + ")"));
  49. }
  50. if (result.hasErrors()) {
  51. return "addEmployee";
  52. }
  53. // Store the employee information in database
  54. // manager.createNewRecord(employeeVO);
  55. // Mark Session Complete
  56. status.setComplete();
  57. return "redirect:addNew/success";
  58. }
  59. @RequestMapping(value = "/success", method = RequestMethod.GET)
  60. public String success(Model model) {
  61. return "addSuccess";
  62. }
  63. }

将我的询问放在评论部分。

祝您学习愉快!