0

0

Spring Boot 配置类重构指南:使用模板方法消除重复代码

花韻仙語

花韻仙語

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

|

931人浏览过

|

来源于php中文网

原创

Spring Boot 配置类重构指南:使用模板方法消除重复代码

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

在 Spring Boot 项目中,当存在多个功能逻辑一致、仅因环境或模块前缀(如 "configA"、"configB")而需独立注册 Bean 的配置类时,直接复制粘贴会导致严重的代码冗余和维护困难。此时,模板方法模式(Template Method Pattern) 是一种简洁、符合 Spring 编程模型的重构方案——它将共性逻辑提取到抽象基类中,由子类负责提供差异化参数(如配置标识符),同时保持 @Bean 注解与 Spring 容器注册机制的完全兼容。

✅ 正确实现方式:抽象配置基类 + 具体子类

首先定义一个非 @Configuration 的抽象基类(注意:不能加 @Configuration,否则 Spring 会尝试实例化抽象类并报错):

public abstract class BaseConfig {

    // 声明抽象钩子方法,由子类实现具体返回值与 Bean 名称
    protected abstract String first();

    protected abstract String second();
}

然后为每个配置变体创建具体子类,并在其中使用 @Configuration 和 @Bean 注解:

AiBiao.cn
AiBiao.cn

一句话自动生成图表

下载
@Configuration
public class ConfigA extends BaseConfig {

    private static final String CONFIG_STRING = "configA";

    @Override
    @Bean(name = "first" + CONFIG_STRING)
    public First first() {
        return new First(/* 初始化逻辑 */);
    }

    @Override
    @Bean(name = "second" + CONFIG_STRING)
    public Second second() {
        return new Second(/* 初始化逻辑 */);
    }
}
@Configuration
public class ConfigB extends BaseConfig {

    private static final String CONFIG_STRING = "configB";

    @Override
    @Bean(name = "first" + CONFIG_STRING)
    public First first() {
        return new First(/* 不同初始化逻辑,如不同参数 */);
    }

    @Override
    @Bean(name = "second" + CONFIG_STRING)
    public Second second() {
        return new Second(/* 对应差异逻辑 */);
    }
}
⚠️ 注意事项:抽象基类不可加 @Configuration:Spring 不支持对抽象类应用该注解,否则启动时抛出 BeanInstantiationException。@Bean 方法必须在具体子类中定义:只有被 @Configuration 标记的类中声明的 @Bean 方法才会被 Spring 容器识别并注册。若 Bean 构建逻辑复杂,建议将初始化细节封装为私有工具方法,保持 @Bean 方法简洁清晰。Bean 名称拼接(如 "first" + CONFIG_STRING)在编译期确定,完全安全;若需运行时动态命名,可考虑 @Bean 的 name 属性结合 @Value 或 Environment,但本场景静态拼接更高效可靠。

✅ 进阶优化(可选)

  • 若多个配置类还需共享通用依赖(如 ObjectMapper、RestTemplate),可在 BaseConfig 中添加 protected 成员字段,并通过构造器注入或 @Autowired(需确保子类是 Spring 管理的 Bean);
  • 结合 @Profile 或 @ConditionalOnProperty 实现条件化加载配置类,进一步解耦环境差异。

通过该重构,您不仅消除了 90% 的样板代码,还建立了清晰的“协议式”扩展点——新增 ConfigC 仅需继承 BaseConfig 并覆盖两个方法,开发效率与代码健壮性同步提升。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

104

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

389

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

68

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

34

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

114

2025.12.24

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

182

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

280

2024.02.23

excel表格操作技巧大全 表格制作excel教程
excel表格操作技巧大全 表格制作excel教程

Excel表格操作的核心技巧在于 熟练使用快捷键、数据处理函数及视图工具,如Ctrl+C/V(复制粘贴)、Alt+=(自动求和)、条件格式、数据验证及数据透视表。掌握这些可大幅提升数据分析与办公效率,实现快速录入、查找、筛选和汇总。

0

2026.01.21

热门下载

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

精品课程

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

共578课时 | 48.6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

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

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