springboot使用校验框架validation校验的示例

下面我将为您详细讲解 "springboot使用校验框架validation校验的示例"。

1. 简介

Spring Boot是一个非常受欢迎的Java开发框架，同样，校验数据是每个Web应用的基本要求之一。在Spring Boot中，可以使用Validation框架轻松地完成数据校验。

Validation是Java Bean Validation API中的一个框架，它提供了一个注解机制，可以在Bean属性上添加各种检验规则，并且可以在运行时进行检验。

2. 示例1

首先，我们需要在Spring Boot项目中添加Validation的依赖

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

接下来，我们需要定义一个DTO类，这个类里面定义了需要校验的属性和校验规则。比如，下面这个类是一个用户注册请求DTO类，其中username、password和email三个属性是需要校验的。

public class UserRegisterRequest {

    @NotBlank
    @Length(min = 4, max = 20, message = "用户名长度为4-20个字符")
    private String username;

    @NotBlank
    @Length(min = 8, max = 20, message = "密码长度为8-20个字符")
    private String password;

    @Email(message = "请输入正确的邮箱地址")
    private String email;

    // getter and setter
}

上面的DTO类使用了Validation框架提供的注解，@NotBlank 表示不允许为空字符串，@Length 表示字符串长度限制，@Email 表示必须为合法的电子邮件地址。

最后，我们需要在Controller中处理校验请求，如下：

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

    @PostMapping("/register")
    public ApiResponse register(@RequestBody @Valid UserRegisterRequest request) {
        // 处理注册逻辑
    }
}

使用@Valid注解对UserRegisterRequest进行校验，如果校验失败，会抛出MethodArgumentNotValidException异常。

3. 示例2

接下来，我们来看一个验证集合元素的例子。

假设我们有一个DTO类包含一个字符串类型的列表属性，如下：

public class UserRegisterListRequest {

    @Size(min = 1, message = "不能为空")
    private List<@NotBlank String> usernames;

    // getter and setter
}

@Size 表示列表不能是空的，@NotBlank 表示字符串不能为空。

这里的 @NotBlank 注解没有用在属性上，而是用在了泛型类型的String上。在Java 8中，增加了一个新的特性Java Parameter Name Reflection，使得Bean Validation API可以获取到泛型类型上的注解。

至此，我们就使用Validation框架完成了对请求数据的校验。

以上是 "springboot使用校验框架validation校验的示例" 的完整攻略。

阅读剩余 41%