Spring Boot 项目配置与管理：配置文件详解（application.properties / application.yml）

在Spring Boot中，配置文件是应用程序的重要组成部分。它们用于定义应用程序的各种属性和行为。Spring Boot支持两种主要的配置文件格式：application.properties和application.yml。在本节中，我们将深入探讨这两种配置文件的使用，优缺点，以及注意事项。

1. application.properties

1.1 基本语法

application.properties是一个简单的键值对格式的配置文件。每一行代表一个配置项，格式为key=value。例如：

server.port=8080
spring.application.name=MySpringBootApp
logging.level.root=INFO

1.2 优点

简单易读：对于简单的配置，application.properties的格式非常直观，易于理解。
广泛使用：由于历史原因，许多Java开发者对.properties文件格式非常熟悉。

1.3 缺点

层次结构不明显：对于复杂的配置，使用application.properties可能会导致配置项之间的关系不够清晰。
不支持数组和复杂对象：在处理复杂数据结构时，application.properties的表达能力有限。

1.4 示例

以下是一个更复杂的application.properties示例，展示了如何配置数据源和JPA：

# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=secret
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# JPA配置
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

2. application.yml

2.1 基本语法

application.yml使用YAML格式，支持更复杂的层次结构。YAML的基本语法是通过缩进来表示层级关系。例如：

server:
  port: 8080
spring:
  application:
    name: MySpringBootApp
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL5Dialect

2.2 优点

层次结构清晰：YAML格式通过缩进表示层级关系，使得复杂配置更易于理解和维护。
支持数组和复杂对象：YAML可以轻松表示数组和复杂对象，适合更复杂的配置需求。

2.3 缺点

语法敏感：YAML对缩进和空格非常敏感，容易因为格式错误导致解析失败。
学习曲线：对于不熟悉YAML的人来说，可能需要一些时间来适应。

2.4 示例

以下是一个更复杂的application.yml示例，展示了如何配置多个数据源和Spring Profiles：

spring:
  profiles:
    active: dev
  datasource:
    dev:
      url: jdbc:mysql://localhost:3306/devdb
      username: devuser
      password: devpass
    prod:
      url: jdbc:mysql://localhost:3306/proddb
      username: produser
      password: prodpass
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL5Dialect

3. 选择使用 application.properties 还是 application.yml

3.1 选择依据

项目复杂度：如果项目配置较简单，使用application.properties可能更为合适；如果项目配置复杂，建议使用application.yml。
团队习惯：如果团队成员对某种格式更为熟悉，选择该格式可以提高开发效率。

3.2 注意事项

文件命名：Spring Boot会自动加载application.properties或application.yml，确保文件命名正确。
环境特定配置：可以使用application-{profile}.properties或application-{profile}.yml来定义特定环境的配置，例如application-dev.properties。
优先级：Spring Boot会根据特定的优先级加载配置文件，通常application.properties的优先级高于application.yml，但可以通过@PropertySource注解自定义加载顺序。

4. 结论

在Spring Boot中，application.properties和application.yml是配置应用程序的重要工具。选择合适的配置文件格式可以提高代码的可读性和可维护性。理解它们的优缺点以及使用场景，将帮助开发者更好地管理和配置Spring Boot应用程序。无论选择哪种格式，确保遵循最佳实践，以便在团队中实现高效的协作和开发。