SpringBoot配置文件设置与读取，解锁开发新技能！

2024-01-28 23:05:33

SpringBoot 配置文件：properties 与 yml 的比较与指南

在 SpringBoot 开发中，配置文件是不可或缺的，它们负责管理应用程序的各种设置和属性。本文将深入探讨 SpringBoot 中两种最常用的配置文件格式：properties 和 yml，比较它们的差异并提供设置、读取和使用它们的实用指南。

properties 与 yml 的差异

文件格式

properties 文件采用键值对格式，以等号（=）分隔键与值。
yml 文件采用 YAML 格式，它是一种可读性更高的文本标记语言，支持缩进和注释。

语法

properties 文件的语法更简单，只允许使用等号分隔键值对。
yml 文件的语法更为灵活，允许使用冒号（:）分隔键值对，并支持缩进和注释，这提高了可读性和可维护性。

加载顺序

SpringBoot 会按顺序加载配置文件，因此如果同一个键在多个配置文件中出现，后面的配置文件中的值会覆盖前面的配置文件中的值。

设置 SpringBoot 配置文件

配置文件可以通过两种方式设置：

使用 @PropertySource 注解

可以在应用程序的主类中使用 @PropertySource 注解指定配置文件的路径。例如：

@SpringBootApplication
@PropertySource("classpath:application.properties")
public class MyApp {

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

在配置文件中直接设置

也可以直接在配置文件中设置配置信息，如：

# application.properties
server.port=8080

读取 SpringBoot 配置文件

配置文件可以通过以下方式读取：

使用 @Value 注解

可以在应用程序类中使用 @Value 注解读取配置文件中的值，如：

@SpringBootApplication
public class MyApp {

    @Value("${server.port}")
    private int port;

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

使用 Environment 接口

也可以使用 Environment 接口来读取配置文件中的值，如：

@SpringBootApplication
public class MyApp {

    @Autowired
    private Environment env;

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

    public void printPort() {
        System.out.println("Server port: " + env.getProperty("server.port"));
    }
}

SpringBoot 配置文件使用技巧

使用环境变量

可以通过环境变量覆盖配置文件中的值，如：

export SERVER_PORT=9090

使用 @ConfigurationProperties 注解

可以使用 @ConfigurationProperties 注解将配置文件中的值绑定到一个类，如：

@SpringBootApplication
public class MyApp {

    @ConfigurationProperties(prefix = "server")
    private ServerConfig serverConfig;

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

    public ServerConfig getServerConfig() {
        return serverConfig;
    }

    public void setServerConfig(ServerConfig serverConfig) {
        this.serverConfig = serverConfig;
    }
}

使用 @RefreshScope 注解

可以使用 @RefreshScope 注解使配置文件中的值在应用程序运行时可以动态刷新，如：

@SpringBootApplication
public class MyApp {

    @RefreshScope
    @ConfigurationProperties(prefix = "server")
    private ServerConfig serverConfig;

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

    public ServerConfig getServerConfig() {
        return serverConfig;
    }

    public void setServerConfig(ServerConfig serverConfig) {
        this.serverConfig = serverConfig;
    }
}