Spring Boot 如何正确读取配置文件属性
前言
项目中经常会经常读取配置文件中的属性的值,Spring Boot提供了很多注解读取配置文件属性,那么如何正确使用呢?
@Value
@Value用来读取application.yml配置文件中属性的值。
示例代码
application.yml文件中属性:
//定义属性 fileName : test isFile : false filePath : c://test
@value读取application.yml属性值:
@Configuration public class FileConfig { @Value("${fileName}") private final String fileName; @Value("${isFile}") private boolean isFile; @Value("${filePath}") private static String filePath; }
测试:
@Autowired private FileConfig fileConfig; @GetMapping("getFileConfig") public void getFileConfig() { logger.info("fileConfig:{}",fileConfig); }
运行结果:
fileConfig:FileConfig [fileName=, isFile=false, filePath=null]
特别注意:
- @Value不能将属性值读取静态变量,否则读取的值为空。
- @Value不能将属性值读取常量,否则读取的值为空。
- @Value不能读取boolean类型的值,经过测试Spring Boot2.1的版本是无效的,2.2以上版本支持。
所以个人建议非必要情况,尽量少用@Value注解读取属性值。
@ConfigurationProperties
读取配置文件值并且转换成类对象,便于获取值和修改属性值。
示例代码
application.yml文件中属性:
http: pool: # 连接超时 connectTimeout: 5000 #获取连接池中连接超时 connectionRequestTimeout: 1000 #每个路由连接数量 defaultMaxPerRoute: 50 # /连接池中最大连接数 maxTotal: 50 # 服务器返回数据(response)的时间 socketTimeout: 5000 #定义不活动的时间(以毫秒为单位),连接回收 validateAfterInactivity: 30000
@ConfigurationProperties读取application.yml中以http.pool开头的属性值:
//以http.pool开头 @Component @ConfigurationProperties(prefix = "http.pool") public class HttpClientConfig implements Serializable { private static final long serialVersionUID = -4608251658338406043L; /** * 最大连接数 */ private Integer maxTotal; /** * 路由是对最大连接数的细分 * 每个路由基础的连接数 */ private Integer defaultMaxPerRoute; /** * 连接超时时间 */ private Integer connectTimeout; /** * 从连接池中获取连接的超时时间 */ private Integer connectionRequestTimeout; /** * 服务器返回数据(response)的时间 */ private Integer socketTimeout;
测试:
@GetMapping("getHttpClientConfig") public void getHttpClientConfig() { String json=FastJsonUtil.toJSONString(httpClientConfig); logger.info("fileConfig:{}",json); }
属性嵌套:
@ConfigurationProperties 可以嵌套List、map、class
config: url:http://localhsot:8080 gaode-map: host: https://restapi.amap.com/v3 key: 1234 @ConfigurationProperties(prefix="config") public class Config { //高德地图信息 private GaodeMap gaodeMap; }
特别注意:
- 默认情况不会将实体注入到spring的容器中,需要结合
@EnableConfigurationProperties
或者@Component
一起使用,否则注入对象为空。
@EnableConfigurationProperties
将@ConfigurationProperties
读取对象注入到spring容器中。例如上述示例也可以采用@EnableConfigurationProperties
来注入
@EnableConfigurationProperties(HttpClientConfig.class) public class FileController { private Logger logger = LoggerFactory.getLogger(FileController.class); @Autowired private FileConfig fileConfig; @GetMapping("getHttpClientConfig") public void getHttpClientConfig() { String json=FastJsonUtil.toJSONString(httpClientConfig); logger.info("fileConfig:{}",json); } }
@ConfigurationPropertiesScan
用来扫描@ConfigurationProperties
实体类并将类注入到Spring容器,上述示例可以如下使用
@ConfigurationPropertiesScan("com.xx.fw.config") public class FwCoreApplication { public static void main(String[] args) { SpringApplication.run(FwCoreApplication.class, args); } }
@PropertySource
@PropertySource 主要用于读取指定的配置文件,需要结合@ConfigurationProperties 注解一起使用实现配置文件和Java Bean的注入操作。
示例代码
属性文件user.properteis:
user.id=222 user.name=剑圣 user.age=28
实体类定义:
@Component @ConfigurationProperties(prefix = "user") @PropertySource(value = {"classpath:user.properties"}) public class UserConfig { private String id; private String name; private int age; }
测试:
@GetMapping("getUserConfig") public void getUserConfig() { String json=FastJsonUtil.toJSONString(userConfig); logger.info("userConfig:{}",json); }
输出结果:
c.s.fw.controller.FileController - userConfig:{"age":28,"id":"123","name":"admin"}
总结
重点讲解了通过各种注解读取配置文件种属性值,每种方式都是各自的优缺点,项目中一定要统一规范使用,便于项目维护和排查问题。
到此这篇关于Spring Boot 如何正确读取配置文件属性的文章就介绍到这了,更多相关Spring Boot 读取文件属性内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
原文出处:https://juejin.cn/post/7087962181924454413
相关文章
IntelliJ IDEA2021.1 配置大全(超详细教程)
这篇文章主要介绍了IntelliJ IDEA2021.1 配置大全(超详细教程),需要的朋友可以参考下...2021-04-18- VPN可以虚拟出一个专用网络,让远处的计算机和你相当于处在同一个局域网中,而中间的数据也可以实现加密传输,用处很大,特别是在一些大公司,分公司处在不同的区域。...2016-01-27
- 这篇文章主要介绍了Tomcat配置及如何在Eclipse中启动,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-02-04
- 如果我们需要安培Laravel4的话最php最低要求要在php5.3.7版本并且我们需要把mcrypt与openss这两个扩展开启才可以,具体步骤我们参考下文。 前面我们介绍我了 com...2016-11-25
- 这篇文章主要介绍了Spring AOP 对象内部方法间的嵌套调用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-08-29
- 这篇文章主要介绍了C#从数据库读取图片并保存的方法,帮助大家更好的理解和使用c#,感兴趣的朋友可以了解下...2021-01-16
解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题
这篇文章主要介绍了解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-04-28Spring Cloud 中@FeignClient注解中的contextId属性详解
这篇文章主要介绍了Spring Cloud 中@FeignClient注解中的contextId属性详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-25Springboot如何实现Web系统License授权认证
这篇文章主要介绍了Springboot如何实现Web系统License授权认证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-05-28- 这篇文章主要为大家详细介绍了SpringBoot实现excel文件生成和下载,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-02-09
- 在php中解析xml文档用专门的函数domdocument来处理,把json在php中也有相关的处理函数,我们要把数据xml 数据存到一个数据再用json_encode直接换成json数据就OK了。...2016-11-25
详解Maven profile配置管理及激活profile的几种方式
这篇文章主要介绍了详解Maven profile配置管理及激活profile的几种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-26如何在Spring WebFlux的任何地方获取Request对象
这篇文章主要介绍了如何在Spring WebFlux的任何地方获取Request对象,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下...2021-01-26- 这篇文章主要介绍了详解springBoot启动时找不到或无法加载主类解决办法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
- 这篇文章主要介绍了详解SpringCloudGateway内存泄漏问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-07-16
- 这篇文章主要介绍了SpringBoot集成Redis实现消息队列的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-10
- 这篇文章主要介绍了IDEA如何添加配置文件到classpath中,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 通常php.ini的位置在:复制代码 代码如下:/etc目录下或/usr/local/lib目录下。如果你还是找不到php.ini或者找到了php.ini修改后不生效(其实是没找对),请使用如下办法:1.新建php文件,写入如下代码复制代码 代码如下:<?phpe...2014-05-31
- 以下就是部署PHP时的4个配置修改说明,大家一个一个进行学习研究。1、short_open_tag 是什么呢? 决定是否允许使用代码开始标志的缩写形式(<? ?> )。如果要和 XML 结合使用PHP,可以禁用此选项以便于嵌入使用<?x...2015-10-21
- 这篇文章主要介绍了解决Springboot get请求是参数过长的情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-17