掌握Spring Boot Validation，你就是程序界的设计师！

后端

2023-12-19 20:46:51

Spring Boot Validation：让参数校验变得轻而易举

简介

作为一名 Java 开发人员，参数校验是至关重要的。它能确保传入方法的参数是合法的，避免程序崩溃。但是，传统的手动参数校验需要大量繁琐且容易出错的代码。

幸运的是，Spring Boot Validation 横空出世，彻底改变了参数校验的格局。它简化了校验过程，让开发者可以轻松应对各种参数校验场景。

1. @Validated 注解

Spring Boot Validation 提供了 @Validated 注解，你可以将它添加到需要进行参数校验的方法上。然后，在方法的参数上添加相应的验证注解即可。

代码示例：

import javax.validation.constraints.NotBlank;

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

@Controller
public class UserController {

    @PostMapping("/user/create")
    @ResponseBody
    public String createUser(@Validated @RequestBody User user) {
        // 业务逻辑
        return "success";
    }

}

import javax.validation.constraints.Email;

public class User {

    @NotBlank
    private String name;

    @Email
    private String email;

    // 省略其他属性

}

在这里，我们使用了 @NotBlank 注解来校验 name 属性不能为空，而 @Email 注解则用来校验 email 属性是否是一个合法的邮箱地址。当请求参数不合法时，Spring Boot Validation 会自动抛出异常，你可以通过 try-catch 块捕获这些异常并进行相应的处理。

2. 验证注解

Spring Boot Validation 提供了丰富的验证注解，可以满足各种校验需求。以下是一些常用的注解：

@NotBlank：校验字符串不能为空
@NotNull：校验对象不能为空
@Email：校验邮箱地址
@Pattern：校验字符串是否符合正则表达式
@Size：校验字符串或数组的长度
@Min：校验数值的最小值
@Max：校验数值的最大值

3. 分组验证

Spring Boot Validation 支持分组验证，你可以将验证注解分组，然后根据不同的场景指定要执行哪个组的验证。

代码示例：

import javax.validation.groups.Default;

public interface UserCreate {

}

public interface UserUpdate {

}

import javax.validation.constraints.NotBlank;

public class User {

    @NotBlank(groups = {UserCreate.class})
    private String name;

    @Email(groups = {UserCreate.class, UserUpdate.class})
    private String email;

    // 省略其他属性

}