Spring Boot 怎么自定义属性转换器

轻墨酱_7804

轻墨酱_7804

2026-10-31

706人浏览

原创

Spring Boot 自定义属性转换器的核心是通过@ConfigurationPropertiesBinding注解让Spring自动发现并使用Converter,实现YAML/Properties字符串到Java类型的转换;例如将"com.example.ServiceA"转为Class类型,并在@ConfigurationProperties配置类中自动生效。

spring boot 怎么自定义属性转换器

Spring Boot 自定义属性转换器,核心是让 @ConfigurationProperties 能正确把 YAML 或 Properties 中的字符串(比如类名、JSON 片段、自定义格式)转成你想要的 Java 类型(如 Class>、Map、业务对象等)。关键不在于“写个转换逻辑”,而在于让 Spring 在配置绑定阶段**自动发现并使用它**。

用 @ConfigurationPropertiesBinding 注册全局转换器

这是最常用、也最推荐的方式,专为 @ConfigurationProperties 设计:

  • 实现 Converter 接口,比如把字符串转成 Class> 或自定义的 Rule 对象
  • 加上 @Component 和 @ConfigurationPropertiesBinding 两个注解
  • Spring Boot 启动时会自动将它注册进配置绑定的转换服务,无需手动注入或配置

示例:将 com.example.ServiceA 这样的字符串转成 Class>

@Component
@ConfigurationPropertiesBinding
public class ClassConverter implements Converter<string class>> {
    @Override
    public Class> convert(String source) {
        if (source == null || source.trim().isEmpty()) return null;
        String className = source.trim().replaceFirst("\.class$", "");
        try {
            return Class.forName(className);
        } catch (ClassNotFoundException e) {
            throw new IllegalArgumentException("无法加载类: " + className, e);
        }
    }
}</string>

⚠️ 注意:Class.forName() 必须传全限定名;如果 YAML 写的是 a.class,转换器里要先去掉 .class 后缀。

配合 @ConfigurationProperties 使用

转换器生效的前提,是你在配置类上用了 @ConfigurationProperties,且字段类型正好匹配转换目标:

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载
  • YAML 示例:
app:
  handlers:
    email: com.example.EmailHandler
    sms: com.example.SmsHandler.class
  • Java 配置类:
@ConfigurationProperties("app")
@Data
public class AppProperties {
    private Map<string class>> handlers;
}</string>

只要 ClassConverter 存在且带正确注解,Spring 就会在绑定 handlers 字段时自动调用它。

其他方式(按需选用)

不是所有场景都适合用 @ConfigurationPropertiesBinding:

  • Web 层参数转换(比如 Controller 方法入参):用 WebMvcConfigurer.addFormatters() 注册 Converter,作用于 HTTP 请求数据绑定
  • 通用类型转换服务(跨多个模块复用):定义一个名为 conversionService 的 ConversionService Bean,但要注意它启动早、依赖受限
  • 老式 PropertyEditor:已不推荐,仅兼容遗留代码;需实现 PropertyEditorSupport 并通过 CustomEditorConfigurer 注册

多数配置类场景,坚持用 @ConfigurationPropertiesBinding 最简洁、最安全。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11577

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8702

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7472

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1224

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

988

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1476

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3049

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20291

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1335

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习