如何通过自定义实现重写Spring Bean？以CompositeEnvironmentRepository为例

完全没必要去修改Spring的Jar包，这种方式不仅维护成本极高，还容易引发依赖冲突和版本兼容问题。Spring本身提供了多种原生、优雅的方式来替换默认Bean，以下是最优方案：

方案一：使用@Primary注解优先加载自定义Bean #

这是最直接的方式，通过@Primary标记你的自定义Bean，让Spring在多个同类型Bean中优先选择你的实现。

步骤： #

1. 实现EnvironmentRepository接口（或直接继承CompositeEnvironmentRepository重写特定方法），并添加@Component和@Primary注解：

import org.springframework.cloud.config.server.environment.CompositeEnvironmentRepository;
import org.springframework.cloud.config.server.environment.EnvironmentRepository;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import org.springframework.beans.factory.annotation.Value;
import java.util.List;

@Component
@Primary
public class CustomCompositeEnvironmentRepository implements EnvironmentRepository {

    private final List<EnvironmentRepository> delegates;
    private final boolean failOnCompositeError;

    // 注入默认环境仓库列表和配置参数，和原实现保持一致的依赖
    public CustomCompositeEnvironmentRepository(List<EnvironmentRepository> delegates,
                                               @Value("${spring.cloud.config.server.failOnCompositeError:true}") boolean failOnCompositeError) {
        this.delegates = delegates;
        this.failOnCompositeError = failOnCompositeError;
    }

    @Override
    public Environment findOne(String application, String profile, String label) {
        // 这里编写你的自定义逻辑，可参考原CompositeEnvironmentRepository的实现进行修改
        Environment result = new Environment(application, profile, label, null, null);
        for (EnvironmentRepository delegate : delegates) {
            try {
                Environment env = delegate.findOne(application, profile, label);
                // 自定义配置合并规则、优先级调整或异常处理
                result.merge(env);
            } catch (Exception e) {
                if (failOnCompositeError) {
                    throw e;
                }
                // 这里可以添加自定义的异常日志或降级逻辑
            }
        }
        return result;
    }
}

2. 启动应用后，Spring会自动优先使用这个标记了@Primary的Bean，替换默认的CompositeEnvironmentRepository。

方案二：利用@ConditionalOnMissingBean替换默认Bean #

查看Spring Cloud Config的源码，默认的CompositeEnvironmentRepository通常是在配置类中通过@ConditionalOnMissingBean注解注册的。如果是这种情况，你只需要在自己的配置类中注册自定义Bean即可，无需额外标记@Primary：

import org.springframework.cloud.config.server.environment.EnvironmentRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.List;

@Configuration
public class CustomConfigServerConfiguration {

    @Bean
    public EnvironmentRepository compositeEnvironmentRepository(List<EnvironmentRepository> delegates,
                                                               @Value("${spring.cloud.config.server.failOnCompositeError:true}") boolean failOnCompositeError) {
        return new CustomCompositeEnvironmentRepository(delegates, failOnCompositeError);
    }
}

Spring会检测到已经存在同类型的Bean，因此不会创建默认的CompositeEnvironmentRepository。

方案三：使用BeanDefinitionRegistryPostProcessor手动替换Bean定义 #

如果上述两种方式不适用（比如默认Bean没有使用@ConditionalOnMissingBean，且你不想用@Primary），可以通过底层的Bean定义注册器来替换默认Bean：

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.stereotype.Component;

@Component
public class CustomBeanReplacer implements BeanDefinitionRegistryPostProcessor {

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // 替换默认的CompositeEnvironmentRepository Bean定义
        if (registry.containsBeanDefinition("compositeEnvironmentRepository")) {
            BeanDefinition beanDefinition = new GenericBeanDefinition();
            beanDefinition.setBeanClass(CustomCompositeEnvironmentRepository.class);
            // 设置构造参数依赖，和原Bean保持一致
            beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, registry.getBeanDefinition("environmentRepositories"));
            beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(1, "${spring.cloud.config.server.failOnCompositeError:true}");
            registry.registerBeanDefinition("compositeEnvironmentRepository", beanDefinition);
        }
    }

    @Override
    public void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 无需额外处理
    }
}

这种方式适合复杂场景，但需要对Spring的Bean生命周期有一定了解。

翻译后的配置文件（含中文注释） #

spring:
  application:
    name: spring-cloud-server  # 应用名称：Spring Cloud配置服务器
  profiles:
    active: vault,git  # 激活的配置文件：同时启用vault和git配置源
  cloud:
    vault:
      authentication: CERT  # Vault认证方式：证书认证
    config:
      server:
        failOnCompositeError: false  # 多配置源组合出错时是否终止服务：否
        vault:
          host: hostname  # Vault服务器地址
          port: 490  # Vault服务端口
          scheme: https  # 通信协议：HTTPS
          backend: secret  # Vault存储后端的根路径
          defaultKey:  # 默认配置键（留空表示使用应用名称作为键）
          kvVersion: 2  # Vault KV存储引擎版本：v2
          order: 2  # 配置源优先级：数字越小优先级越高（此处低于git）
          skipSslValidation: false  # 是否跳过SSL证书验证：否
          authentication: CERT  # Vault认证方式：证书认证
        git:
          uri: repo-url  # 主Git仓库地址
          order: 1  # 配置源优先级：1（最高）
          skip-ssl-validation: false  # 是否跳过Git仓库的SSL验证：否
          force-pull: true  # 是否强制拉取Git仓库的最新代码：是
          repos:
              dev:  # 针对dev环境的专属Git仓库配置
                pattern:
                - '*/dev'  # 匹配模式：所有应用的dev环境配置
                uri: url  # Dev环境对应的Git仓库地址
                searchPaths: '${somepath}'  # 配置文件搜索路径（使用变量somepath指定）

内容的提问来源于stack exchange，提问作者Sanjay