Spring Bean 驗證 – JSR-303 注解 · HowToDoInJava 中文系列教程

# Spring Bean 驗證 – JSR-303 注解 > [https://howtodoinjava.com/spring-mvc/spring-bean-validation-example-with-jsr-303-annotations/](https://howtodoinjava.com/spring-mvc/spring-bean-validation-example-with-jsr-303-annotations/) [**JSR-303**](http://beanvalidation.org/1.0/spec/) bean 驗證是一個規范，其目的是通過注解標準化 Java bean 的驗證。 JSR-303 標準的目的是在 Java bean 類中直接使用注解。這允許直接在要驗證的代碼中指定驗證規則，而不是在單獨的類中創建驗證規則。到目前為止，我們了解了使用[`BindingResult.rejectValue()`](https://howtodoinjava.com/spring/spring-mvc/spring-mvc-display-validate-and-submit-form-example/)和[自定義驗證器實現](https://howtodoinjava.com/spring/spring-mvc/spring-mvc-custom-validator-example/)在 spring mvc 中進行的驗證。在本示例中，我們將學習**使用基于 JSR-303 標準**的注解來驗證 Spring 管理的 bean。 > **閱讀更多：[提交表單示例](https://howtodoinjava.com/spring/spring-mvc/spring-mvc-display-validate-and-submit-form-example/) & [自定義驗證程序示例](https://howtodoinjava.com/spring/spring-mvc/spring-mvc-custom-validator-example/)** 應用驗證后，前端 UI 上的錯誤消息將如下所示： ![Spring MVC JSR 303 Validation Annotations Example](https://img.kancloud.cn/94/69/9469e499029194f28c206be103ae4951_546x289.jpg) Spring MVC JSR 303 驗證注解示例 ## 添加 JSR-303 和 Hibernate 驗證器依賴關系要使**與 Spring** 一起使用 JSR-303 注解，您需要在`pom.xml`中添加以下依賴項。 ```java <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.0.0.GA</version> </dependency> ``` 為了使驗證真正起作用，您還需要一個實現，例如 [**Hibernate 驗證器**](http://hibernate.org/validator/)。 ```java <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>4.3.1.Final</version> </dependency> ``` ## 應用 JSR-303 注解添加 JSR-303 依賴關系后，您需要做的第一件事是用必要的 JSR-303 注解裝飾 Java bean。參見下面的`EmployeeVO`類，其字段使用諸如`@Size`和`@Pattern`之類的注解進行注解。 ```java package com.howtodoinjava.demo.model; import java.io.Serializable; import javax.validation.constraints.Pattern; import javax.validation.constraints.Size; public class EmployeeVO implements Serializable { private static final long serialVersionUID = 1L; private Integer id; @Size(min = 3, max = 20) private String firstName; @Size(min = 3, max = 20) private String lastName; @Pattern(regexp=".+@.+\\.[a-z]+") private String email; //Setters and Getters @Override public String toString() { return "EmployeeVO [id=" + id + ", firstName=" + firstName + ", lastName=" + lastName + ", email=" + email + "]"; } } ``` > **閱讀更多：[所有受支持的 JSR-303 注解的列表](http://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-builtin-constraints)** ## 控制器變更要應用此驗證器，您需要對控制器執行以下修改。 1）包括對控制器類的驗證器引用，以便您可以跨控制器中的所有方法訪問它。 ```java private Validator validator; ``` 2）下一個更改是在控制器的`post`方法中，該方法在用戶提交表單時調用。 ```java @RequestMapping(method = RequestMethod.POST) public String submitForm(@ModelAttribute("employee") EmployeeVO employeeVO, BindingResult result, SessionStatus status) { Set<ConstraintViolation<EmployeeVO>> violations = validator.validate(employeeVO); for (ConstraintViolation<EmployeeVO> violation : violations) { String propertyPath = violation.getPropertyPath().toString(); String message = violation.getMessage(); // Add JSR-303 errors to BindingResult // This allows Spring to display them in view via a FieldError result.addError(new FieldError("employee",propertyPath, "Invalid "+ propertyPath + "(" + message + ")")); } if (result.hasErrors()) { return "addEmployee"; } // Store the employee information in database // manager.createNewRecord(employeeVO); // Mark Session Complete status.setComplete(); return "redirect:addNew/success"; } ``` 請注意，與早期的 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 MVC Form Example - Blank Form](https://img.kancloud.cn/43/2c/432ce8a84fdf5451769974fd3818d242_474x263.jpg)](https://howtodoinjava.com/wp-content/uploads/2015/02/Spring-MVC-Form-Example-Blank-Form.png) Spring MVC 表單示例 – 空白表單 2）在不填寫任何字段的情況下，提交表格。您將得到特定于每個字段的錯誤。 [![Spring MVC JSR 303 Validation Annotations Example](https://img.kancloud.cn/94/69/9469e499029194f28c206be103ae4951_546x289.jpg)](https://howtodoinjava.com/wp-content/uploads/2015/02/Spring-MVC-JSR-303-Validation-Annotations-Example.png) Spring MVC JSR 303 驗證注解示例 3）填寫所有字段，然后按`Submit`按鈕。將顯示成功頁面。 [![Spring MVC Form Example - Success Message](https://img.kancloud.cn/61/50/61504b8a4e98ffd7e17b6fe41c24949a_563x213.jpg)](https://howtodoinjava.com/wp-content/uploads/2015/02/Spring-MVC-Form-Example-Success-Message.png) Spring MVC 表單示例 – 成功消息作為參考，完整的`pom.xml`文件如下： ```java <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.howtodoinjava.demo</groupId> <artifactId>springmvcexample</artifactId> <packaging>war</packaging> <version>1.0-SNAPSHOT</version> <name>springmvcexample Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency>  <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>4.1.4.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>4.1.4.RELEASE</version> </dependency>  <dependency> <groupId>javax.servlet</groupId> <artifactId>jstl</artifactId> <version>1.2</version> <scope>runtime</scope> </dependency> <dependency> <groupId>taglibs</groupId> <artifactId>standard</artifactId> <version>1.1.2</version> <scope>runtime</scope> </dependency>  <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.0.0.GA</version> </dependency> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>4.3.1.Final</version> </dependency> </dependencies> <build> <finalName>springmvcexample</finalName> </build> </project> ``` 而`EmployeeController`類如下： ```java package com.howtodoinjava.demo.controller; import java.util.Set; import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.validation.Validator; import javax.validation.ValidatorFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.validation.BindingResult; import org.springframework.validation.FieldError; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.SessionAttributes; import org.springframework.web.bind.support.SessionStatus; import com.howtodoinjava.demo.model.EmployeeVO; import com.howtodoinjava.demo.service.EmployeeManager; @Controller @RequestMapping("/employee-module/addNew") @SessionAttributes("employee") public class EmployeeController { @Autowired EmployeeManager manager; private Validator validator; public EmployeeController() { ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory(); validator = validatorFactory.getValidator(); } @RequestMapping(method = RequestMethod.GET) public String setupForm(Model model) { EmployeeVO employeeVO = new EmployeeVO(); model.addAttribute("employee", employeeVO); return "addEmployee"; } @RequestMapping(method = RequestMethod.POST) public String submitForm(@ModelAttribute("employee") EmployeeVO employeeVO, BindingResult result, SessionStatus status) { Set<ConstraintViolation<EmployeeVO>> violations = validator.validate(employeeVO); for (ConstraintViolation<EmployeeVO> violation : violations) { String propertyPath = violation.getPropertyPath().toString(); String message = violation.getMessage(); // Add JSR-303 errors to BindingResult // This allows Spring to display them in view via a FieldError result.addError(new FieldError("employee",propertyPath, "Invalid "+ propertyPath + "(" + message + ")")); } if (result.hasErrors()) { return "addEmployee"; } // Store the employee information in database // manager.createNewRecord(employeeVO); // Mark Session Complete status.setComplete(); return "redirect:addNew/success"; } @RequestMapping(value = "/success", method = RequestMethod.GET) public String success(Model model) { return "addSuccess"; } } ``` 將我的詢問放在評論部分。 **祝您學習愉快！**