Spring Boot 配置与属性管理：如何让你的配置文件像“调皮的孩子”一样灵活又不失控？

🏆本文收录于「滚雪球学SpringBoot」专栏(全网一个名)，手把手带你零基础入门Spring Boot，从入门到就业，助你早日登顶实现财富自由🚀；同时，欢迎大家关注&&收藏&&订阅！持续更新中，up！up！up！！

环境说明：Windows 10 + IntelliJ IDEA 2021.3.2 + Jdk 1.8

前言：

在开发大型应用时，Spring Boot 是我们最常使用的框架之一。它为我们提供了许多功能，特别是在配置与属性管理方面，极大提高了我们的开发效率。作为开发者，我们不仅要学会如何管理配置文件，还要知道如何高效地运用它们，以便在不同环境下顺利运行应用程序。🚀

配置文件在应用开发中的重要性不言而喻，它是应用的“心脏”，负责处理从数据库连接、缓存、API 密钥，到系统端口和环境参数等各种关键信息。如果配置文件管理不当，应用就会像一辆失去方向的车，哪里都去不了。💥

所以，今天我带你深入探索 Spring Boot 配置与属性管理的一切，不仅是基础配置，更包括动态配置、复杂环境的切换、以及如何使用注解让你的配置灵活又安全！🌈

准备好了吗？跟我一起探索 Spring Boot 配置管理的奥秘吧！😎

📝 配置文件介绍：application.properties vs application.yml

在 Spring Boot 中，配置文件是管理应用配置信息的核心方式。我们常用的两种配置文件格式是 application.properties 和 application.yml，这两者各有千秋，选择哪一种取决于项目的需求和开发者的个人习惯。

1. application.properties —— 经典的选择

application.properties 是 Spring Boot 最早期的配置方式，它采用简单的键值对格式。对于一些简单的配置项，它非常方便且直观，尤其适合小型或简单项目。

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root

优点：

• 格式简单，易于上手。
• 对于少量的配置项，十分高效。
• 与很多其他 Java 工具兼容，兼容性好。

缺点：

• 当配置项增多时，文件会变得非常冗长，难以管理。
• 不适合多层次、多嵌套的配置结构。

2. application.yml —— 灵活的选择

application.yml 采用 YAML 格式，它支持嵌套的层次结构，配置清晰且易于阅读。YAML 格式可以通过缩进的方式表示配置项的层级，非常适合处理多层次的复杂配置。

server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: root

优点：

• 支持多层级的配置结构，适合复杂的项目配置。
• 配置清晰且易于阅读，尤其对于开发和运维团队非常友好。
• 支持注释，可以更好地解释每一项配置的含义。

缺点：

• 对缩进要求较高，稍有疏忽就可能导致解析错误。
• 对于小型项目来说，使用 YAML 格式会显得有些过于复杂。

哪种格式更适合你？

如果项目比较简单，并且配置项不多，那么 application.properties 可能更加适合你。然而，如果你的项目配置项繁多且具有层次结构，application.yml 无疑是更好的选择。两者各有优缺点，具体使用哪种格式，完全取决于项目的实际需求。

🔧 使用 @Value 和 @ConfigurationProperties

配置文件和 Spring Boot 的应用程序并不是孤立的，必须通过某些方式将配置注入到代码中。Spring Boot 提供了 @Value 和 @ConfigurationProperties 两种非常实用的注解，帮助我们轻松地将配置文件中的数据注入到 Bean 中。

1. @Value —— 简单直接，适用于单一配置项

@Value 注解用于将单一配置项的值注入到 Spring Bean 中，它的语法简单且直观，适合读取简单的配置项。

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

@Component
public class MyService {

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

    public void printServerPort() {
        System.out.println("Server port is: " + serverPort);
    }
}

优点：

• 简单直观，适合配置项较少且简单的场景。
• 轻松将配置项注入到 Spring Bean 中，灵活方便。

缺点：

• 不适合读取复杂的、多层次的配置结构。
• 对于多个配置项，@Value 会显得比较冗长。

2. @ConfigurationProperties —— 配置类绑定的最佳选择

@ConfigurationProperties 是一种更为灵活和强大的方式，它可以将配置文件中的多个属性绑定到一个 Java Bean 中，非常适合读取多个配置项。它适用于结构化配置和复杂配置的场景。

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
}

通过 @ConfigurationProperties，Spring Boot 会自动将配置文件中的属性与 Java Bean 进行绑定。这样，我们只需注入一个类，就可以将多个配置项一次性绑定。

优点：

• 可以一次性读取多个配置项，代码简洁。
• 适用于配置项复杂且层次多的场景。
• 更容易进行维护和管理。

缺点：

• 需要定义专门的配置类，相对较为繁琐。
• 比 @Value 多了些额外的配置和步骤。

选择哪种注解？

如果你的项目配置简单，并且配置项数量不多，那么 @Value 可能是一个不错的选择。如果你有多个复杂的配置项，使用 @ConfigurationProperties 进行统一管理更加清晰和方便。其实这两者并不冲突，可以根据具体场景来选择使用。

🌍 环境特定的配置（例如：开发、生产环境）

当你在开发过程中遇到不同的环境需求时，Spring Boot 提供了非常方便的功能来处理这些不同的环境配置。你可以为每个环境指定不同的配置文件，在运行时自动加载适合当前环境的配置。

1. 使用 application-{profile}.properties 或 application-{profile}.yml

Spring Boot 允许你为不同的环境定义不同的配置文件。例如，你可以为开发环境创建 application-dev.properties，为生产环境创建 application-prod.properties，然后通过指定环境来加载相应的配置文件。

# application-dev.properties
spring.datasource.url=jdbc:mysql://localhost:3306/dev_db

# application-prod.properties
spring.datasource.url=jdbc:mysql://localhost:3306/prod_db

2. 激活特定的 Profile

Spring Boot 通过 spring.profiles.active 属性来指定当前激活的 Profile。你可以通过以下方式来设置：

• 在 application.properties 中指定：

spring.profiles.active=dev

• 在启动时通过命令行参数指定：

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

• 或者在 IDE 中配置运行时的环境。

Spring Boot 会根据 spring.profiles.active 的值，加载对应的配置文件。这种方式让你在不同的环境之间切换配置变得异常简单和灵活。

3. 通过 @Profile 注解指定环境特定的 Bean

除了配置文件，你还可以使用 @Profile 注解来为特定环境配置特定的 Bean。例如，某个 Bean 只在开发环境中加载，而另一个 Bean 只在生产环境中加载：

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

@Component
@Profile("dev")
public class DevBean {
    // 仅在开发环境中加载
}

通过 @Profile，你可以根据不同的环境动态注入不同的 Bean，使得项目更加灵活。

🔄 配置类与配置文件的绑定

将配置文件的属性绑定到 Java 类中，可以大大简化代码的维护和管理，尤其在处理复杂的多层级配置时非常有用。Spring Boot 提供的 @ConfigurationProperties 注解正是为此而生，它能够帮助我们将配置文件与 Java 类进行高效绑定。

@ConfigurationProperties(prefix = "server")
public class ServerConfig {

    private String address;
    private int port;

    // getters and setters
}

这种方式能够将 application.properties 或 application.yml 中的配置项，自动绑定到 ServerConfig 类的属性上。Spring Boot 会根据 prefix 的值（比如 server）自动映射配置项。

🔄 动态属性修改与刷新

动态属性修改是开发中的一项重要需求。例如，当你需要在运行时修改某个配置项时，如何让这些修改立即生效，而无需重启应用？Spring Boot 提供了动态刷新功能，通过 @RefreshScope 注解，可以使得 Bean 在配置变动时重新加载。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Component
@RefreshScope
public class DynamicConfig {

    @Value("${dynamic.property}")
    private String dynamicProperty;

    public void printDynamicProperty() {
        System.out.println("Dynamic property: " + dynamicProperty);
    }
}

当 dynamic.property 发生变化时，Spring Boot 会自动刷新这个 Bean 并重新加载配置项。

Mermaid 流程图：配置文件绑定流程

通过这张流程图，我们可以看到应用启动时，Spring Boot 会检查是否有特定的配置 Profile，如果有，就加载相应的配置文件，否则加载默认配置文件。

结语：

在这篇文章中，我们深入探讨了 Spring Boot 配置与属性管理的各个方面。无论是选择配置文件格式、使用注解注入配置、环境特定的配置切换，还是动态配置刷新，我们都提供了详细的解说和实际的代码示例。🎉

希望通过这篇文章，你能更加熟练地掌握 Spring Boot 配置与属性管理的技巧，让你的应用配置更加高效、灵活、可维护！👏

别忘了，配置文件虽然看似简单，但它们对你的应用至关重要。合理管理配置，才能让你的应用更加稳定、易于扩展。🛠️

🧧福利赠与你🧧

  无论你是计算机专业的学生，还是对编程有兴趣的小伙伴，都建议直接毫无顾忌的学习此专栏「滚雪球学SpringBoot」专栏(全网一个名)，bug菌郑重承诺，凡是学习此专栏的同学，均能获取到所需的知识和技能，全网最快速入门SpringBoot，就像滚雪球一样，越滚越大， 无边无际，指数级提升。

  最后，如果这篇文章对你有所帮助，帮忙给作者来个一键三连，关注、点赞、收藏，您的支持就是我坚持写作最大的动力。

  同时欢迎大家关注公众号:「猿圈奇妙屋」 ，以便学习更多同类型的技术文章，免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板、技术文章Markdown文档等海量资料。

✨️ Who am I?

我是bug菌(全网一个名)，CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家，C站博客之星Top30，华为云多年度十佳博主/价值贡献奖，掘金多年度人气作者Top40，掘金等各大社区平台签约作者，51CTO年度博主Top12，掘金/InfoQ/51CTO等社区优质创作者；全网粉丝合计 30w+；更多精彩福利点击这里；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料，你想要的我都有，关键是你不来拿。

-End-