Java Spring Boot 正确读取配置文件中的属性的值


Posted in Java/Android onApril 20, 2022

前言

项目中经常会经常读取配置文件中的属性的值,Spring Boot提供了很多注解读取配置文件属性,那么如何正确使用呢?

Java 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 如何正确读取配置文件属性的文章就介绍到这了!

Java/Android 相关文章推荐
详解Java实践之抽象工厂模式
Jun 18 Java/Android
Spring Data JPA的Audit功能审计数据库的变更
Jun 26 Java/Android
Java中PriorityQueue实现最小堆和最大堆的用法
Jun 27 Java/Android
Java数据开发辅助工具Docker与普通程序使用方法
Sep 15 Java/Android
使用Spring处理x-www-form-urlencoded方式
Nov 02 Java/Android
Java实现给Word文件添加文字水印
Feb 15 Java/Android
Java生成日期时间存入Mysql数据库的实现方法
Mar 03 Java/Android
详细介绍Java中的CyclicBarrier
Apr 13 Java/Android
Java 死锁解决方案
May 11 Java/Android
多线程Spring通过@Scheduled实现定时任务
May 25 Java/Android
springboot实现string转json json里面带数组
Jun 16 Java/Android
向Spring IOC 容器动态注册bean实现方式
Jul 15 Java/Android
Elasticsearch Recovery 详细介绍
Apr 19 #Java/Android
Elasticsearch 配置详解
Apr 19 #Java/Android
引用计数法和root搜索算法以及JVM中判定对象需要回收的方法
解决springboot druid数据库连接失败后一直重连的方法
Apr 19 #Java/Android
Android自定义双向滑动控件
Apr 19 #Java/Android
java高级用法JNA强大的Memory和Pointer
Apr 19 #Java/Android
Java后端 Dubbo retries 超时重试机制的解决方案
Apr 14 #Java/Android
You might like
php 数据库字段复用的基本原理与示例
2011/07/22 PHP
php面象对象数据库操作类实例
2014/12/02 PHP
ThinkPHP连接数据库的方式汇总
2014/12/05 PHP
PHP读取汉字的点阵数据
2015/06/22 PHP
PHP序列化/对象注入漏洞分析
2016/04/18 PHP
PHPExcel 修改已存在Excel的方法
2018/05/03 PHP
读jQuery之十二 删除事件核心方法
2011/07/31 Javascript
修改js Calendar日历控件 兼容IE9/谷歌/火狐
2013/01/04 Javascript
JQuery事件e参数的方法preventDefault()取消默认行为
2013/09/26 Javascript
JS实现鼠标点击展开或隐藏表格行的方法
2015/03/03 Javascript
javascript关于运动的各种问题经典总结
2015/04/27 Javascript
jQuery Validate插件实现表单强大的验证功能
2015/12/18 Javascript
ion content 滚动到底部会遮住一部分视图的快速解决方法
2016/09/06 Javascript
Google 爬虫如何抓取 JavaScript 的内容
2017/04/07 Javascript
JS实现移动端判断上拉和下滑功能
2017/08/07 Javascript
微信小程序实现自定义modal弹窗封装的方法
2018/06/15 Javascript
vue用递归组件写树形控件的实例代码
2018/07/19 Javascript
Vue使用NPM方式搭建项目
2018/10/25 Javascript
微信小程序模板消息限制实现无限制主动推送的示例代码
2019/08/27 Javascript
Vue-CLI 3 scp2自动部署项目至服务器的方法
2020/07/24 Javascript
Python装饰器基础详解
2016/03/09 Python
python 通过字符串调用对象属性或方法的实例讲解
2018/04/21 Python
使用Python获取并处理IP的类型及格式方法
2018/11/01 Python
基于python if 判断选择结构的实例详解
2019/05/06 Python
python tkinter窗口最大化的实现
2019/07/15 Python
python argparse传入布尔参数false不生效的解决
2020/04/20 Python
全天然狗零食:Best Bully Sticks
2016/09/22 全球购物
开工庆典邀请函范文
2014/01/16 职场文书
人资专员岗位职责
2014/04/04 职场文书
高二学生评语大全
2014/04/25 职场文书
2014四风问题对照检查材料范文
2014/09/15 职场文书
党员自我剖析材料(群众路线)
2014/10/06 职场文书
海南召开党的群众路线教育实践活动总结大会新闻稿
2014/10/21 职场文书
公务员政审个人总结
2015/02/12 职场文书
学校德育工作总结2015
2015/05/11 职场文书
python 用递归实现通用爬虫解析器
2021/04/16 Python