SpringBoot3.4配置校验新特性的用法详解

2025-04-29 17:50

本文主要是介绍SpringBoot3.4配置校验新特性的用法详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《SpringBoot3.4配置校验新特性的用法详解》SpringBoot3.4对配置校验支持进行了全面升级,这篇文章为大家详细介绍了一下它们的具体使用,文中的示例代码讲解详细,感兴趣的小伙伴可以参考...

配置属性验证增强亮点

Spring Boot 3.4 对配置校验支持进行了全面升级,核心亮点包括:

  • 支持 jakarta.validation 全套标准注解(如 @NotNull@Email@Pattern 等)
  • 嵌套对象、集合元素 的深度校验支持
  • 启动阶段校验失败,IDE友好提示,快速定位问题
  • 自动生成更完善的开发时元信python(metadata)

可以说,从易用性到严谨性,都有了质的飞跃!

基本用法示例

定义配置类

以用户配置为例:

package com.icoderoad.China编程demo.config;


import jakarta.validation.Valid;
import jakarta.validation.constraints.*;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;


import Java.util.List;


@Validated
@ConfigurationProperties(prefix = "app.user")
public class UserProperties {


    @NotBlank(message = "用户名不能为空")
    private String username;


    @Email(message = "邮箱格式不正确")
    private String email;


    @Min(value = 18, message = "年龄不能小于18岁")
    private Integer age;


    @Valid
    private Address address;


    @Size(min = 1, message = "至少需要一个角色")
    private List<@NotBlank(message = "角色名称不能为空") String> roles;


    // Address是嵌套对象,需要加@Valid
    public static class Address {
        @NotBlank(message = "城市不能为空")
        private String city;


        @Pattern(regexp = "\d{6}", message = "邮编必须是6位数字")
        private String zipCode;


        // getter/setterphp
        public String getCity() {
            return city;
        }
        public void setCity(String city) {
            this.city = city;
        }
        public String getZipCode() {
            return zipCode;
        }
        public void setZipCode(String zipCode) {
            this.zipCode = zipCode;
        }
    }


    // getter/setter
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public Address getAddress() {
        return address;
    }
    public void setAddress(Address address) {
        this.address = address;
    }
    public List<String> getRoles() {
        return roles;
    }
    public void setRoles(List<String> roles) {
        this.roles = roles;
    }
}

配置 application.yml

app:
  user:
    username: "张三"
    email: "zhangsan@example.com"
    age: 25
    address:
      city: "上海"
      zipCode: "200000"
    roles:
      - "admin"
      - "user"

注入使用

在你的服务中注入:

package com.icoderoad.demo.service;


import com.example.demo.config.UserProperties;
import org.springframework.stereotype.Service;


@Service
public class UserService {


    private final UserProperties userProperties;


    public UserService(UserProperties userProperties) {
        this.userProperties = userProperties;
    }


    public void printUserInfo() {
        System.out.println("用户名:" + userProperties.getUsername());
        System.out.println("邮箱:" + userProperties.getEmail());
    }
}

嵌套对象与集合元素深度校验

注意,在嵌套对象上必须标注 @Valid,才能对子属性继续校验。集合元素(如 List<String>)同样支持元素级校验注解

这让配置类的约束更加细粒度、安全

启动阶段即校验失败

如果配置不符合要求,比如漏填 username、邮箱格式错误、年龄不足18岁、角色列表为空等,Spring Boot 启动时就会直接报错

示例错误日志:

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target [Bindable@xxx type = com.icoderoad.demo.config.UserProperties] failed:

    Property: app.user.username
    Value: 
    Reason: 用户名不能为空

    Property: app.user.email
    Value: not-an-email
    Reason: 邮箱格式不正确

非常直观,能第一时间发现配置问题,避免服务上线后隐患!

开发时元信息增强

配合 Spring Boot 的 spring-boot-configuration-processor 插件,还能自动生成提示补全信息(IDE 中 .yml 配置智能提示)!

pom.XML 配置:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

编译后,会生成 META-INF/spring-configuration-metadata.json,供 IDE 智能补全参考。

注意事项

  • @ConfigurationProperties 
    必须配合 @Validated
  • 嵌套对象字段要加 @Valid
  • 集合元素校验,需要在泛型上加注解
  • 使用 Jakarta Validation 标准注解(Spring Boot 3.x 默认使用 Jakarta)

扩展:错误处理更友好(自定义异常消息格式)

默认启动校验失败时,Spring Boot 抛出 BindValidationException,信息虽然完整但略显杂乱。为了让错误提示更专业友好,我们可以自定义异常处理。

定义友好的异常类

package com.icoderoad.demo.exception;


/**
 * 自定义配置校验异常
 */
public class ConfigValidationException extends RuntimeException {


    public ConfigValidationException(String message) {
   python     super(message);
    }
}

编写异常处理器

通过 BeanFactoryPostProcessor 统一拦截配置阶段的校验错误:

package com.icoderoad.demo.exception;


import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.boot.context.properties.bind.BindValidationException;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.ObjectError;


import java.util.stream.Collectors;


@Configuration
public class ConfigValidationExceptionHandler {


    @Bean
    public static BeanFactoryPostProcessor configurationPropertiesValidator() {
        return beanFactory -> {
            try {
                // 手动触发bean初始化
            } catch (BeansExcepti编程on ex) {
                Throwable cause = ex.getCause();
                if (cause instanceof BindValidationException bindValidationException) {
                    String errorMessages = bindValidationException.getValidationErrors()
                            .getAllErrors()
                            .stream()
                            .map(ObjectError::getDefaultMessage)
                            .collect(Collectors.joining("; "));
                    throw new ConfigValidationException("配置属性校验失败:" + errorMessages);
                }
                throw ex;
            }
        };
    }
}

逻辑解释:

  • 捕获 BindValidationException
  • 提取所有校验失败信息
  • 使用 拼接成简洁可读的文本
  • 抛出我们的 ConfigValidationException

示例效果

比如你的配置错误如下:

app:
  user:
    username: ""
    email: "wrong"
    age: 15
    address:
      city: ""
      zipCode: "12abc"
    roles:
      - ""

启动时抛出的错误变成:

配置属性校验失败:用户名不能为空; 邮箱格式不正确; 年龄不能小于18岁; 城市不能为空; 邮编必须是6位数字; 角色名称不能为空

  • 信息集中、简洁直观
  • 一次性列出所有问题,快速修复
  • 适合前后端、测试同事快速理解

总结

Spring Boot 3.4 配置属性验证:

  • 验证能力更强大覆盖深度校验、集合元素校验
  • 开发体验更极致启动即校验,IDE智能提示
  • 错误处理更优雅可自定义异常格式
  • 提升整体代码质量避免配置隐患上线

在实际项目中,推荐配合自定义异常机制,打造更加专业可靠的配置校验体系!

到此这篇关于SpringBoot3.4配置校验新特性的用法详解的文章就介绍到这了,更多相关SpringBoot配置校验内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于SpringBoot3.4配置校验新特性的用法详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154424

相关文章

HTML5 搜索框Search Box详解

《HTML5搜索框SearchBox详解》HTML5的搜索框是一个强大的工具,能够有效提升用户体验,通过结合自动补全功能和适当的样式,可以创建出既美观又实用的搜索界面,这篇文章给大家介绍HTML5... html5 搜索框(Search Box)详解搜索框是一个用于输入查询内容的控件,通常用于网站或应用程

Redis Cluster模式配置

《RedisCluster模式配置》:本文主要介绍RedisCluster模式配置,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录分片 一、分片的本质与核心价值二、分片实现方案对比 ‌三、分片算法详解1. ‌范围分片(顺序分片)‌2. ‌哈希分片3. ‌虚

mapstruct中的@Mapper注解的基本用法

《mapstruct中的@Mapper注解的基本用法》在MapStruct中,@Mapper注解是核心注解之一,用于标记一个接口或抽象类为MapStruct的映射器(Mapper),本文给大家介绍ma... 目录1. 基本用法2. 常用属性3. 高级用法4. 注意事项5. 总结6. 编译异常处理在MapSt

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

Python中使用uv创建环境及原理举例详解

《Python中使用uv创建环境及原理举例详解》uv是Astral团队开发的高性能Python工具,整合包管理、虚拟环境、Python版本控制等功能,:本文主要介绍Python中使用uv创建环境及... 目录一、uv工具简介核心特点:二、安装uv1. 通过pip安装2. 通过脚本安装验证安装:配置镜像源(可

C++ 函数 strftime 和时间格式示例详解

《C++函数strftime和时间格式示例详解》strftime是C/C++标准库中用于格式化日期和时间的函数,定义在ctime头文件中,它将tm结构体中的时间信息转换为指定格式的字符串,是处理... 目录C++ 函数 strftipythonme 详解一、函数原型二、功能描述三、格式字符串说明四、返回值五

LiteFlow轻量级工作流引擎使用示例详解

《LiteFlow轻量级工作流引擎使用示例详解》:本文主要介绍LiteFlow是一个灵活、简洁且轻量的工作流引擎,适合用于中小型项目和微服务架构中的流程编排,本文给大家介绍LiteFlow轻量级工... 目录1. LiteFlow 主要特点2. 工作流定义方式3. LiteFlow 流程示例4. LiteF

Maven 配置中的 <mirror>绕过 HTTP 阻断机制的方法

《Maven配置中的<mirror>绕过HTTP阻断机制的方法》:本文主要介绍Maven配置中的<mirror>绕过HTTP阻断机制的方法,本文给大家分享问题原因及解决方案,感兴趣的朋友一... 目录一、问题场景:升级 Maven 后构建失败二、解决方案:通过 <mirror> 配置覆盖默认行为1. 配置示

CSS3中的字体及相关属性详解

《CSS3中的字体及相关属性详解》:本文主要介绍了CSS3中的字体及相关属性,详细内容请阅读本文,希望能对你有所帮助... 字体网页字体的三个来源:用户机器上安装的字体,放心使用。保存在第三方网站上的字体,例如Typekit和Google,可以link标签链接到你的页面上。保存在你自己Web服务器上的字

java中long的一些常见用法

《java中long的一些常见用法》在Java中,long是一种基本数据类型,用于表示长整型数值,接下来通过本文给大家介绍java中long的一些常见用法,感兴趣的朋友一起看看吧... 在Java中,long是一种基本数据类型,用于表示长整型数值。它的取值范围比int更大,从-922337203685477