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 相关文章推荐
mybatis中注解与xml配置的对应关系和对比分析
Aug 04 Java/Android
聊聊Lombok中的@Builder注解使用教程
Nov 17 Java/Android
OpenCV实现普通阈值
Nov 17 Java/Android
SSM项目使用拦截器实现登录验证功能
Jan 22 Java/Android
SpringBoot中使用Redis作为全局锁示例过程
Mar 24 Java/Android
Spring事务管理下synchronized锁失效问题的解决方法
Mar 31 Java/Android
SpringBoot 集成短信和邮件 以阿里云短信服务为例
Apr 22 Java/Android
Mybatis-Plus 使用 @TableField 自动填充日期
Apr 26 Java/Android
详解Android中的TimePickerView(时间选择器)的用法
Apr 30 Java/Android
JavaScript正则表达式实现注册信息校验功能
May 30 Java/Android
IDEA中sout快捷键无效问题的解决方法
Jul 23 Java/Android
Java Redisson多策略注解限流
Sep 23 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
网站当前的在线人数
2006/10/09 PHP
PHP中使用glob函数实现一句话删除某个目录下的所有文件
2014/07/22 PHP
用php代码限制国内IP访问我们网站
2015/09/26 PHP
分享50个提高PHP执行效率的技巧
2015/12/26 PHP
PHP安装GeoIP扩展根据IP获取地理位置及计算距离的方法
2016/07/01 PHP
php插入mysql数据返回id的方法
2018/05/31 PHP
jQuery 中关于CSS操作部分使用说明
2007/06/10 Javascript
js css样式操作代码(批量操作)
2009/10/09 Javascript
Jsonp 跨域的原理以及Jquery的解决方案
2010/05/18 Javascript
jquery+ajax每秒向后台发送请求数据然后返回页面的代码
2011/01/17 Javascript
js bind 函数 使用闭包保存执行上下文
2011/12/26 Javascript
fancybox modal的完美解决(右上的X)
2012/10/30 Javascript
jquery实现两个图片渐变切换效果的方法
2015/06/25 Javascript
学习JavaScript设计模式之享元模式
2016/01/18 Javascript
javascript的正则匹配方法学习
2016/02/24 Javascript
javascript跨域请求包装函数与用法示例
2016/11/03 Javascript
Three.js获取鼠标点击的三维坐标示例代码
2017/03/24 Javascript
webpack打包后直接访问页面图片路径错误的解决方法
2017/06/17 Javascript
浅谈Webpack 是如何加载模块的
2018/05/24 Javascript
Vue仿支付宝支付功能
2018/05/25 Javascript
详解VUE项目中安装和使用vant组件
2019/04/28 Javascript
Vue+Spring Boot简单用户登录(附Demo)
2020/11/12 Javascript
Python基于dom操作xml数据的方法示例
2018/05/12 Python
python for循环输入一个矩阵的实例
2018/11/14 Python
在python image 中安装中文字体的实现方法
2019/08/22 Python
Tensorflow实现部分参数梯度更新操作
2020/01/23 Python
Python3+Selenium+Chrome实现自动填写WPS表单
2020/02/12 Python
python图片合成的示例
2020/11/09 Python
Python将list元素转存为CSV文件的实现
2020/11/16 Python
Html5页面内使用JSON动画的实现
2019/01/29 HTML / CSS
英国电子产品购物网站:Tech in the basket
2019/11/08 全球购物
Eclipse面试题
2014/03/22 面试题
行政人员工作职责
2013/12/05 职场文书
商务日语专业的自荐信
2014/05/23 职场文书
督导岗位职责
2015/02/04 职场文书
网络研修心得体会
2016/01/08 职场文书