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输出Hello World完美过程解析
Jun 13 Java/Android
Spring Data JPA的Audit功能审计数据库的变更
Jun 26 Java/Android
解决SpringBoot跨域的三种方式
Jun 26 Java/Android
浅谈resultMap的用法及关联结果集映射
Jun 30 Java/Android
JavaWeb 入门:Hello Servlet
Jul 16 Java/Android
Java 在生活中的 10 大应用
Nov 02 Java/Android
Java字符缓冲流BufferedWriter
Apr 09 Java/Android
Java实现扫雷游戏详细代码讲解
May 25 Java/Android
Android开发EditText禁止输入监听及InputFilter字符过滤
Jun 10 Java/Android
Java实现HTML转为Word的示例代码
Jun 28 Java/Android
MyBatis XPathParser解析器使用范例详解
Jul 15 Java/Android
HttpClient实现表单提交上传文件
Aug 14 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
关于查看MSSQL 数据库 用户每个表 占用的空间大小
2013/06/21 PHP
php初始化对象和析构函数的简单实例
2014/03/11 PHP
PHP实现基于mysqli的Model基类完整实例
2016/04/08 PHP
Thinkphp3.2简单解决多文件上传只上传一张的问题
2017/09/26 PHP
PHP获取ttf格式文件字体名的方法示例
2019/03/06 PHP
网站被黑的假象--ARP欺骗之页面中加入一段js
2007/05/16 Javascript
Javascript学习笔记1 数据类型
2010/01/11 Javascript
JavaScript中switch判断容易犯错的一个细节
2014/08/27 Javascript
Css3制作变形与动画效果
2015/07/24 Javascript
JS基于clipBoard.js插件实现剪切、复制、粘贴
2016/05/03 Javascript
移动端点击图片放大特效PhotoSwipe.js插件实现
2016/08/25 Javascript
jQuery Easyui加载表格出错时在表格中间显示自定义的提示内容
2016/12/08 Javascript
js实现tab选项卡切换功能
2017/01/13 Javascript
Ionic 2 实现列表滑动删除按钮的方法
2017/01/22 Javascript
JavaScript原生数组Array常用方法
2017/04/06 Javascript
详解vue2.0的Element UI的表格table列时间戳格式化
2017/06/13 Javascript
解决webpack+Vue引入iView找不到字体文件的问题
2018/09/28 Javascript
vue elementUI 表单校验功能之数组多层嵌套
2019/06/04 Javascript
[05:06]2017亚洲邀请赛DAC回顾片
2017/04/19 DOTA
[01:06:26]全国守擂赛第二周 Team Coach vs DeMonsTer
2020/04/28 DOTA
python线程池的实现实例
2013/11/18 Python
举例详解Python中threading模块的几个常用方法
2015/06/18 Python
Python访问纯真IP数据库脚本分享
2015/06/29 Python
78行Python代码实现现微信撤回消息功能
2018/07/26 Python
详解Python Opencv和PIL读取图像文件的差别
2019/12/27 Python
使用 Python 遍历目录树的方法
2020/02/29 Python
Mio Skincare法国官网:身体紧致及孕期身体护理
2018/04/04 全球购物
KENZO官网:高田贤三在法国创立的品牌
2019/05/16 全球购物
Orlebar Brown官网:设计师泳裤和泳装
2020/12/08 全球购物
团员个人的自我评价
2013/12/02 职场文书
农村面貌改造提升实施方案
2014/03/18 职场文书
初三新学期计划书
2014/05/03 职场文书
学校学习雷锋活动总结
2014/07/03 职场文书
2015年小学师德师风建设工作总结
2015/10/23 职场文书
信息技术研修心得体会
2016/01/08 职场文书
java调用Restful接口的三种方法
2021/08/23 Java/Android