摘要：在互联网大厂后端开发的日常工作里，Spring Boot 3 是一个极为常用且强大的框架。当我们着手开发基于 Spring Boot 3 的项目时，常常会面临需要自定义配置文件的情况。这不仅能让我们灵活地调整项目的运行参数，还能更好地适配不同的环境和业务需求。
在互联网大厂后端开发的日常工作里，Spring Boot 3 是一个极为常用且强大的框架。当我们着手开发基于 Spring Boot 3 的项目时，常常会面临需要自定义配置文件的情况。这不仅能让我们灵活地调整项目的运行参数，还能更好地适配不同的环境和业务需求。那么，究竟如何在 Spring Boot 3 中实现自定义的配置文件呢？今天，就带大家深入探索一番。
Spring Boot 3 默认会读取 application.properties 或 application.yml 这两个配置文件。其中，application.yml 因其简洁易读的格式，近年来越来越受开发者青睐。我们先来看在 application.ym 中自定义属性的方法。
假设我们要定义一组与用户相关的自定义属性，可以这样编写：
my:user:name: 自定义用户名age: 30email: example@example.com在上述代码中，我们通过层级结构定义了 my.user 下的多个属性。那么，如何在代码中读取这些属性呢？有两种常见方式。
使用@Value注解
如果只是简单地读取单个属性值，我们可以在需要使用属性值的变量上添加 @Value("${属性名}") 注解。例如：
import org.springframework.beans.factory.annotation.Value;import org.springframework.stereotype.Component;@Componentpublic class MyComponent {@Value("${my.user.name}")private String myUserName;@Value("${my.user.age}")private int myUserAge;// 相应的 get 和 set 方法public String getMyUserName {return myUserName;}public void setMyUserName(String myUserName) {this.myUserName = myUserName;}public int getMyUserAge {return myUserAge;}public void setMyUserAge(int myUserAge) {this.myUserAge = myUserAge;}}这样，在 MyComponent 类中，我们就成功将配置文件中的属性值注入到了对应的变量中。不过，@Value 注解在处理多个相关属性时，代码可能会显得比较繁琐，此时我们可以采用另一种方式。
使用@ConfigurationProperties注解
这种方式更适合将一组相关的配置属性赋值给一个实体类。我们继续以上述 my.user 的配置为例，创建一个对应的实体类 UserConfig：
import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.stereotype.Component;@Component@ConfigurationProperties(prefix = "my.user")public class UserConfig {private String name;private int age;private String email;// 生成对应的 get 和 set 方法public String getName {return name;}public void setName(String name) {this.name = name;}public int getAge {return age;}public void setAge(int age) {this.age = age;}public String getEmail {return email;}public void setEmail(String email) {this.email = email;}}在这个类中，我们通过 @ConfigurationProperties(prefix = "my.user") 注解，告诉 Spring Boot 将配置文件中 my.user 前缀下的属性值绑定到这个类的对应属性上。同时，加上 @Component 注解，使 Spring Boot 启动时将该类作为 Bean 注入 IoC 容器。
之后，在需要使用这些属性的地方，比如 Controller 类中，我们还需要加上 @EnableConfigurationProperties 注解并指明该 bean 类：
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestController@EnableConfigurationProperties(UserConfig.class)public class MyController {@Autowiredprivate UserConfig userConfig;@GetMapping("/userConfig")public String getUserConfig {return "Name: " + userConfig.getName + ", Age: " + userConfig.getAge + ", Email: " + userConfig.getEmail;}}这样，当访问 /userConfig 接口时，就能获取到配置文件中自定义的用户属性信息了。这种方式对于管理一组相关的配置属性非常方便，代码结构也更加清晰。
在实际开发中，我们往往需要针对不同的环境，如开发环境（dev）、测试环境（test）、生产环境（prod）等，使用不同的配置。Spring Boot 3 为我们提供了非常便捷的多环境配置支持。
多环境配置文件的命名遵循特定规则，即 application-{profile}.properties 或 application-{profile}.yml，其中 {profile} 就是我们的环境标识。
我们可以在 application.properties 文件中通过 spring.profiles.active 属性来设置要加载的配置文件。例如，想要加载开发环境的配置文件，可设置 spring.profiles.active=dev，这样就会加载 application-dev.properties 或 application-dev.yml 的配置内容。
也可以通过命令行方式激活不同环境配置。比如，在启动项目的 jar 包时，使用 java -jar xxx.jar --spring.profiles.active=prod，就会加载 application-prod.properties 或 application-prod.yml 的配置，这在将项目部署到服务器时非常实用，能方便地切换不同环境的配置。
以配置数据库连接为例，在开发环境中，我们可能希望连接本地的测试数据库，而在生产环境中则连接线上的正式数据库。我们可以在 application-dev.yml 中这样配置开发环境的数据库连接：
spring:datasource:url: jdbc:mysql://localhost:3306/test_dbusername: dev_userpassword: dev_password在 application-prod.yml 中配置生产环境的数据库连接：
spring:datasource:url: jdbc:mysql://prod-db-server:3306/prod_dbusername: prod_userpassword: prod_password通过这种方式，我们能轻松管理不同环境下的配置差异，大大提高了项目的可维护性和灵活性。
虽然 Spring Boot 3 通常默认读取 application.properties 和 application.yml，但在某些特殊情况下，我们可能需要创建完全自定义的配置文件，比如当我们开发一个可复用的模块，希望有自己独立的配置体系时。
在旧版本的 Spring Boot 中（如 2.1.2 版本时），若要使用自定义名称和位置的配置文件，需要在绑定类上加 @PropertySource 注解，并指明自定义配置文件的位置，而且当时要求自定义配置文件必须是 .properties 文件格式。不过在 Spring Boot 3 中，情况有所变化，虽然这种方式仍可使用，但现在对配置文件格式的限制没那么严格了，.yml 格式的自定义配置文件也能很好地支持。
假设我们有一个 custom.yml 的自定义配置文件，内容如下：
custom:setting1: value1setting2: value2import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.PropertySource;@Configuration@PropertySource("classpath:custom.yml")@ConfigurationProperties(prefix = "custom")public class CustomConfig {private String setting1;private String setting2;// 生成对应的 get 和 set 方法public String getSetting1 {return setting1;}public void setSetting1(String setting1) {this.setting1 = setting1;}public String getSetting2 {return setting2;}public void setSetting2(String setting2) {this.setting2 = setting2;}}在上述代码中，通过 @PropertySource("classpath:custom.yml") 注解指定了自定义配置文件的位置（这里假设配置文件放在 src/main/resources 目录下），然后通过 @ConfigurationProperties(prefix = "custom") 注解将配置文件中 custom 前缀下的属性值绑定到 CustomConfig 类的对应属性上。
这样，在整个项目中，我们就可以像使用其他配置属性一样使用 CustomConfig 类中的属性了。不过需要注意的是，这种创建完全自定义配置文件的方式，一般在有特殊的模块化、可插拔等需求时才使用，对于常规的配置需求，优先考虑在默认配置文件中自定义即可。
通过以上几种方式，我们就能在 Spring Boot 3 项目中灵活地实现自定义配置文件，满足各种复杂的业务和环境需求。无论是简单地在默认配置文件中添加自定义属性，还是运用多环境配置文件，亦或是创建完全自定义的配置文件，都为我们打造高效、灵活的后端应用提供了有力支持。希望本文的内容能对各位互联网大厂的后端开发人员在使用 Spring Boot 3 时有所帮助，让大家在项目开发中更加得心应手。
来源：从程序员到架构师一点号