spring boot 启动读取config

原创

mob64ca12d84572 2023-12-28 05:54:30 ©著作权

文章标签 配置文件 spring 应用程序 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d84572的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 启动读取 Config

在使用 Spring Boot 进行开发时，我们经常需要在启动时读取配置信息。配置信息通常存储在配置文件中，例如 application.properties 或 application.yml。Spring Boot 提供了方便的机制来读取这些配置文件并注入到应用程序中。

为什么使用配置文件？

在开发过程中，我们经常需要根据不同的环境来配置应用程序的行为，例如数据库连接、日志级别等。而将这些配置信息硬编码到代码中是不可取的，因为这样做会使得代码变得不灵活，并且在不同环境中切换时需要修改代码并重新编译。使用配置文件可以使得应用程序在不同环境中具有相同的代码，只需修改配置文件即可。

Spring Boot 配置

Spring Boot 提供了多种方式来读取配置文件。其中最常见的方式是使用 @Value 注解来注入配置值。

首先，我们需要在配置文件中定义配置项。假设我们需要配置一个数据库连接的 URL 和用户名，我们可以在 application.properties 中添加如下配置：

database.url=jdbc:mysql://localhost:3306/mydb
database.username=root

然后，我们可以在代码中使用 @Value 注解来注入这些配置值：

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

@Component
public class DatabaseConfig {
    @Value("${database.url}")
    private String databaseUrl;

    @Value("${database.username}")
    private String username;

    // 省略 getter 和 setter 方法
}

在上面的代码中，我们使用 @Value("${property.key}") 的方式来注入配置值。${property.key} 会被替换为实际的配置值。

配置文件的加载顺序

Spring Boot 支持多个配置文件，并且会按照一定的顺序加载这些文件。下面是 Spring Boot 加载配置文件的顺序：

application.properties 或 application.yml：这是默认的主配置文件，会在所有其他配置文件之前加载。
application-{profile}.properties 或 application-{profile}.yml：根据当前的激活的 profile 加载对应的配置文件。例如，如果当前的 profile 是 dev，则会加载 application-dev.properties 或 application-dev.yml。
其他自定义配置文件：可以通过 spring.config.name 和 spring.config.location 属性来指定其他的配置文件。

示例

下面是一个完整的示例，演示了如何使用 Spring Boot 进行配置文件的读取：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@Component
public class DatabaseConfig {
    @Value("${database.url}")
    private String databaseUrl;

    @Value("${database.username}")
    private String username;

    // 省略 getter 和 setter 方法
}

database.url=jdbc:mysql://localhost:3306/mydb
database.username=root

在上面的示例中，我们定义了一个 Application 类作为应用程序的入口点，并使用 @SpringBootApplication 注解标注该类。DatabaseConfig 类使用 @Component 注解标注，使得 Spring Boot 可以将其识别为一个可注入的组件，并使用 @Value 注解注入配置值。

当应用程序启动时，Spring Boot 会自动加载配置文件，并将其中的配置值注入到 DatabaseConfig 类中。