Sprint Boot @Validated使用方法详解

Spring Boot的@Validated的作用与使用方法

在Spring Boot中，@Validated注解用于对方法参数进行校验。通过使用@Validated注解，可以确保方法参数满足特定的条件，从而提高应用程序的健壮性和可靠性。

@Validated注解的作用

@Validated注解用于对方法参数进行校验。当使用@Validated注解标记一个方法时，Spring Boot会在调用该方法之前对方法参数进行校验。如果校验失败，则会抛出MethodArgumentNotValidException异常。

@Validated注解的使用方法

以下是使用@Validated注解的步骤：

1. 在方法参数上添加校验注解

首先，在方法参数上添加校验注解。以下是在方法参数上添加校验注解的示例：

public void saveUser(@Validated User user) {
    // ...
}

在上面的示例中，我们在saveUser方法的参数上添加了@Validated注解，并使用User类的校验注解对user参数进行校验。

1. 配置校验器

接下来，需要配置校验器。Spring Boot默认使用Hibernate Validator作为校验器。以下是配置校验器的示例：

@Configuration
public class ValidatorConfig {

    @Bean
    public Validator validator() {
        return new LocalValidatorFactoryBean();
    }
}

在上面的示例中，我们创建了一个Validator实例，并将其作为Bean注册到Spring Boot应用程序上下文中。

示例1：使用@Validated注解

以下是使用@Validated注解的示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public void saveUser(@Validated @RequestBody User user) {
        // ...
    }
}

在上面的示例中，我们在saveUser方法的参数上添加了@Validated注解，并使用@RequestBody注解将请求体映射到User对象上。当调用saveUser方法时，Spring Boot会对User对象进行校验。

示例2：使用@Validated注解

以下是使用@Validated注解的示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public void saveUser(@Validated({User.Create.class}) @RequestBody User user) {
        // ...
    }
}

在上面的示例中，我们在saveUser方法的参数上添加了@Validated注解，并使用{User.Create.class}分组对User对象进行校验。当调用saveUser方法时，Spring Boot会对User对象进行校验，并只校验User.Create分组中的校验注解。

结论

本文中，我们详细介绍了@Validated注解的作用和使用方法，并提供了两个示例说明。使用@Validated注解，可以对方法参数进行校验，从而提高应用程序的健壮性和可靠性。