如何使用子模块中的application.yml文件？

在多模块的Spring Boot项目中，application.yml 文件通常用于配置应用程序的各种属性。子模块中的 application.yml 文件可以帮助你为特定的模块定制配置，而不影响其他模块或整个应用程序的配置。以下是如何使用子模块中的 application.yml 文件的基本步骤和相关概念：

基础概念

1. Spring Boot配置文件：Spring Boot支持多种格式的配置文件，如 application.properties 和 application.yml。application.yml 使用YAML格式，它更加易于人类阅读和编写。
2. 多模块项目：在多模块项目中，每个模块都有自己的目录结构和资源文件。子模块可以有自己的 application.yml 文件来定义特定于该模块的配置。
3. 配置加载顺序：Spring Boot会按照一定的顺序加载配置文件，后面的配置会覆盖前面的配置。这意味着子模块中的配置可以覆盖父模块或根目录下的配置。

相关优势

• 模块化配置：允许每个模块有自己的配置，便于管理和维护。
• 避免冲突：不同模块可以使用相同的配置键，但值可以不同，减少了配置冲突的可能性。
• 灵活性：可以根据需要激活或禁用某些模块的配置。

类型

• 默认配置：子模块中的 application.yml 文件通常包含该模块的默认配置。
• 特定环境配置：可以为不同的运行环境（如开发、测试、生产）提供特定的配置文件，如 application-dev.yml。

应用场景

• 微服务架构：在微服务架构中，每个服务通常是一个独立的模块，有自己的配置文件。
• 插件系统：插件化的应用程序中，每个插件可以作为子模块，拥有自己的配置。

如何使用

1. 创建配置文件：在子模块的 src/main/resources 目录下创建 application.yml 文件。
2. 编写配置：在 application.yml 文件中编写所需的配置项。例如：

server:
  port: 8081

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/module_db
    username: user
    password: pass

1. 激活配置：如果有多个环境的配置文件，可以使用 spring.profiles.active 属性来激活特定的配置文件。例如，在父模块的 application.yml 中设置：

spring:
  profiles:
    active: dev

这将激活所有模块中的 application-dev.yml 文件。

1. 加载顺序：Spring Boot会按照以下顺序加载配置文件（后面的会覆盖前面的）：
   • 命令行参数
   • SPRING_APPLICATION_JSON 中的属性
   • ServletConfig 初始化参数
   • ServletContext 初始化参数
   • Java 系统属性 (System.getProperties())
   • 操作系统环境变量
   • application-{profile}.yml 外部配置文件
   • application-{profile}.yml 内部配置文件
   • application.yml 外部配置文件
   • application.yml 内部配置文件
   • @PropertySource 注解
   • 默认属性

遇到的问题及解决方法

问题：子模块的配置没有生效。

原因：

• 配置文件位置不正确。
• 配置文件命名错误。
• 配置文件中的语法错误。
• 父模块的配置覆盖了子模块的配置。

解决方法：

• 确保 application.yml 文件位于子模块的 src/main/resources 目录下。
• 检查配置文件名是否正确，应为 application.yml 或 application-{profile}.yml。
• 使用YAML验证工具检查配置文件是否有语法错误。
• 在父模块的 application.yml 中使用 spring.profiles.active 来激活子模块的特定配置文件。

示例代码

假设我们有一个名为 user-service 的子模块，它的 application.yml 文件内容如下：

server:
  port: 8082

user:
  service:
    enabled: true

在父模块的 application.yml 中，我们可以这样激活 user-service 的配置：

spring:
  profiles:
    active: user-service

这样，当启动应用程序时，Spring Boot会加载并应用 user-service 模块的配置。

通过这种方式，你可以有效地管理和使用多模块项目中的配置文件。