Spring Boot中如何读取配置

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：

<!--springbootconfig--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency>

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}")privateList<String>likes;@Value("#{'${erwin.visitedCities}'.split(',')}")privateList<String>visitedCities;@Value("#{${erwin.moreOther}}")privateMap<String,String>moreOther;}

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

<br />代码如下：

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;privateList<String>like;privateList<String>visitedCities;privateMap<String,String>moreOther;}

读取出来的数据展示：

{"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<String> likes;

方法二：

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

Java代码：

@Value("#{'${erwin.visitedCities}'.split(',')}") private List<String> visitedCities;

3.5 读取Map的值

配置文件：

erwin.moreOther={myWeb:'https://fengwenyi.com',github:'https://github.com/fengwenyi'}

Java代码：

@Value("#{${erwin.moreOther}}") private Map<String, String> moreOther;

3.6 读取系统属性

@Value("#{systemProperties}") private Map<String, String> 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{@OverridepublicPropertySource<?>createPropertySource(Stringname,EncodedResourceresource)throwsIOException{//返回yaml属性资源returnnewYamlPropertySourceLoader().load(resource.getResource().getFilename(),resource.getResource()).get(0);}}

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