spring boot中如何读取配置-mile米乐体育

spring boot中如何读取配置

这篇文章主要为大家展示了“spring boot中如何读取配置”，内容简而易懂，条理清晰，希望能够帮助大家解决疑惑，下面让小编带领大家一起研究并学习一下“spring boot中如何读取配置”这篇文章吧。

1 目的

本节我们要解决如下几个问题：

• 如何使用spring boot读取配置文件？有哪些方式？

• 常用的几种数据结构，如字符串、整数、list、map，如何配置？如何读取？

• 如何自定义配置文件的路径？

2 读配置文件

spring boot默认的配置文件有两种格式： application.properties 和 application.yml 。

查找顺序是首先从application.properties 查找，如果找不到，再查找 application.yml。

优先级：application.properties > application.yml 。

首先，添加依赖。

maven：

org.springframework.bootspring-boot-configuration-processortrue

gradle：

annotationprocessor'org.springframework.boot:spring-boot-configuration-processor'

2.1 使用@value 读取配置

配置如下：

erwin.name=冯文议erwin.age=20erwin.sex=男erwin.english-name=erwinfengerwin.birthday=1992/02/26erwin.like=movie,game,music,tea,travelerwin.visitedcities=巴中,揭阳,广州,从化,成都,三亚,上海,杭州,北京erwin.moreother={myweb:'https://fengwenyi.com',github:'https://github.com/fengwenyi'}

代码如下：

packagecom.fengwenyi.spring_boot_config_sample.config;importlombok.data;importorg.springframework.beans.factory.annotation.value;importorg.springframework.context.annotation.configuration;importjava.util.*;/***@authorerwinfeng*@since2020/8/11*/@data@configurationpublicclassreadconfigbyvalue{@value("${erwin.name}")privatestringname;@value("${erwin.age}")privateintegerage;@value("${erwin.sex}")privatestringsex;@value("${erwin.english-name}")privatestringenglishname;@value("${erwin.birthday}")privatedatebirthday;@value("${erwin.like}")privatelistlikes;@value("#{'${erwin.visitedcities}'.split(',')}")privatelistvisitedcities;@value("#{${erwin.moreother}}")privatemapmoreother;}

2.2 使用 @configurationproperties 读取配置

配置如下（properties格式）

author.name=冯文议author.age=20author.sex=男author.english-name=erwinfengauthor.birthday=1992/02/26author.like[0]=movieauthor.like[1]=gameauthor.like[2]=musicauthor.like[3]=teaauthor.like[4]=travelauthor.visitedcities=巴中,揭阳,广州,从化,成都,三亚,上海,杭州,北京author.moreother.myweb=https://fengwenyi.comauthor.moreother.github=https://github.com/fengwenyi

配置如下（yaml格式）

author:name:冯文议-ymlage:20sex:男english-name:erwinfengbirthday:1992/02/26like:-movie-game-music-tea-travelvisitedcities:巴中,揭阳,广州,从化,成都,三亚,上海,杭州,北京moreother:myweb:https://fengwenyi.comgithub:https://github.com/fengwenyi

代码如下：

packagecom.fengwenyi.spring_boot_config_sample.config;importcom.fasterxml.jackson.annotation.jsonformat;importlombok.data;importorg.springframework.boot.context.properties.configurationproperties;importorg.springframework.context.annotation.configuration;importjava.io.serializable;importjava.util.date;importjava.util.list;importjava.util.map;/***@authorerwinfeng*@since2020/8/12*/@data@configuration@configurationproperties(prefix="author")publicclassauthorconfigimplementsserializable{privatestaticfinallongserialversionuid=9032405467573421607l;privatestringname;privateintegerage;privatestringsex;privatestringenglishname;@jsonformat(pattern="yyyy/mm/dd")privatedatebirthday;privatelistlike;privatelistvisitedcities;privatemapmoreother;}

读取出来的数据展示：

{"name":"冯文议","age":20,"englishname":"erwinfeng","birthday":"1992/02/26","likes":["movie","game","music","tea","travel"],"visitedcities":["巴中","揭阳","广州","从化","成都","三亚","上海","杭州","北京"],"moreother":{"myweb":"https://fengwenyi.com","github":"https://github.com/fengwenyi"}}

2.3 通过注入环境变量来获取配置信息

@autowiredprivateenvironmentenvironment;

3 @value 用法

3.1 设置默认值

格式：@value("${name:defaultvalue}")

当配置文件找不到这个配置时，就会返回默认值，如果没有默认值，就会报错。

3.2 可以直接读取系统的属性值

如：@value("${java.home}")

d:\java\java8\jdk1.8.0_251\jre

3.3 可以用在方法和参数上，当做单元测试

//单元测试-读取配置文件的值@value("${erwin.like}")publicvoidtestreadlike(stringlike,@value("${erwin.sex}")stringsex){system.out.println("1===>" like);system.out.println("1===>" sex);}

参数 like 会取 @value("${erwin.like}") 的值 参数 sex 会取 @value("${erwin.sex}") 的值 经过测试，多个方法，执行顺序是随机。 特别注意：这个只是在启动的时候执行，但是实际调用的时候，还是传入的值。

3.4 读取list的值

方法一：配置文件：

erwin.like=movie,game,music,tea,travel

java代码：

@value("${erwin.like}") private list likes;

方法二：

erwin.visitedcities=巴中,揭阳,广州,从化,成都,三亚,上海,杭州,北京

java代码：

@value("#{'${erwin.visitedcities}'.split(',')}") private list visitedcities;

3.5 读取map的值

配置文件：

erwin.moreother={myweb:'https://fengwenyi.com',github:'https://github.com/fengwenyi'}

java代码：

@value("#{${erwin.moreother}}") private map moreother;

3.6 读取系统属性

@value("#{systemproperties}") private map systempropertiesmap;

3.7 给私有属性赋值

@component@propertysource("classpath:values.properties")publicclasspriorityprovider{privatestringpriority;@autowiredpublicpriorityprovider(@value("${priority:normal}")stringpriority){this.priority=priority;}//standardgetter}

4 @configurationproperties

packagecom.fengwenyi.spring_boot_config_sample.config;importcom.fengwenyi.spring_boot_config_sample.support.yamlpropertysourcefactory;importlombok.data;importorg.springframework.boot.context.properties.configurationproperties;importorg.springframework.context.annotation.configuration;importorg.springframework.context.annotation.propertysource;importjava.io.serializable;/***@authorerwinfeng*@since2020/8/13*/@data@configuration@configurationproperties(prefix="db")//@propertysource({"classpath:config/db.properties"})@propertysource(value={"classpath:config/db.yml"},factory=yamlpropertysourcefactory.class)publicclassdbconfigimplementsserializable{privatestaticfinallongserialversionuid=-6527591545525817929l;/**服务器地址*/privatestringhost;/**端口*/privateintegerport;/**数据库名*/privatestringdbname;/**用户名*/privatestringusername;/**密码*/privatestringpassword;}

配置文件：

db:host:localhostport:3306db-name:testusername:rootpassword:123456

说明： 1、@configuration 表明这是一个spring配置，会注入到spring容器中。 2、@configurationproperties(prefix = "db") 表示这个类与配置文件关联，其中prefix指明前缀。 3、@propertysource 这个指明配置文件的位置，如果没有这个配置，则会从默认的配置文件读取。默认的配置文件：application.properties > application.yml。另外，这个默认只支持properties类型的文件，所以，需要配置factory。 4、@propertysource也可以与@value结合使用。

yamlpropertysourcefactory

packagecom.fengwenyi.spring_boot_config_sample.support;importorg.springframework.boot.env.yamlpropertysourceloader;importorg.springframework.core.env.propertysource;importorg.springframework.core.io.support.encodedresource;importorg.springframework.core.io.support.propertysourcefactory;importjava.io.ioexception;/***@authorerwinfeng*@since2020/8/13*/publicclassyamlpropertysourcefactoryimplementspropertysourcefactory{@overridepublicpropertysourcecreatepropertysource(stringname,encodedresourceresource)throwsioexception{//返回yaml属性资源returnnewyamlpropertysourceloader().load(resource.getresource().getfilename(),resource.getresource()).get(0);}}

以上是“spring boot中如何读取配置”这篇文章的所有内容，感谢各位的阅读！相信大家都有了一定的了解，希望分享的内容对大家有所帮助，如果还想学习更多知识，欢迎关注恰卡编程网行业资讯频道！