:Springboot项目当中配置的优先级以及属性配置的常见方式

本文探讨了SpringBoot项目中三种配置文件(.properties,.yml,.yaml)及Java系统属性和命令行参数的配置优先级,指出application.properties优先级最高,推荐统一使用YAML格式。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

SpringBoot项目当中支持的三类配置文件:

  • application.properties

  • application.yml

  • application.yaml


     

    在SpringBoot项目当中,我们要想配置一个属性,可以通过这三种方式当中的任意一种来配置都可以,那么如果项目中同时存在这三种配置文件,且都配置了同一个属性,如:Tomcat端口号,到底哪一份配置文件生效

     application.properties


  • server.port=8081
     

    application.yml


  • server:
       port: 8082
    ~~~

     application.yaml


  • server:
       port: 8083
     

    我们启动SpringBoot程序,测试下三个配置文件中哪个Tomcat端口号生效:

    - properties、yaml、yml三种配置文件同时存在

    > properties、yaml、yml三种配置文件,优先级最高的是properties

    - yaml、yml两种配置文件同时存在

    > 配置文件优先级排名(从高到低):
    >
    > 1. properties配置文件
    > 2. yml配置文件
    > 3. yaml配置文件

    注意事项:虽然springboot支持多种格式配置文件,但是在项目开发时,推荐统一使用一种格式的配置。(yml是主流)

    在SpringBoot项目当中除了以上3种配置文件外,SpringBoot为了增强程序的扩展性,除了支持配置文件的配置方式以外,还支持另外两种常见的配置方式:

    1. Java系统属性配置 (格式: -Dkey=value)

       ~~~shell
       -Dserver.port=9000
       ~~~

    2. 命令行参数 (格式:--key=value)

       ~~~shell
       --server.port=10010
       ~~~

    那在idea当中运行程序时,如何来指定Java系统属性和命令行参数呢?

  • - 编辑启动程序的配置信息

    重启服务,同时配置Tomcat端口(三种配置文件、系统属性、命令行参数),测试哪个Tomcat端口号生效:

    删除命令行参数配置,重启SpringBoot服务:

    > 优先级: 命令行参数 >  系统属性参数 > properties参数 > yml参数 > yaml参数

    思考:如果项目已经打包上线了,这个时候我们又如何来设置Java系统属性和命令行参数呢?

    ~~~shell
    java -Dserver.port=9000 -jar XXXXX.jar --server.port=10010
    ~~~

    下面我们来演示下打包程序运行时指定Java系统属性和命令行参数:

    1. 执行maven打包指令package,把项目打成jar文件
    2. 使用命令:java -jar 方式运行jar文件程序

    项目打包:

    运行jar程序:

    - 同时设置Java系统属性和命令行参数

    - 仅设置Java系统属性

    > 注意事项:
    >
    > - Springboot项目进行打包时,需要引入插件 spring-boot-maven-plugin (基于官网骨架创建项目,会自动添加该插件)

    在SpringBoot项目当中,常见的属性配置方式有5种, 3种配置文件,加上2种外部属性的配置(Java系统属性、命令行参数)。通过以上的测试,我们也得出了优先级(从低到高):

    - application.yaml(忽略)
    - application.yml
    - application.properties
    - java系统属性(-Dxxx=xxx)
    - 命令行参数(--xxx=xxx)

<think>嗯,用户之前问过MQ的工作模式,现在转向Spring Boot配置文件的加载优先级。可能是在学习Spring Boot,或者在项目中遇到了配置冲突的问题。需要确认用户的实际需求,是否在部署时遇到了不同环境的配置覆盖问题,或者想了解如何正确管理多环境配置。 首先,Spring Boot配置加载机制确实复杂,因为有多个来源,优先级不同。用户可能想知道这些优先级顺序,以便正确配置应用。需要系统地列出各个配置源的优先级,从高到低,并举例说明常见场景。 然后,考虑到用户可能对某些细节不太清楚,比如外部化配置、profile-specific文件的作用。需要解释每个配置源的作用,比如命令行参数、JNDI属性、测试环境的@TestPropertySource,以及不同位置的配置文件如classpath、file:./config等。 另外,用户可能对如何覆盖配置感兴趣,比如在生产环境中如何通过外部文件覆盖默认配置。需要强调spring.config.location和spring.config.additional-location的使用方法,以及配置文件的命名规则,比如application-{profile}.properties。 还要注意用户是否混淆了配置加载的顺序和profile激活的顺序。可能需要简单提一下profile的激活方式,但重点还是在配置文件的优先级上。最后,确保回答结构清晰,分点列出优先级,并给出实际例子帮助理解。</think>好的,Spring Boot配置文件加载遵循特定的优先级规则,不同配置源的优先级决定了**最终生效的配置值**。以下是详细解析: --- ### 一、配置加载的核心原则 1. **优先级高的配置覆盖低优先级配置** 2. **相同配置项以高优先级来源为准** 3. **多环境支持**:通过`spring.profiles.active`指定激活的 Profile --- ### 二、配置优先级(从高到低) 以下按优先级**从高到低**排序,越靠前的配置优先级越高: 1. **命令行参数** - 启动时通过`--key=value`传递,例如: ```bash java -jar app.jar --server.port=8081 ``` 2. **Java 系统属性(`System.getProperties()`)** - 通过`-Dkey=value`设置,例如: ```bash java -Dserver.port=8082 -jar app.jar ``` 3. **操作系统环境变量** - 直接读取操作系统的环境变量(如`SERVER_PORT=8083`)。 4. **`application-{profile}.properties`/`application-{profile}.yml`(Profile 专属文件)** - 例如:`application-prod.properties`会覆盖`application.properties`中的相同配置。 5. **非 Profile 专属的配置文件** - `application.properties`或`application.yml`(位于项目外部目录或 classpath 中)。 6. **`@Configuration`注解的中的`@PropertySource`** - 例如: ```java @Configuration @PropertySource("classpath:custom.properties") public class AppConfig { ... } ``` 7. **默认属性(通过`SpringApplication.setDefaultProperties`设置)** - 在代码中硬编码的默认值。 --- ### 三、配置文件路径的优先级 当存在多个位置的`application.properties`或`application.yml`时,优先级按以下顺序(从高到低): 1. **项目根目录下的`/config`子目录** - `file:./config/`(当前运行目录的 config 文件夹) 2. **项目根目录** - `file:./`(当前运行目录) 3. **Classpath 中的`/config`目录** - `classpath:/config/` 4. **Classpath 根目录** - `classpath:/` **示例**: 若在`file:./config/application.yml`和`classpath:/application.yml`中同时定义`server.port`,则前者优先生效。 --- ### 四、Profile 的激活与覆盖 1. **指定激活的 Profile** - 通过命令行:`--spring.profiles.active=prod` - 通过环境变量:`SPRING_PROFILES_ACTIVE=prod` 2. **Profile 专属文件的命名规则** - `application-{profile}.properties`,例如:`application-dev.properties` 3. **多 Profile 叠加** - 可同时激活多个 Profile,例如: ```properties spring.profiles.active=dev,db-mysql ``` --- ### 五、外部化配置的扩展 1. **自定义配置位置** - 通过`spring.config.additional-location`添加额外路径: ```bash java -jar app.jar --spring.config.additional-location=file:/etc/app/config/ ``` - 通过`spring.config.location`完全替换默认路径: ```bash java -jar app.jar --spring.config.location=classpath:/default/ ``` --- ### 六、实际应用示例 **场景**:需要为生产环境覆盖端口和数据库配置 1. 创建`application-prod.yml`,内容为: ```yaml server: port: 8080 spring: datasource: url: jdbc:mysql://prod-db:3306/app ``` 2. 启动命令指定 Profile 和额外参数: ```bash java -jar app.jar --spring.profiles.active=prod --server.port=8081 ``` - 最终生效的`server.port`是`8081`(命令行参数优先级最高)。 --- ### 七、总结 Spring Boot 通过灵活的优先级规则实现配置的**分层管理**,开发者可通过以下方式控制配置: - **命令行参数**快速调试 - **Profile 专属文件**隔离环境配置 - **外部目录**适配容器化部署(如 Docker Volume) - **环境变量**兼容云原生场景(如 Kubernetes ConfigMap)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值