
当多个 spring boot `@configuration` 类仅在 bean 名称前缀或少量参数上存在差异时,可通过抽象基类 + 模板方法模式统一结构,消除重复代码,提升可维护性与扩展性。
在 Spring Boot 项目中,随着模块化程度提高,常出现多组功能高度相似、仅通过标识符(如 "configA"/"configB")区分的配置类。直接复制粘贴不仅违反 DRY 原则,还导致后续修改需同步多处,极易引入不一致风险。此时,模板方法模式(Template Method Pattern) 是一种简洁、符合 Spring 编程模型的重构方案。
核心思路是:将共性逻辑(如 Bean 注册结构、生命周期管理)提取至抽象配置基类,将差异化部分(如 Bean 名称后缀、实例化参数)声明为抽象方法,由具体子类实现。注意:Spring 要求 @Bean 方法必须在 @Configuration 类中定义,因此抽象基类本身不能加 @Configuration,而具体子类需显式标注并继承基类。
以下为推荐实现方式:
// 抽象基类:不加 @Configuration,仅定义骨架和抽象钩子
public abstract class BaseConfig {
// 可选:提供默认实现或空实现,增强子类灵活性
protected String configPrefix() {
return "";
}
// 子类必须实现,用于生成带前缀的 Bean 名称
protected abstract String getPrefix();
// 共享逻辑可在此封装(如日志、校验等)
protected void onBeanCreated(String beanName) {
System.out.println("Bean registered: " + beanName);
}
}// 具体配置类 A —— 继承基类并标注 @Configuration
@Configuration
public class ConfigA extends BaseConfig {
private static final String PREFIX = "configA";
@Override
protected String getPrefix() {
return PREFIX;
}
@Bean(name = "first" + PREFIX)
public First first() {
onBeanCreated("first" + PREFIX);
return new First(/* 初始化逻辑 */);
}
@Bean(name = "second" + PREFIX)
public Second second() {
onBeanCreated("second" + PREFIX);
return new Second(/* 初始化逻辑 */);
}
}// 具体配置类 B
@Configuration
public class ConfigB extends BaseConfig {
private static final String PREFIX = "configB";
@Override
protected String getPrefix() {
return PREFIX;
}
@Bean(name = "first" + PREFIX)
public First first() {
onBeanCreated("first" + PREFIX);
return new First(/* 不同初始化逻辑 */);
}
@Bean(name = "second" + PREFIX)
public Second second() {
onBeanCreated("second" + PREFIX);
return new Second(/* 不同初始化逻辑 */);
}
}✅ 关键注意事项:
- 抽象父类 BaseConfig 不可添加 @Configuration,否则 Spring 会尝试实例化它(失败),且其抽象方法无法被容器识别为 Bean;
- @Bean 方法必须定义在具体子类中,确保 Spring 上下文能正确扫描并注册;
- 若需进一步解耦(如动态加载配置),可结合 @ConditionalOnProperty 或 @Profile 控制子类生效条件;
- 对于更复杂的场景(如 Bean 类型、依赖注入参数也不同),可将工厂方法升级为泛型抽象方法,或配合 ObjectProvider 提升灵活性。
该重构方式在保持 Spring 容器语义清晰的前提下,显著降低配置类的维护成本,是面向切面配置(Aspect-Oriented Configuration)的一种轻量级实践。








