0

0

Spring Boot 配置类通用化重构:基于模板方法模式消除重复代码

霞舞

霞舞

发布时间:2026-01-21 09:35:28

|

683人浏览过

|

来源于php中文网

原创

Spring Boot 配置类通用化重构:基于模板方法模式消除重复代码

本文介绍如何通过模板方法模式对多个仅配置标识符不同的 spring boot `@configuration` 类进行统一抽象,减少代码重复,提升可维护性。

在 Spring Boot 项目中,当存在多个功能结构一致、仅依赖不同命名前缀(如 "configA" / "configB")的配置类时,直接复制粘贴会导致显著的代码冗余和维护风险。理想的重构方式是提取共性逻辑,将差异点参数化——模板方法模式(Template Method Pattern) 正是解决此类问题的经典设计模式。

该模式将算法骨架定义在抽象父类中,而将可变步骤延迟到子类实现。在 Spring 配置场景下,我们可定义一个抽象基类(不加 @Configuration),由具体子类继承并注入差异化 Bean,同时保留 @Bean 的声明能力与 Spring 容器集成。

以下是推荐的重构实践:

AiBiao.cn
AiBiao.cn

一句话自动生成图表

下载

✅ 正确实现方式(推荐)

// 抽象基类:定义配置骨架,不标注 @Configuration
public abstract class BaseConfig {

    // 模板方法:可在此封装通用初始化逻辑(非必须)
    protected void onConfigInitialized() {
        // 例如:日志记录、健康检查注册等
    }

    // 声明抽象钩子方法,由子类提供具体 Bean 实例及名称
    protected abstract First firstBean();

    protected abstract Second secondBean();
}
// 具体子类:标注 @Configuration,复用模板逻辑
@Configuration
public class ConfigA extends BaseConfig {

    private static final String PREFIX = "configA";

    @Override
    @Bean(name = "first" + PREFIX)
    public First firstBean() {
        return new First("instance-for-" + PREFIX); // 示例构造逻辑
    }

    @Override
    @Bean(name = "second" + PREFIX)
    public Second secondBean() {
        return new Second("instance-for-" + PREFIX);
    }
}
@Configuration
public class ConfigB extends BaseConfig {

    private static final String PREFIX = "configB";

    @Override
    @Bean(name = "first" + PREFIX)
    public First firstBean() {
        return new First("instance-for-" + PREFIX);
    }

    @Override
    @Bean(name = "second" + PREFIX)
    public Second secondBean() {
        return new Second("instance-for-" + PREFIX);
    }
}
⚠️ 关键注意事项:抽象基类 BaseConfig 不可加 @Configuration,否则 Spring 会尝试实例化它(失败),且导致 Bean 名称冲突或重复注册;@Bean 注解必须保留在子类的具体方法上,Spring 仅扫描 @Configuration 类中的 @Bean 方法;若需共享初始化逻辑(如条件校验、资源预加载),可在基类中定义 protected 模板方法,并在子类 @Bean 方法中显式调用(如 onConfigInitialized());Bean 类型应保持一致(如 First/Second),确保 DI 语义清晰;若需差异化类型,可结合泛型进一步增强扩展性。

✅ 替代方案(适用于更复杂场景)

  • @ConfigurationProperties + @ConditionalOnProperty:若配置差异本质是外部属性驱动,可统一用配置类绑定 + 条件化加载;
  • @Import 动态导入:通过工厂类根据环境/参数返回不同 @Configuration 类,适合运行时动态决策;
  • Java Config + @Bean 工厂方法:将 CONFIG_STRING 作为方法参数传入,配合 @Bean 的 name SpEL 表达式(如 name = "first#{systemProperties['config.id']}"),但需确保属性可用且命名可控。

综上,模板方法模式在保持 Spring 原生配置语义的同时,以最小侵入性实现配置类的结构复用,是应对“多配置类仅命名不同”问题的简洁、稳健且符合 Spring 最佳实践的重构路径。

相关专题

更多
java
java

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

841

2023.06.15

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

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

742

2023.07.05

java自学难吗
java自学难吗

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

738

2023.07.31

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

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

397

2023.08.01

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

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

399

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

1

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.1万人学习

Java 教程
Java 教程

共578课时 | 48.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号