如何在外部库定义Spring Boot应用配置默认值以复用公共配置？

这绝对是Spring Boot多服务架构里的典型痛点——100+服务重复写相同的Eureka、Kafka配置，不仅维护麻烦，还容易出现配置不一致的问题。用自定义Spring Boot Starter就能完美解决，让所有服务依赖这个库后自动继承公共配置，不用再重复编写，具体步骤如下：

1. 创建自定义Spring Boot Starter项目 #

先搭建一个专门的starter项目，这是Spring Boot用来封装公共配置、依赖和逻辑的标准方式：

• 建议命名为 xxx-spring-boot-starter（比如company-common-spring-boot-starter），和官方starter区分开
• 核心依赖只需要引入spring-boot-starter即可，其他公共依赖（比如spring-cloud-starter-netflix-eureka-client、spring-kafka）可以按需加到starter的pom里，避免业务服务重复引入

2. 编写公共配置文件 #

在starter的src/main/resources目录下创建application.yml，把所有共享的配置项放进去，比如：

# 公共Eureka注册配置
eureka:
  client:
    service-url:
      defaultZone: http://your-eureka-server:8761/eureka/
    fetch-registry: true
    register-with-eureka: true

# 公共Kafka消费者配置
spring:
  kafka:
    consumer:
      bootstrap-servers: your-kafka-broker:9092
      group-id: default-service-group
      auto-offset-reset: earliest
      key-deserializer: org.apache.kafka.common.serialization.StringDeserializer
      value-deserializer: org.springframework.kafka.support.serializer.JsonDeserializer

Spring Boot会自动识别starter里的配置文件，并将其加载到依赖该starter的服务中。

3. （可选）添加自定义自动配置逻辑 #

如果你的公共配置需要一些动态逻辑（比如根据环境切换配置、自定义Bean初始化），可以创建自动配置类：

@Configuration
@EnableConfigurationProperties(CommonConfigProperties.class)
public class CommonAutoConfiguration {

    // 自定义Kafka消费者工厂Bean示例
    @Bean
    public ConsumerFactory<String, Object> kafkaConsumerFactory(CommonConfigProperties properties) {
        Map<String, Object> configProps = new HashMap<>();
        configProps.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, properties.getKafkaBootstrapServers());
        // 其他公共配置逻辑...
        return new DefaultKafkaConsumerFactory<>(configProps);
    }
}

然后在src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中添加这个配置类的全路径，让Spring Boot自动扫描加载：

com.yourcompany.common.autoconfigure.CommonAutoConfiguration

4. 发布starter到私有仓库 #

把这个starter打包发布到你们公司的私有Maven仓库（比如Nexus、Artifactory），这样所有业务服务都能引用到。

5. 业务服务接入 #

在各个业务服务的pom.xml（或build.gradle）中添加starter依赖：

<dependency>
    <groupId>com.yourcompany</groupId>
    <artifactId>company-common-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

之后，业务服务里的application.yml就可以删掉那些重复的公共配置了！

额外技巧：配置覆盖 #

如果某个服务需要修改部分公共配置（比如特定服务的Kafka group-id不同），直接在自己的application.yml中重新定义该配置项即可——Spring Boot会优先使用业务服务本地的配置，自动覆盖starter里的默认值。

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