Spring Boot如何覆盖@Bean按需从配置文件读取多环境AWS凭证

步骤1：新增运行时环境标识参数 #

启动应用时传入自定义参数env.index指定要使用的环境，0对应DEV，1对应TEST，示例启动命令：

java -jar your-application.jar --env.index=0

如果是IDEA本地启动，在「Run/Debug Configurations」的「Program arguments」中添加--env.index=1即可切换到TEST环境。

步骤2：修改CloudConfig配置类 #

提供两种实现方式，按需选择即可：

方式1：使用Environment动态读取配置（简单快捷） #

直接通过Spring的Environment对象动态拼接配置Key读取对应环境的凭证：

import org.springframework.core.env.Environment;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.amazonaws.auth.AWSStaticCredentialsProvider;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.services.sns.AmazonSNS;
import com.amazonaws.services.sns.AmazonSNSClientBuilder;

@Configuration
public class CloudConfig {

    @Autowired
    private Environment env;

    @Value("${aws.region}")
    private String awsRegion;
    
    // 读取启动时传入的环境索引
    @Value("${env.index}")
    private Integer envIndex;

    @Bean
    public AmazonSNS amazonSnsClient() {
        return AmazonSNSClientBuilder.standard()
                .withRegion(awsRegion)
                .withCredentials(awsCredentialsProvider())
                .build();
    }
    
    @Bean
    public AWSStaticCredentialsProvider awsCredentialsProvider() {
        // 动态拼接配置Key
        String accessKey = env.getProperty(String.format("abc.env[%d].aws.accessKeyId", envIndex));
        String secretKey = env.getProperty(String.format("abc.env[%d].aws.awsSecretKeyId", envIndex));
        // 可选：加非空校验避免配置错误
        if (accessKey == null || secretKey == null) {
            throw new IllegalArgumentException("对应索引的AWS凭证配置不存在，请检查env.index参数");
        }
        return new AWSStaticCredentialsProvider(new BasicAWSCredentials(accessKey, secretKey));
    }
}

方式2：使用@ConfigurationProperties绑定配置（类型安全更规范） #

先定义配置属性类绑定所有环境的凭证，再根据索引取值：

1. 新增配置属性类：

import org.springframework.boot.context.properties.ConfigurationProperties;
import java.util.List;

@ConfigurationProperties(prefix = "abc")
public class AwsEnvProperties {
    private List<AwsEnvItem> env;

    // Getter Setter
    public List<AwsEnvItem> getEnv() {
        return env;
    }

    public void setEnv(List<AwsEnvItem> env) {
        this.env = env;
    }

    public static class AwsEnvItem {
        private AwsConfig aws;

        // Getter Setter
        public AwsConfig getAws() {
            return aws;
        }

        public void setAws(AwsConfig aws) {
            this.aws = aws;
        }
    }

    public static class AwsConfig {
        private String accessKeyId;
        private String awsSecretKeyId;

        // Getter Setter
        public String getAccessKeyId() {
            return accessKeyId;
        }

        public void setAccessKeyId(String accessKeyId) {
            this.accessKeyId = accessKeyId;
        }

        public String getAwsSecretKeyId() {
            return awsSecretKeyId;
        }

        public void setAwsSecretKeyId(String awsSecretKeyId) {
            this.awsSecretKeyId = awsSecretKeyId;
        }
    }
}

2. 修改CloudConfig类，启用配置绑定并注入属性类：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.amazonaws.auth.AWSStaticCredentialsProvider;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.services.sns.AmazonSNS;
import com.amazonaws.services.sns.AmazonSNSClientBuilder;

@Configuration
@EnableConfigurationProperties(AwsEnvProperties.class)
public class CloudConfig {

    @Value("${aws.region}")
    private String awsRegion;
    
    @Value("${env.index}")
    private Integer envIndex;

    private final AwsEnvProperties awsEnvProperties;

    // 构造注入配置属性类
    public CloudConfig(AwsEnvProperties awsEnvProperties) {
        this.awsEnvProperties = awsEnvProperties;
    }

    @Bean
    public AmazonSNS amazonSnsClient() {
        return AmazonSNSClientBuilder.standard()
                .withRegion(awsRegion)
                .withCredentials(awsCredentialsProvider())
                .build();
    }
    
    @Bean
    public AWSStaticCredentialsProvider awsCredentialsProvider() {
        AwsEnvProperties.AwsConfig awsConfig = awsEnvProperties.getEnv().get(envIndex).getAws();
        return new AWSStaticCredentialsProvider(new BasicAWSCredentials(awsConfig.getAccessKeyId(), awsConfig.getAwsSecretKeyId()));
    }
}

可选扩展 #

如果需要在应用运行过程中不重启切换凭证，可以给amazonSnsClient和awsCredentialsProvider两个Bean添加@RefreshScope注解，修改env.index后调用Spring Boot的刷新端点即可动态替换AWS客户端实例。

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