Spring Boot 引入参数校验
在使用 Spring Boot 开发应用程序时，我们经常需要对用户输入的参数进行校验，以确保数据的有效性和安全性。Spring Boot 提供了一种简单而强大的参数校验机制，可以通过注解的方式在方法参数上进行校验。本文将介绍如何在 Spring Boot 中引入参数校验，并给出相应的代码示例。
什么是参数校验？
参数校验是一种确保接收到的数据符合预期的方式。它可以在后台验证用户输入的数据，从而避免无效或不安全的数据进入系统。参数校验可以对各种类型的数据进行验证，例如字符串长度、数值范围、正则表达式等。
Spring Boot 中的参数校验
在 Spring Boot 中，参数校验是通过 JSR-303 Bean Validation 标准实现的。该标准定义了一组注解，可以直接应用在方法参数上，以实现参数校验的功能。
要在 Spring Boot 中引入参数校验，我们需要做以下几个步骤：
- 引入相关依赖
- 在实体类中添加校验注解
- 在 Controller 类中添加校验注解
引入相关依赖
首先，在 pom.xml 文件中添加以下依赖：
<dependencies>
<!-- Spring Boot Web Starter -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Hibernate Validator -->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
</dependencies>
spring-boot-starter-web 是 Spring Boot 的 Web Starter，它包含了一些常用的 Web 开发所需的依赖。hibernate-validator 是 Hibernate Validator，它是 JSR-303 Bean Validation 的一个实现。
在实体类中添加校验注解
接下来，在需要校验的实体类上添加相应的校验注解。例如，我们有一个用户实体类 User，其中包含了用户名和年龄字段。我们可以通过 @NotBlank 注解确保用户名字段不为空，通过 @Min 注解确保年龄字段的最小值不小于 18。
public class User {
@NotBlank(message = "用户名不能为空")
private String username;
@Min(value = 18, message = "年龄必须大于等于 18 岁")
private int age;
// 省略 getter 和 setter 方法
}
在上面的代码中，@NotBlank 注解表示用户名不能为空，@Min 注解表示年龄必须大于等于 18 岁。这些注解是根据 JSR-303 Bean Validation 标准定义的，可以直接在实体类中使用。
在 Controller 类中添加校验注解
最后，在 Controller 类中的方法参数上添加校验注解。例如，我们有一个注册用户的接口 /api/register，其中包含了用户名和年龄两个参数。我们可以在方法参数上添加 @Valid 注解，表示对该参数进行校验。
@RestController
@RequestMapping("/api")
public class UserController {
@PostMapping("/register")
public String registerUser(@Valid @RequestBody User user) {
// 处理用户注册逻辑
return "注册成功";
}
}
在上面的代码中，@Valid 注解表示对 @RequestBody 注解修饰的 User 对象进行校验。如果校验失败，Spring Boot 会抛出一个 MethodArgumentNotValidException 异常，并返回相应的错误信息。
示例代码
下面是一个完整的示例代码：
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
public class User {
@NotBlank(message = "用户名不能为空")
private String username;
@Min(value = 18, message = "年龄必须大于等于 18 岁")
private int age;
// 省略 getter 和 setter 方法
}
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
@RestController
@RequestMapping("/api")
public class UserController {
@PostMapping("/register")
