摘要：在当今的互联网软件开发领域，Spring Boot 无疑是一个极为重要且广泛应用的框架。尤其是 Spring Boot3 的推出，带来了众多令人瞩目的新特性与优化，为开发者们提供了更加强大而灵活的开发工具。其中，自定义配置文件在实际项目开发中扮演着举足轻重的角
在当今的互联网软件开发领域，Spring Boot 无疑是一个极为重要且广泛应用的框架。尤其是 Spring Boot3 的推出，带来了众多令人瞩目的新特性与优化，为开发者们提供了更加强大而灵活的开发工具。其中，自定义配置文件在实际项目开发中扮演着举足轻重的角色，它允许开发者根据项目的独特需求，对应用程序的各项配置进行精细调整，从而确保应用在不同环境和业务场景下都能高效稳定地运行。本文将深入探讨在 Spring Boot3 中如何实现自定义配置文件，为广大互联网软件开发人员提供全面且实用的技术指导。
在深入探究自定义配置之前，先来简单回顾下 Spring Boot3 的自动配置原理。当我们在项目中引入各种 Starter 依赖时，Spring Boot 会依据类路径下的相关资源以及一系列条件注解，自动配置应用程序所需的各类组件。例如，当引入 spring-boot-starter-web 依赖时，Spring Boot 便能自动配置好 Web 开发所需的基础组件，像 Tomcat 服务器、Spring MVC 框架等。这种自动配置机制极大地提升了开发效率，让开发者可以迅速投身业务逻辑开发，无需在基础配置上耗费过多精力。然而，在实际项目中，有时官方默认的配置难以完全契合复杂多变的业务需求，此时，自定义配置便派上了用场。
Spring Boot3 为每个 Starter 都提供了默认配置，这些配置在大多数常规场景下能够满足功能开发需求。但倘若我们想要修改某些默认配置，操作其实相当简便。
以修改 Tomcat 启动端口为例，在 Spring Boot 开发 Web 应用时，Tomcat 默认启动端口为 8080，若要将其修改为 8888，只需在 application.properties 文件中添加如下记录：
server.port=8888修改完成后，重启项目，从启动日志中便可清晰看到：Tomcat started on port (s): 8888 (http)，此时通过浏览器访问http://localhost:8888，就能正常访问应用了。
再比如配置数据库连接信息（这里以使用 com.alibaba 的 Druid 连接池为例），同样在 application.properties 文件中添加如下配置：
druid.url=jdbc:MySQL://192.168.0.20:3306/testdruid.driver-class=com.mysql.jdbc.Driverdruid.username=rootdruid.password=123456druid.initial-size=1druid.min-idle=1druid.max-active=20druid.test-on-borrow=true如此一来，就完成了对 Druid 连接池相关默认配置的修改。从这两个简单示例可以看出，若要修改 Starter 模块中的默认配置，只需在 application.properties 文件中添加相应的修改配置即可。
在 application.properties 中添加自定义属性
在 application.properties 文件里，我们不仅能够修改默认配置，还可以自定义属性。例如，添加如下自定义属性配置：
myapp.custom.property1=value1myapp.custom.property2=100接下来，我们需要编写一个 Bean 类，用于加载这些自定义属性。有两种常见方式：
使用 @Value 注解加载
创建一个 Sam 类，并添加 @Component 注解，以便 Spring 在启动时扫描到该类并将其纳入 Spring 容器管理。通过 @Value 注解来加载属性，示例代码如下：
import org.springframework.beans.factory.annotation.Value;import org.springframework.stereotype.Component;@Componentpublic class Sam {@Value("${myapp.custom.property1}")private String property1;@Value("${myapp.custom.property2}")private int property2;// 省略getter和setter方法}需注意，使用 @Value 注解时，所在类必须被 Spring 容器管理，且注解需传入完整的配置项 Key 值。此外，@Value 注解默认读取 application.properties 配置文件，若要读取其他配置文件，可借助 @PropertySource 注解指定。
使用 @ConfigurationProperties 注解加载
同样创建 Sam 类，通过 @ConfigurationProperties (prefix = "myapp.custom") 设置前缀，属性上无需再添加额外注解，示例代码如下：
import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.stereotype.Component;@Component@ConfigurationProperties(prefix = "myapp.custom")public class Sam {private String property1;private int property2;// 省略getter和setter方法}这种方式更为简洁，尤其适用于批量加载具有相同前缀的多个属性。
在 Controller 中注入并使用 Bean
在 Controller 中注入上述 Sam Bean，即可使用自定义属性。例如：
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class SamController {@Autowiredprivate Sam sam;@GetMapping("/sam")public String getSam {return "property1: " + sam.getProperty1 + ", property2: " + sam.getProperty2;}}通过浏览器访问http://localhost:8080/sam（假设项目端口为 8080），便能看到控制台正常打印出 Sam 类中自定义属性的值。
当默认配置与自定义属性配置都无法满足复杂业务需求时，我们可以创建自定义自动配置类。
（一）创建自定义自动配置类
首先，创建一个类，并使用 @Configuration 和 @ConditionalOnClass 注解。其中，@Configuration 表明这是一个配置类，@ConditionalOnClass 用于指定该配置类生效的条件，即只有当指定的类存在于类路径中时，该配置类才会生效。例如，我们创建一个用于用户权限管理的自定义自动配置类 UserPermissionAutoConfiguration：
import org.springframework.context.annotation.Configuration;import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;@Configuration@ConditionalOnClass(UserPermissionService.class)public class UserPermissionAutoConfiguration {// 这里可以定义相关的Bean配置等}（二）配置属性绑定
在自定义配置类中，常常需要读取配置文件中的属性值。这时，@ConfigurationProperties 注解就派上用场了。假设我们有一个用于用户模块的配置，在 application.yml 文件中有如下配置内容：
user:username: adminpassword: 123456roles:- ROLE_ADMIN- ROLE_USER我们可以创建一个 UserProperties 类来绑定这些属性：
import org.springframework.boot.context.properties.ConfigurationProperties;import JAVA.util.List;@ConfigurationProperties(prefix = "user")public class UserProperties {private String username;private String password;private List roles;// 生成对应的getter和setter方法}在自定义配置类 UserPermissionAutoConfiguration 中，通过 @EnableConfigurationProperties 注解启用这个属性类，就可以在配置类中方便地使用这些属性值。例如：
import org.springframework.boot.autoconfigure.AutoConfiguration;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.context.annotation.Bean;@AutoConfiguration@EnableConfigurationProperties(UserProperties.class)public class UserPermissionAutoConfiguration {@Beanpublic UserPermissionService userPermissionService(UserProperties userProperties) {// 使用userProperties中的属性创建并返回UserPermissionService实例return new UserPermissionService(userProperties.getUsername, userProperties.getPassword, userProperties.getRoles);}}这样，在应用程序运行时，配置文件中的属性值就能自动注入到 UserProperties 类中，并在配置类中被正确使用。
（三）条件化配置
Spring Boot3 还支持条件化配置，通过 @Conditional 系列注解实现。比如 @ConditionalOnClass 注解表示当某个类存在于类路径时，才会应用该配置。若我们的自定义配置类依赖于某个特定的数据库驱动类，如 com.mysql.cj.jdbc.Driver，就可以使用这个注解确保只有在项目引入了 MySQL 驱动依赖时，该配置类才会生效，避免因找不到类而导致的错误配置。
类似的，@ConditionalOnProperty 注解可以根据配置文件中的属性值来决定是否应用配置。例如，只有当配置文件中 user.enabled 属性为 true 时，才创建某个 bean：
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class ConditionalConfig {@Bean@ConditionalOnProperty(name = "user.enabled", havingValue = "true")public UserService userService {return new UserService;}}在 Spring Boot3 中，了解自定义配置文件的加载顺序与优先级至关重要，这有助于我们在复杂项目中精准控制配置的生效情况。
（一）加载顺序
首先加载的是系统属性，例如通过 - D 参数在命令行中设置的属性，如 java -jar myapp.jar -Dserver.port=9000，这里设置的 server.port 属性会优先被加载。
接着是操作系统环境变量，系统环境变量中的相关配置也会被读取，例如我们在系统中设置的 JAVA_HOME 等环境变量，如果在 Spring Boot 配置中有与之相关的引用，也会按规则生效。
然后是application.properties 或 application.yml 文件，这是我们最常用的配置文件，其中的配置会按照一定规则加载。如果存在多个 profile 特定的配置文件，如 application-dev.yml、application-prod.yml 等，会根据激活的 profile 来加载相应的文件。
最后是通过 @PropertySource 注解加载的自定义配置文件，如果我们在代码中通过 @PropertySource ("classpath:custom.properties") 这样的方式指定了自定义配置文件，它会在上述配置加载之后被加载。
（二）优先级
优先级方面，总体原则是后加载的配置会覆盖先加载的配置。具体来说：
命令行参数具有最高优先级，因为它是在应用启动时动态指定的，能够直接覆盖其他地方的配置。例如前面提到的通过 - D 参数设置的 server.port，会直接覆盖 application.properties 等文件中设置的端口。
application.properties 或 application.yml 中 profile 特定的配置文件优先级高于默认的 application.properties 或 application.yml。比如当激活了 dev profile 时，application-dev.yml 中的配置会覆盖 application.yml 中相同属性的配置。
@PropertySource 注解加载的自定义配置文件优先级相对较低，它主要用于补充一些特定功能或模块的配置，当与前面的配置存在冲突时，会被前面的配置覆盖。
了解这些加载顺序与优先级，能帮助我们在项目中合理安排配置，避免出现配置错误或预期外的配置生效情况。
（一）微服务架构中的服务个性化配置
在一个大型电商平台的微服务架构中，用户服务、订单服务、商品服务等各自有独特的配置需求。以用户服务为例，它可能需要特定的数据库连接配置来高效存储和查询用户信息，还需要一些与用户权限、认证相关的配置参数。通过自定义配置文件，我们可以为用户服务创建 UserServiceAutoConfiguration 类，专门管理这些个性化配置。
在 UserServiceAutoConfiguration 类中，我们可以通过 @ConfigurationProperties 注解绑定用户服务相关的配置属性，如：
import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.Configuration;@Configuration@ConfigurationProperties(prefix = "user.service")public class UserServiceProperties {private String dbUrl;private String dbUsername;private String dbPassword;private int maxUserSessions;// 生成对应的getter和setter方法}然后在配置文件 application.yml 中添加相应的配置：
user.service:dbUrl: jdbc:mysql://user-db-server:3306/user_dbdbUsername: user_service_userdbPassword: user_service_passwordmaxUserSessions: 1000这样，通过自定义配置文件，确保了用户服务运行的高效与稳定，满足了业务对该服务的特定需求。
（二）通用功能模块的封装
在许多项目中，常常会有一些通用功能模块，如短信发送模块、日志记录模块等。以短信发送模块为例，不同项目可能使用不同的短信服务提供商，每个提供商的配置参数（如 API 密钥、短信模板 ID 等）都不同。我们可以将短信发送模块封装成一个自定义 Starter，其中包含自定义配置类。
在自定义配置类 SmsConfiguration 中，通过 @ConfigurationProperties 注解绑定不同提供商的配置参数：
import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.Configuration;@Configuration@ConfigurationProperties(prefix = "sms.provider")public class SmsConfiguration {private String apiKey;private String templateId;private String endpoint;// 生成对应的getter和setter方法}在项目的 application.yml 文件中，根据所使用的短信服务提供商，配置相应的参数：
sms.provider:apiKey: your_api_keytemplateId: your_template_idendpoint: https://sms.provider.com/api/send通过这种方式，用户在使用这个自定义 Starter 时，只需在项目的配置文件中修改相应的配置参数，就能方便地适配不同的短信服务提供商，极大地提高了通用功能模块的可复用性和灵活性。
在 Spring Boot3 的开发过程中，掌握自定义配置文件的实现方法对于开发者来说是一项必备技能。通过本文的介绍，我们了解了 Spring Boot3 的自动配置原理，以及如何通过属性文件修改默认配置、进行自定义属性配置，还深入探讨了自定义自动配置类的创建、配置属性绑定和条件化配置等关键内容，同时分析了自定义配置文件的加载顺序与优先级，并结合实际项目案例展示了其在微服务架构和通用功能模块封装中的应用。
随着互联网软件开发的不断发展，业务需求将变得更加复杂多样，Spring Boot 也将持续演进。未来，我们可以期待 Spring Boot 在配置管理方面提供更多便捷、高效的功能，进一步提升开发者的开发体验和项目的可维护性。希望广大互联网软件开发人员能够熟练运用 Spring Boot3 的自定义配置功能，打造出更加健壮、灵活、高效的应用程序，为互联网行业的发展贡献更多的力量。
来源：从程序员到架构师一点号
