SpringBoot(3)—配置文件详解:Properties和YAML

一、配置文件优先级加载机制

  SpringBoot项目启动会扫描以下位置的application.properties或者application.yml作为默认的配置文件

    1、工程根目录:./config/

    2、工程根目录:./

    3、classpath:/config/

    4、classpath:/

  加载的优先级顺序是从上向下加载,并且所有的文件都会被加载,高优先级的内容会覆盖低优先级的内容,形成互补配置

  PS:不过需要注意的是在工程根路径下或者根路径的config下面的配置文件,在工程打包时候不会被打包进去(这也可能和项目级别有关系,Module级别与IDEA中Project级别的,待验证,未实操)。  

  我们可以从ConfigFileApplicationListener这类便可看出,其中DEFAULT_SEARCH_LOCATIONS属性设置了加载的目录:

private static final String DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/";

  接着getSearchLocations方法中去逗号解析成Set,其中内部类Loader负责这一配置文件的加载过程,包括加载profile指定环境的配置,以application+’-’+name格式的拼接加载。

  (1)我们也可以通过制定配置spring.config.location来改变默认配置,一般在项目已经打包后,我们可以通过以下指令来加载外部的配置 

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=D:/application.properties

  (2)另外也可以通过命令行参数进行配置

    (a)所有的配置都可以在命令行上进行指定

    (b)多个配置用空格分开;--配置项=值

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar
--server.port=8087 --server.context-path=/abc

  (3)以下优先级从高到低加载顺序:

    (a)命令行参数

    (b)来自java:comp/env的JNDI属性

    (c)Java系统属性(System.getProperties())

    (d)操作系统环境变量

    (e)RandomValuePropertySource配置的random.*属性值

    (f)jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

    (g)jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

    (h)jar包外部的application.properties或application.yml(不带spring.profile)配置文件

    (i)jar包内部的application.properties或application.yml(不带spring.profile)配置文件

      备注:由jar包外想jar包内进行寻找,优先加载带profile的,再加载不带profile的

    (j)@Configuration注解类上的@PropertySource

    (k)通过SpringApplication.setDefaultProperties指定的默认属性

二、properties配置优先级>YAML配置优先级

  SpringBoot使用一个以application命名的配置文件作为默认的全局配置文件。支持properties后缀结尾的配置文件或者以yml/yaml后缀结尾的YAML的文件配置。
以设置应用端口为例
  properties文件示例(application.properties):

server.port=80

  YAML文件示例(application.yml):

server:
  port: 80

  备注:在同一目录下,properties配置优先级 > YAML配置优先级。//所以我们在jar包启动时带上properties写法的配置可以覆盖配置。

  yml类型的写法:冒号后要加个空格  

三、@PropertySource和@ImportResource

  通常情况下我们将配置配置在application开头的主配置文件中,这样随着项目的增大配置项的增多会使文件变得非常臃肿,其实SpringBoot早已考虑到了该问题,SpringBoot提供了**@PropertySource和@ImportResource**两个注解用于加载外部配置文件使用。

  • @PropertySource通常用于属性加载配置文件,注意@PropertySource注解不支持加载yaml文件,支持properties文件。
  • @ImportResource通常用于加载Spring的xml配置文件

  1、@propertySource使用

    (1)装配properties配置文件

    在sources/config下创建一个yaml文件命名为user.properties内容与上方user的配置一样

    

@PropertySource(value = {"classpath:config/user.properties"})
@Component
@ConfigurationProperties(prefix = "user")
public class Login{
private String username;
private String password;
...
}

    (2)、同时加载多个配置问题

  细心的你,会发现@PropertySource注解中属性value为一个数组,如果同时加载多个配置文件,并且不同配置文件中对同一个属性设置了不同的值,那么Spring会识别哪一个呢?

带着疑问,我们可以通过控制变量法进行测试,具体过程再在赘述。

@PropertySource(value = {"classpath:config/user1.properties","classpath:config/user2.properties"})

  结论:Spring加载顺序为从左到右顺序加载,后加载的会覆盖先加载的属性值。

    (3)配yaml配置文件

  如果你有强迫症,一定想加载yaml配置文件,那么可以通过PropertySourcesPlaceholderConfigurer类来加载yaml文件,将原来的user.properties改成user.yaml,Bean配置类中加入如下代码,Login配置类和一开始的方式一致。

@Bean
public static PropertySourcesPlaceholderConfigurer loadProperties() {
    PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
    YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
    //yaml.setResources(new FileSystemResource("classpath:config/user.yml"));//File路径引入
    yaml.setResources(new ClassPathResource("config/user.yml"));//class路径引入
    configurer.setProperties(yaml.getObject());
    return configurer;
}

  运行一下,仍然可以能达到加载配置效果的。

  2、@ImportResource使用

  SpringBoot提出零xml的配置,因此SpringBoot默认情况下是不会主动识别项目中Spring的xml配置文件。为了能够加载xml的配置文件,SpringBoot提供了@ImportResource注解该注解可以加载Spring的xml配置文件,通常加于启动类上。

@ImportResource(value = {"classpath:/beans.xml"})
@SpringBootApplication(scanBasePackages = {"team.seagull.client"})
public class DeployApplication {
    public static void main(String[] args) {
        SpringApplication.run(DeployApplication.class, args);
    }
}

  

四、一般配置文件方案参考

  我在自己的springboot项目中使用了多个配置文件,

  application.properties是主配置文件,放一些项目通用的配置;

  application-dev.properties 放的是平常开发的一些配置,比如说数据库的连接地址、帐号密码等;

  application-prod.properties 放的是生产环境的一些配置,比如说数据库的连接地址、帐号密码等。

  当然也可以再多一个application-test.properties ,放一些测试环境需要用到的参数。

  

  可以通过在application.properties 中设置spring.profiles.active=prod或者dev来使用application-dev.properties或者application-prod.properties文件,当然test文件也是同理。

原文地址:https://www.cnblogs.com/javahr/p/12611617.html

时间: 2024-10-16 21:52:11

SpringBoot(3)—配置文件详解:Properties和YAML的相关文章

Spring Boot系列教程四:配置文件详解properties

一.配置随机数,使用随机数 在application.properties文件添加配置信息 1 #32位随机数 2 woniu.secret=${random.value} 3 #随机整数 4 woniu.number=${random.int} 5 #指定范围随机数 6 woniu.limitnumber=${random.int[0,9]} controller类中使用这些随机数 1 package com.woniu.controller; 2 3 import java.util.Has

Spring Boot2 系列教程 (五) | yaml 配置文件详解

自定义属性加载 首先构建 SpringBoot 项目,不会的看这篇旧文 使用 IDEA 构建 Spring Boot 工程. 首先在项目根目录 src >> resource >>?application.properties 文件下加入以下自定义属性: # 防止读取乱码 spring.http.encoding.charset=UTF-8 # 项目启动端口 server.port=9999 # 自定义配置 com.nasus.author.name=一个优秀的废人 com.nas

Hibernate3 Api,配置文件详解

1 api详解[多练] 1.1 体系结构 PO:persistent object ,用于与数据库交互数据.--dao层  (JavaBean + hbm ) BO:Business object 业务数据对象.--service层 VO:Value Object 值对象.--web层 开发中:直接使用JavaBean 描述三个对象. 1.2 Configuration 配置对象 l hibernate 核心配置文件种类 hibernate.cfg.xml 通常使用xml配置文件,可以配置内容更

Java学习-007-Log4J 日志记录配置文件详解及实例源代码

此文主要讲述在初学 Java 时,常用的 Log4J 日志记录配置文件详解及实例源代码整理.希望能对初学 Java 编程的亲们有所帮助.若有不足之处,敬请大神指正,不胜感激!源代码测试通过日期为:2015-1-30 13:54:02,请知悉. 所需的 jar 包下载链接为:http://yunpan.cn/cKE56sxqtQCfP  访问密码 63d8 有关 Log4J 日志文件中日志级别及文件配置的详细情况,在 Log4J 的配置文件(xml.properties)中有详细的介绍,敬请参阅!

spring boot 1.5.4 配置文件详解(八)

上一篇:spring boot 1.5.4 集成spring-Data-JPA(七) 1      Spring Boot配置文件详解 相信很多人选择Spring Boot主要是考虑到它既能兼顾Spring的强大功能,还能实现快速开发的便捷.我们在Spring Boot使用过程中,最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容,替代它的是在pom.xml中引入模块化的Starter POMs,其中各个模块都有自己的默认配置,所以如果不是特殊应用场景,就只需要在appli

Maven的pom.xml配置文件详解

1 Maven的pom.xml配置文件详解 2 Maven简述 3 Maven项目对象模型(POM),可以通过一小段描述信息来管理项目的构建,报告和文档的软件项目管理工具. 4 Maven 除了以程序构建能力为特色之外,还提供高级项目管理工具.由于 Maven 的缺省构建规则有较高的可重用性,所以常常用两三行 Maven 构建脚本就可以构建简单的项目.由于 Maven 的面向项目的方法,许多 Apache Jakarta 项目发文时使用 Maven,而且公司项目采用 Maven 的比例在持续增长

Maven之pom.xml配置文件详解

Maven之pom.xml配置文件详解 2019-06-05 一.什么是pom? POM是项目对象模型(Project Object Model)的简称,它是Maven项目中的文件,使用XML表示,名称叫做pom.xml.作用类似ant的build.xml文件,功能更强大.该文件用于管理:源代码.配置文件.开发者的信息和角色.问题追踪系统.组织信息.项目授权.项目的url.项目的依赖关系等等.事实上,在Maven世界中,project可以什么都没有,甚至没有代码,但是必须包含pom.xml文件.

Docker Compose 配置文件详解

Docker Compose 配置文件详解 左蓝关注 72017.01.19 23:25:09字数 2,827阅读 144,706 先来看一份 docker-compose.yml 文件,不用管这是干嘛的,只是有个格式方便后文解说: version: '2' services: web: image: dockercloud/hello-world ports: - 8080 networks: - front-tier - back-tier redis: image: redis links

监控服务 - Nagios配置文件详解

一.Nagios的配置文件类型: Nagios安装后有四种默认的配置文件:主配置文件.CGI配置文件.资源定义文件.对象定义文件.这些配置文件间具有一些关系,只有充分理解各配置文件,才能使得配置Nagios服务如行云流水. 二.Nagios配置文件详解: 1.主配置文件(nagios.cfg): Nagios的主配置文件是用来定义Nagios服务的基本参数信息的,其中包括:对象定义文件的声明.CGI配置文件的声明.资源定义文件的声明等.其常用参数如下: log_file=/usr/local/n

Hadoop1.2.1 配置文件详解

首先我们先回顾一下Hadoop的一些概念: Apache Hdoop 1.x 组成 NameNode(元数据服务器) Secondary NameNode(辅助元数据服务器) JobTracker(任务调度员) DataNodes(块存储) TaskTrackers(任务执行) HDFS文件系统 NameNoode:属于管理层,用于管理数据存储 SecondaryNameNode:也属于管理层,辅助NameNode进行管理 DataNode:属于应用层,用户进行数据的存储,被NameNode进行