spring boot 参数的过滤注解与实战
原创spring boot 参数的过滤注解与实战
原创
在Spring Boot应用中，对于入参的过滤，通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持，主要基于JSR-303/JSR-380（Bean Validation API）规范，以及Spring自身的@Valid或@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。
基本使用
- 添加依赖
首先确保你的pom.xml中包含了Spring Boot的starter依赖以及Bean Validation API的实现（如Hibernate Validator）。
xml复制代码<!-- Spring Boot Starter Web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Bean Validation API, Hibernate Validator -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>- 创建模型并使用验证注解
比如，你有一个用户提交表单的场景，你需要验证用户的输入。
java复制代码import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
public class UserInput {
@NotBlank(message = "用户名不能为空")
private String username;
@Size(min = 6, max = 20, message = "密码长度必须在6到20字符之间")
private String password;
// Getter和Setter略
}- 在Controller中使用
@Valid或@Validated进行验证
java复制代码import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping("/register")
public String register(@Validated @RequestBody UserInput userInput) {
// 处理用户注册逻辑
return "注册成功！";
}
}当请求到达该接口时，Spring会自动根据UserInput类中的注解对传入的数据进行验证，如果验证失败，则默认抛出一个异常，通常会转换为400 Bad Request响应返回给客户端。
分组验证
你还可以利用分组功能，对不同的操作应用不同的验证规则。
- 定义验证组接口
java复制代码public interface OnCreate {}
public interface OnUpdate {}- 在模型类中指定组
java复制代码public class UserInput {
@NotBlank(message = "用户名不能为空", groups = OnCreate.class)
private String username;
@Size(min = 6, max = 20, message = "密码长度必须在6到20字符之间", groups = OnCreate.class)
private String password;
// Getter和Setter略
}- 在Controller中指定验证组
java复制代码@PostMapping("/register")
public String register(@Validated(OnCreate.class) @RequestBody UserInput userInput) {
// 处理用户注册逻辑
return "注册成功！";
}这样，你可以根据不同的操作（如创建和更新）对同一数据模型应用不同的验证规则。
自定义验证注解
如果内置的验证注解无法满足你的需求，你还可以创建自定义的验证注解。
- 创建自定义验证注解
java复制代码import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Constraint(validatedBy = MyConstraintValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyConstraint {
String message() default "默认验证失败消息";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}- 实现验证逻辑
java复制代码import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class MyConstraintValidator implements ConstraintValidator<MyConstraint, String> {
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 实现你的验证逻辑
return false; // 示例总是返回失败
}
}- 使用自定义验证注解
java复制代码public class UserInput {
@MyConstraint(message = "自定义验证消息")
private String customField;
// Getter和Setter略
}通过这种方式，你可以非常灵活地实现各种自定义验证逻辑，并通过注解的方式轻松应用到你的数据模型上。
以上就是在Spring Boot中对参数进行过滤和验证的一些常见做法。通过结合使用Bean Validation提供的注解以及Spring的支持，你可以非常方便地对输入数据进行校验，进而提高应用的健壮性和安全性。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。