🎓博主介绍:Java、Python、js全栈开发 “多面手”,精通多种编程语言和技术,痴迷于人工智能领域。秉持着对技术的热爱与执着,持续探索创新,愿在此分享交流和学习,与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略:多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来,希望帮助更多的人
SpringBoot参数校验黑科技:Validation+自定义注解实现业务规则校验
一、引言
在开发基于Spring Boot的Web应用程序时,参数校验是一个必不可少的环节。良好的参数校验可以确保系统接收到的数据符合预期,避免因无效数据导致的各种异常和错误,提高系统的稳定性和可靠性。传统的参数校验方式往往代码冗余,维护成本高。而Spring Boot提供的Validation框架结合自定义注解的方式,为我们提供了一种简洁、高效且灵活的参数校验解决方案。本文将详细介绍如何利用Validation和自定义注解实现业务规则校验。
二、Spring Boot Validation基础
2.1 引入依赖
在使用Spring Boot Validation之前,需要在pom.xml
文件中引入相关依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
这个依赖包含了Spring Boot对Java Bean Validation API(JSR 380)的支持。
2.2 基本注解使用
Spring Boot Validation提供了一系列内置的注解,用于对Java Bean的属性进行校验。以下是一些常用的注解及其作用:
@NotNull
:验证对象是否不为null
。@NotEmpty
:验证字符串、集合、数组等是否不为空。@NotBlank
:验证字符串是否不为空且去除首尾空格后长度不为0。@Size
:验证字符串、集合、数组等的长度是否在指定范围内。@Min
和@Max
:验证数值是否在指定的最小值和最大值之间。
下面是一个简单的示例:
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
public class User {
@NotNull(message = "用户ID不能为空")
private Long id;
@NotBlank(message = "用户名不能为空")
@Size(min = 2, max = 20, message = "用户名长度必须在2到20之间")
private String username;
// 省略getter和setter方法
}
2.3 在Controller中使用校验
在Controller方法中,可以使用@Valid
注解来触发对请求参数的校验。如果校验失败,Spring会抛出MethodArgumentNotValidException
异常。
import org.springframework.validation.BindingResult;
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.RestController;
import javax.validation.Valid;
@RestController
@Validated
public class UserController {
@PostMapping("/users")
public String createUser(@Valid @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return bindingResult.getAllErrors().get(0).getDefaultMessage();
}
// 处理业务逻辑
return "用户创建成功";
}
}
三、自定义注解实现业务规则校验
3.1 为什么需要自定义注解
虽然Spring Boot Validation提供了很多内置的注解,但在实际开发中,我们可能会遇到一些特殊的业务规则,这些规则无法用内置注解来实现。例如,验证用户输入的密码是否包含数字和字母,验证日期是否在某个特定的范围内等。这时,我们就需要自定义注解来实现这些业务规则。
3.2 自定义注解的实现步骤
3.2.1 定义注解
首先,我们需要定义一个自定义注解。注解的定义需要使用@Target
、@Retention
等元注解来指定注解的使用范围和生命周期。
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = PasswordValidator.class)
public @interface ValidPassword {
String message() default "密码必须包含数字和字母";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
3.2.2 实现校验器
接下来,我们需要实现一个校验器类,该类需要实现ConstraintValidator
接口。
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Pattern;
public class PasswordValidator implements ConstraintValidator<ValidPassword, String> {
private static final Pattern PASSWORD_PATTERN = Pattern.compile("^(?=.*[0-9])(?=.*[a-zA-Z]).{6,}$");
@Override
public void initialize(ValidPassword constraintAnnotation) {
// 初始化方法,可用于获取注解中的属性值
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (value == null) {
return false;
}
return PASSWORD_PATTERN.matcher(value).matches();
}
}
3.2.3 使用自定义注解
在Java Bean中使用自定义注解:
import javax.validation.constraints.NotBlank;
public class User {
@NotBlank(message = "用户名不能为空")
private String username;
@ValidPassword
private String password;
// 省略getter和setter方法
}
四、高级应用场景
4.1 分组校验
在某些情况下,我们可能需要对不同的业务场景进行不同的校验。例如,在用户注册时,需要验证用户名、密码等信息;而在用户登录时,只需要验证用户名和密码是否为空。这时,我们可以使用分组校验来实现。
4.1.1 定义分组接口
public interface RegisterGroup {}
public interface LoginGroup {}
4.1.2 在注解中指定分组
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
public class User {
@NotBlank(message = "用户名不能为空", groups = {RegisterGroup.class, LoginGroup.class})
@Size(min = 2, max = 20, message = "用户名长度必须在2到20之间", groups = RegisterGroup.class)
private String username;
@NotBlank(message = "密码不能为空", groups = {RegisterGroup.class, LoginGroup.class})
private String password;
// 省略getter和setter方法
}
4.1.3 在Controller中指定分组
import org.springframework.validation.BindingResult;
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.RestController;
import javax.validation.Valid;
@RestController
@Validated
public class UserController {
@PostMapping("/register")
public String register(@Validated(RegisterGroup.class) @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return bindingResult.getAllErrors().get(0).getDefaultMessage();
}
// 处理注册业务逻辑
return "用户注册成功";
}
@PostMapping("/login")
public String login(@Validated(LoginGroup.class) @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return bindingResult.getAllErrors().get(0).getDefaultMessage();
}
// 处理登录业务逻辑
return "用户登录成功";
}
}
4.2 嵌套对象校验
如果Java Bean中包含嵌套对象,我们可以使用@Valid
注解来触发对嵌套对象的校验。
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
public class Order {
@NotBlank(message = "订单编号不能为空")
private String orderNumber;
@Valid
private User user;
// 省略getter和setter方法
}
在Controller中使用:
import org.springframework.validation.BindingResult;
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.RestController;
import javax.validation.Valid;
@RestController
@Validated
public class OrderController {
@PostMapping("/orders")
public String createOrder(@Valid @RequestBody Order order, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return bindingResult.getAllErrors().get(0).getDefaultMessage();
}
// 处理订单业务逻辑
return "订单创建成功";
}
}
五、总结
通过Spring Boot Validation和自定义注解,我们可以实现高效、灵活的参数校验。内置注解可以满足大部分常见的校验需求,而自定义注解则可以帮助我们实现特殊的业务规则。分组校验和嵌套对象校验进一步扩展了参数校验的功能,使我们能够更好地应对各种复杂的业务场景。在实际开发中,合理运用这些技术可以提高代码的可维护性和系统的稳定性。