spring boot 参数的过滤注解与实战

简介: 在Spring Boot应用中,对于入参的过滤,通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持,主要基于JSR-303/JSR-380(Bean Validation API)规范,以及Spring自身的@Valid或@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。

在Spring Boot应用中,对于入参的过滤,通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持,主要基于JSR-303/JSR-380(Bean Validation API)规范,以及Spring自身的@Valid@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。

基本使用

  1. 添加依赖

首先确保你的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>
  1. 创建模型并使用验证注解

比如,你有一个用户提交表单的场景,你需要验证用户的输入。

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略
}
  1. 在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响应返回给客户端。

分组验证

你还可以利用分组功能,对不同的操作应用不同的验证规则。

  1. 定义验证组接口

java复制代码

public interface OnCreate {}
public interface OnUpdate {}
  1. 在模型类中指定组

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略
}
  1. 在Controller中指定验证组

java复制代码

@PostMapping("/register")
public String register(@Validated(OnCreate.class) @RequestBody UserInput userInput) {
    // 处理用户注册逻辑
    return "注册成功!";
}

这样,你可以根据不同的操作(如创建和更新)对同一数据模型应用不同的验证规则。

自定义验证注解

如果内置的验证注解无法满足你的需求,你还可以创建自定义的验证注解。

  1. 创建自定义验证注解

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 {};
}
  1. 实现验证逻辑

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; // 示例总是返回失败
    }
}
  1. 使用自定义验证注解

java复制代码

public class UserInput {

    @MyConstraint(message = "自定义验证消息")
    private String customField;

    // Getter和Setter略
}

通过这种方式,你可以非常灵活地实现各种自定义验证逻辑,并通过注解的方式轻松应用到你的数据模型上。

以上就是在Spring Boot中对参数进行过滤和验证的一些常见做法。通过结合使用Bean Validation提供的注解以及Spring的支持,你可以非常方便地对输入数据进行校验,进而提高应用的健壮性和安全性。

相关文章
|
3天前
|
Java Spring
SpringBoot接收参数的方式
本文介绍了Java Spring Boot中处理GET请求的多种方式。可以使用方法参数直接接收,或者通过`@RequestParam`注解指定必传参数。此外,可以用实体类接收多个相关参数,但不能同时使用`@RequestParam`。还可以通过`HttpServletRequest`对象获取参数,或利用`@PathVariable`接收路径变量。对于数组和集合参数,需注意使用`@RequestParam`注解。
|
2天前
|
Java Spring 容器
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
10 1
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
|
2天前
|
缓存 NoSQL Java
Spring Cache之本地缓存注解@Cacheable,@CachePut,@CacheEvict使用
SpringCache不支持灵活的缓存时间和集群,适合数据量小的单机服务或对一致性要求不高的场景。`@EnableCaching`启用缓存。`@Cacheable`用于缓存方法返回值,`value`指定缓存名称,`key`定义缓存键,可按SpEL编写,`unless`决定是否不缓存空值。当在类上使用时,类内所有方法都支持缓存。`@CachePut`每次执行方法后都会更新缓存,而`@CacheEvict`用于清除缓存,支持按键清除或全部清除。Spring Cache结合Redis可支持集群环境。
27 5
|
3天前
|
Java Python Spring
小唐开始学 Spring Boot——(2)Spring Boot核心配置与注解
小唐开始学 Spring Boot——(2)Spring Boot核心配置与注解
|
10天前
|
Java
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
|
11天前
|
Java 开发者 Spring
springboot DDD的概念以及实战
【5月更文挑战第15天】领域驱动设计(Domain-Driven Design,简称DDD)是一种软件设计方法论,它强调基于业务领域的复杂性来构建软件
26 2
|
Java Spring 前端开发
spring 3.2 自定义参数绑定--日期格式转换器
springmvc配置文件 &lt;!-- 代替org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping 和org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter --&gt;
2395 0
|
11天前
|
Java 应用服务中间件 Maven
SpringBoot 项目瘦身指南
SpringBoot 项目瘦身指南
65 0
|
11天前
|
缓存 安全 Java
Spring Boot 面试题及答案整理,最新面试题
Spring Boot 面试题及答案整理,最新面试题
143 0
|
11天前
|
存储 JSON Java
SpringBoot集成AOP实现每个接口请求参数和返回参数并记录每个接口请求时间
SpringBoot集成AOP实现每个接口请求参数和返回参数并记录每个接口请求时间
50 2