Spring Boot 配置文件详解

在现代 Java 开发中，Spring Boot已经成为构建企业级应用的热门选择。它通过约定优于配置的原则，大大简化了复杂的配置过程。本文将深入探讨Spring Boot中的配置文件，包括如何使用、为何使用，以及示例代码。

1. Spring Boot 配置文件的基本概念

Spring Boot的配置文件通常是 application.properties 或 application.yml。这两个文件的目的主要是为了定义项目中的一些配置属性，如数据库连接、spring相关配置等等。application.properties是以键值对的形式进行配置，而application.yml则使用YAML格式，具有层次化结构更加清晰。

1.1 application.properties 示例

以下是一个简单的 application.properties 文件示例：

# 设置应用的名称
spring.application.name=MySpringBootApp

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=123456

# 设置服务器端口
server.port=8081

# 开启自动配置的路径
spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

1.2 application.yml 示例

与上面的properties文件相对应，下面是 application.yml 的示例：

spring:
  application:
    name: MySpringBootApp
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: 123456
  autoconfigure:
    exclude: org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
server:
  port: 8081

2. 配置文件的加载

Spring Boot会自动加载 application.properties 或 application.yml 文件。通常，这些文件会放在 src/main/resources 目录下。在应用启动时，Spring Boot会将这些文件中的配置信息读取到Spring的上下文中。因此，你可以在代码中通过注入@Value注解或使用@ConfigurationProperties来获取这些配置。

2.1 使用 @Value 注解读取配置

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConfig {

    @Value("${spring.application.name}")
    private String appName;

    public void printAppName() {
        System.out.println("应用名称: " + appName);
    }
}

2.2 使用 @ConfigurationProperties 绑定配置

使用@ConfigurationProperties可以将配置属性绑定到一个对象中，更加灵活和类型安全。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {

    private String url;
    private String username;
    private String password;

    // Getters and Setters
}

3. Profile（环境配置）

Spring Boot支持多种环境的配置管理。你可以根据不同的运行环境（开发、测试、生产等）提供不同的配置文件。例如，可以使用 application-dev.properties 来针对开发环境配置，而使用 application-prod.properties 来进行生产环境的配置。

可以在启动时指定激活的profile，例如：

java -jar myapp.jar --spring.profiles.active=dev

在上述情况下，激活 application-dev.properties 中的配置。

4. 配置文件的优先级

Spring Boot的配置文件有一个明确的优先级。设置的优先级从高到低依次为：

1. application-{profile}.properties / application-{profile}.yml
2. application.properties / application.yml
3. 系统环境变量
4. 命令行参数

结论

Spring Boot的配置机制为开发者提供了非常便利的方式来管理应用的所有配置。通过合理组织和使用配置文件，可以有效降低代码中的硬编码风险，提高应用的可维护性与灵活性。希望通过本文的介绍，能帮助大家更好地理解和使用Spring Boot配置文件。