springboot maven项目存在项目依赖场景下的配置优先级剖析

在 Spring Boot 中，B项目依赖于A项目，它们配置文件的优先级规则决定了不同位置的配置如何合并或覆盖。以下是具体分析和配置优先级总结：

---

1. 默认配置加载顺序

Spring Boot 按以下优先级从高到低加载配置（高优先级覆盖低优先级）：

1. 项目根目录的 /config 子目录
   （如 ./config/application.yml）
2. 项目根目录
   （如 ./application.yml）
3. classpath 中的 /config 包
   （如 classpath:/config/application.yml）
4. classpath 根目录
   （如 classpath:/application.yml）

同一位置下，application.yml 低于 application.properties 的优先级。

---

2. 项目 B 和依赖项目 A 的场景

• 项目 B：自身的 application.yml 默认位于 classpath:/application.yml（即 src/main/resources/application.yml）。
• 项目 A：作为依赖引入，其 application.yml 也位于 classpath:/application.yml（即项目 A 的 src/main/resources/application.yml）。
• 项目 A 的配置会覆盖项目 B 的同名配置。

---

3. 默认行为验证

• Maven 项目：依赖的 classpath 顺序通常为：

  项目 B 的 classes 和 resources → 项目 B 的依赖（如项目 A）的 classes 和 resources
  

  此时项目 B 的 application.yml 会先加载，项目 A 的 application.yml 后加载，因此项目 A 的配置会覆盖项目 B 的同名配置。

• Gradle 项目：行为类似，但需注意依赖声明顺序。

---

4. 强制让项目 B 的配置生效

若需确保项目 B 的配置覆盖项目 A 的同名配置，可通过以下方法实现：

方法 1：将项目 B 的配置放在更高优先级位置

例如，将项目 B 的 application.yml 移动到 src/main/resources/config/application.yml（对应 classpath:/config/application.yml）。
此时优先级高于依赖中的 classpath:/application.yml，项目 B 的配置会覆盖项目 A 的配置。

方法 2：排除依赖项目 A 的配置文件

如果项目 A 的 application.yml 是冗余的，可以修改项目 A 的构建配置，不打包 application.yml：

• Maven：在项目 A 的 pom.xml 中配置资源过滤：

  <build>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <excludes>
          <exclude>application.yml</exclude>
        </excludes>
      </resource>
    </resources>
  </build>
  

方法 3：使用 Profile 隔离配置

在项目 A 和项目 B 中分别使用不同的 Profile 名称，避免冲突：

• 项目 A：src/main/resources/application-a.yml
• 项目 B：src/main/resources/application.yml
  启动时通过 spring.profiles.active=a 激活项目 A 的配置（按需使用）。

---

5. 配置优先级总结

从高到低优先级排序：

1. 命令行参数（--key=value）
2. 外部化配置（如文件系统或环境变量）
3. 项目 B 的高优先级位置（如 ./config/application.yml）
4. 项目 B 的 classpath:/application.yml
5. 依赖项目 A 的 classpath:/application.yml

---

6. 最佳实践

1. 避免在依赖库中放置 application.yml：
   依赖库应提供默认配置（如通过 @ConfigurationProperties 或 Java 配置类），而不是直接使用 application.yml。
2. 主项目通过高优先级位置覆盖配置：
   将主项目（项目 B）的配置放在 ./config/application.yml 或 classpath:/config/application.yml。
3. 明确配置来源：
   使用 spring.config.import 显式导入配置（Spring Boot 2.4+ 支持），避免隐式加载。

---

结论

• 默认情况下：项目 A 的 application.yml（作为依赖）可能覆盖项目 B 的同名配置，具体取决于 classpath 加载顺序。
• 推荐做法：将项目 B 的配置放在更高优先级位置（如 classpath:/config/application.yml），以确保覆盖依赖中的配置。