java Validated注解在什么时候生效

原创

mob649e81563816 2025-01-03 06:34:01 ©著作权

文章标签 spring java Java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e81563816的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java Validation 注解的生效时机

在Java应用程序开发中，数据的有效性验证是一个至关重要的环节。为了确保从用户输入到业务逻辑处理的数据的有效性，Java提供了一整套规范，其中最常用的就是Bean Validation API（JSR 380）。在这一API中，@Validated注解扮演着很重要的角色。

在本文中，我们将深入剖析@Validated注解的生效时机，同时通过示例代码进行演示，以帮助更好地理解其用法。

@Validated注解简介

@Validated注解通常用于Spring框架中，主要用于触发Java Bean的验证机制。其工作原理是，当你将注解应用于类或方法时，Spring容器会自动执行绑定在这个类或方法上的验证逻辑。

使用场景

在控制器方法上，验证请求参数。
在服务类上，确保传入的业务对象有效。

@Validated生效的时机

@Validated注解的生效时机主要包括：

请求到达Controller层：当HTTP请求到达控制器时，Spring会自动对@RequestBody或@RequestParam注解标识的参数进行校验。
服务层方法调用：在服务层中，使用@Validated注解修饰的方法参数，也会在该方法被调用时触发验证。

示例代码

下面我们将通过一个简单的用户注册示例来说明@Validated的使用。

1. 定义数据模型类

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

public class UserRegistration {

    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    @Size(min = 6, message = "密码长度最小为6位")
    private String password;

    @Email(message = "邮箱格式不正确")
    private String email;

    // getters and setters
}

2. 创建控制器

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.validation.annotation.Validated;

@Controller
public class UserController {

    @PostMapping("/register")
    @ResponseBody
    public String register(@Validated @RequestBody UserRegistration userRegistration) {
        // Registration logic
        return "Registration successful for " + userRegistration.getUsername();
    }
}

3. 创建服务层

import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;

@Service
public class UserService {

    public void registerUser(@Validated UserRegistration user) {
        // User registration logic
    }
}

请求示例

假设我们发送一个POST请求到/register：

{
  "username": "user123",
  "password": "password",
  "email": "user@example.com"
}

如果请求体符合约束条件，则会返回成功消息。如果不符合，则会抛出验证异常。

验证流程甘特图

为了更直观地理解@Validated注解的生效流程，以下是一个验证流程的甘特图：

gantt
    title 验证流程
    dateFormat  YYYY-MM-DD
    section 接收请求
    控制器接收请求 :a1, 2023-10-01, 1d
    section 执行验证
    验证请求参数  :after a1, 2023-10-02, 1d
    验证服务参数 :after a1, 2023-10-03, 1d
    section 返回结果
    返回注册结果 :after a1, 2023-10-04, 1d

类图

下面是一个对应的类图，展示了UserRegistration、UserController和UserService之间的关系：

classDiagram
    class UserRegistration {
        +String username
        +String password
        +String email
    }
    
    class UserController {
        +String register(UserRegistration userRegistration)
    }
    
    class UserService {
        +void registerUser(UserRegistration user)
    }
    
    UserController --> UserRegistration
    UserService --> UserRegistration