当前位置：首页 > article >正文

Spring Boot中Bean Validation的实战应用

article 2025/2/27 7:21:33

在现代的Web开发中，数据验证是一个不可或缺的环节。它不仅可以保证数据的合法性，还能提升用户体验。Spring Boot结合JSR 303/349/380 Bean Validation API以及Thymeleaf模板引擎，为我们提供了一种高效且优雅的方式来实现数据验证。本文将通过一个简单的员工信息管理系统的实例，详细介绍如何在Spring Boot中使用Bean Validation API进行数据验证。

一、Bean Validation API简介

Bean Validation API（JSR 303/349/380）是一种用于Java Bean验证的规范，它允许我们通过注解的方式在Java类的字段上定义验证规则。这些注解在运行时会被验证框架解析，并对不符合规则的数据进行拦截和提示。在Spring Boot中，我们通常使用Hibernate Validator作为Bean Validation的实现。

二、实例：员工信息管理系统

假设我们正在开发一个员工信息管理系统，需要对员工的姓名、部门和出生日期进行验证。以下是实现该功能的具体步骤。

1. 定义Employee实体类

首先，我们需要定义一个Employee类，用于表示员工信息。在这个类中，我们将使用Bean Validation注解来定义字段的验证规则。

package com.logicbig.example;

import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.time.LocalDate;

public class Employee {
    @NotNull(message = "Name cannot be null")
    @Size(min = 5, max = 50, message = "Name must be between 5 and 50 characters")
    private String name;

    @Pattern(regexp = "Admin|IT|Sales|Accounts", message = "Invalid department")
    private String dept;

    @Past(message = "Date of birth must be in the past")
    @NotNull(message = "Date of birth cannot be null")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private LocalDate dateOfBirth;

    // Getters and Setters
}

在上述代码中，我们使用了以下注解：

@NotNull：字段不能为空。
@Size：字段的长度必须在指定范围内。
@Pattern：字段的值必须符合正则表达式。
@Past：日期字段必须是过去的日期。
@DateTimeFormat：用于将字符串格式化为日期对象。

2. 创建MVC控制器

接下来，我们需要创建一个控制器来处理员工信息的提交和展示。

@Controller
public class EmployeeController {
    private static List<Employee> employeeList = new ArrayList<>();

    @PostMapping("/")
    public String handlePostRequest(@Valid Employee employee, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            return "employee-form";
        }
        employeeList.add(employee);
        return "redirect:/employees";
    }

    @GetMapping("/")
    public String handleGetRequest(Model model) {
        model.addAttribute("employee", new Employee());
        return "employee-form";
    }

    @GetMapping("/employees")
    public String handleGetRequest(Model model) {
        model.addAttribute("employees", employeeList);
        return "employee-view";
    }
}

在handlePostRequest方法中，我们使用了@Valid注解来触发验证。如果验证失败，BindingResult会包含错误信息，并将用户重定向回表单页面。

3. Thymeleaf视图

为了展示表单和验证错误信息，我们需要创建两个Thymeleaf模板文件。

employee-form.html

<html>
<head>
<style>
table.emp-form td:nth-child(3){color:red;}
</style>
</head>
<body>
<form action="#" th:action="@{/}" th:object="${employee}" method="post">
    <table class="emp-form">
        <tr>
            <td>Name:</td>
            <td><input type="text" th:field="*{name}"/></td>
            <td th:if="${#fields.hasErrors('name')}" th:errors="*{name}">Name Error</td>
        </tr>
        <tr>
            <td>Department:</td>
            <td><input type="text" th:field="*{dept}"/></td>
            <td th:if="${#fields.hasErrors('dept')}" th:errors="*{dept}">Department Error</td>
        </tr>
        <tr>
            <td>Date Of Birth:</td>
            <td><input type="text" th:field="*{dateOfBirth}"/></td>
            <td th:if="${#fields.hasErrors('dateOfBirth')}" th:errors="*{dateOfBirth}">Date Of Birth Error</td>
        </tr>
        <tr>
            <td>
                <button type="submit">Submit</button>
            </td>
        </tr>
    </table>
</form>
</body>
</html>

employee-view.html

<html>
<head>
<style>
table.emp-table{width:100%;}
table.emp-table td {border:solid 1px #aaa;}
table.emp-table th {border:solid 1px #aaa; background: #bbb;}
</style>
</head>
<body>
    <h3>Saved Employees</h3>
    <table class="emp-table">
        <tr>
            <th>Name</th>
            <th>Department</th>
            <th>Date Of Birth</th>
        </tr>
        <tr th:each="employee : ${employees}">
            <td th:text="${employee.name}"></td>
            <td th:text="${employee.dept}"></td>
            <td th:text="${employee.dateOfBirth}"></td>
        </tr>
    </table>
    <br/>
    <a th:href="@{/}">Add new employee</a>
</body>
</html>