
本文介绍如何通过模板方法模式重构多个结构相同、仅配置标识符不同的 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 注解:
@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 并覆盖两个方法,开发效率与代码健壮性同步提升。










