SpringBoot 依赖之Validation

news2024/9/20 16:37:38

Validation

依赖名称: Validation
功能描述: Bean Validation with Hibernate validator.
使用 Hibernate 验证器进行 Bean 验证。

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

**源码已开源，可以免费下载**
码云gitee： https://gitee.com/CoderChange/springboot-all-dependencies

我们在 IntelliJ IDEA 中创建一个 Spring Boot 项目并使用 Validation 依赖来进行数据验证，可以按照以下步骤进行操作：
写在前面，创建项目这一步几乎每个依赖都有相似点，记住一个通吃全关，重点是理解各个依赖的引入和使用方式，再结合自己的业务场景恰如其分的使用它，才是程序员该做的事情。

1. 创建 Spring Boot 项目

打开 IntelliJ IDEA 并点击 “New Project”。
选择 “Spring Initializr”，然后点击 “Next”。
填写项目的基本信息：
- Group: com.dependencies
- Artifact: demo
- Name: validation
- Description: validation Demo project for Spring Boot
- Package name: com.dependencies.validation
- Packaging: Jar
- Java: 17
选择依赖：
- Spring Web
- Validation
点击 “Next”，然后点击 “Finish”，等待 IDEA 下载依赖并初始化项目。

2. 添加 Validation 依赖

在 pom.xml 文件中添加 Validation 依赖，项目在创建的时候勾选需要的依赖，都会自动生成下面的依赖配置xml：

<properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

3. 创建数据模型类User

创建一个简单的数据模型类 User，并使用注解进行数据验证：

package com.dependencies.validation.model;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

/**
 * @author zhizhou   2024/7/28 15:46
 */
public class User {
    
    @NotNull(message = "id不能为null")
    private Integer id;
    
    @NotBlank(message = "姓名不能为空")
    @Size(min = 2, max = 30, message = "姓名长度必须在2到30个字符之间")
    private String name;
    
    @NotBlank(message = "邮箱不能为空")
    @Email(message = "邮箱格式不正确")
    private String email;
    
    public Integer getId() {
        return id;
    }
    
    public void setId(Integer id) {
        this.id = id;
    }
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public String getEmail() {
        return email;
    }
    
    public void setEmail(String email) {
        this.email = email;
    }
}

4. 创建控制器类`UserController`

创建一个控制器类 UserController，处理 HTTP 请求并进行数据验证：

package com.dependencies.validation.controller;

import com.dependencies.validation.model.User;
import jakarta.validation.Valid;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * @author zhizhou   2024/7/28 15:45
 */
@RestController
@RequestMapping("/users")
@Validated
public class UserController {
    
    @PostMapping
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        //这里通常你可以定制逻辑 保存用户信息导数据库 咱就不延展了 重点看validation功能
        return ResponseEntity.ok("User is valid");
    }
    
    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable @Min(119) Integer id) {
        // 这里咱们就下发一个demo数据好了
        User user = new User();
        user.setId(id);
        user.setName("ZhiZhou");
        user.setEmail("ZhiZhou@iamcoder.com");
        return ResponseEntity.ok(user);
    }
}

5. 全局异常处理 GlobalExceptionHandler

为了处理验证错误并返回友好的错误信息，可以创建一个全局异常处理类：

package com.dependencies.validation.exception;

import jakarta.validation.ConstraintViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

/**
 * @author zhizhou   2024/7/28 15:51
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException e) {
        Map<String, String> errors = new HashMap<>();
        e.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
    
    @ExceptionHandler(ConstraintViolationException.class)
    public ResponseEntity<Map<String, String>> handleConstraintViolationException(ConstraintViolationException e) {
        Map<String, String> errors = new HashMap<>();
        e.getConstraintViolations().forEach(violation -> {
            String fieldName = violation.getPropertyPath().toString();
            String errorMessage = violation.getMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}