Hutool学习 —— 设置文件-Setting

Hutool 官网:https://www.hutool.cn
官方参考文档:https://www.hutool.cn/docs
本节内容对应官方文档位置:设置文件-Setting (hutool.cn)
Hutool 版本:5.7.1

特点

  1. setting兼容properties文件格式
  2. 支持各类编码方式(注释和value可用中文)
  3. 支持变量${key},减少配置文件冗余
  4. 支持分组[group],增加配置文件可读性

配置格式

官方配置文件格式example.setting

# -------------------------------------------------------------
# ----- Setting File with UTF8-----
# ----- 数据库配置文件 -----
# -------------------------------------------------------------

#中括表示一个分组,其下面的所有属性归属于这个分组,在此分组名为demo,也可以没有分组
[demo]
#自定义数据源设置文件,这个文件会针对当前分组生效,用于给当前分组配置单独的数据库连接池参数,没有则使用全局的配置
ds.setting.path = config/other.setting
#数据库驱动名,如果不指定,则会根据url自动判定
driver = com.mysql.jdbc.Driver
#JDBC url,必须
url = jdbc:mysql://fedora.vmware:3306/extractor
#用户名,必须
user = root${demo.driver}
#密码,必须,如果密码为空,请填写 pass = 
pass = 123456

规则:

  1. 只支持单行注释#这是一个注释,value后不能添加注释,如driver = com.mysql.jdbc.Driver #这个注释是value的一部分,获取driver的value为:com.mysql.jdbc.Driver #这个注释是value的一部分
  2. 键值表示方式:key = value,例如pass = 123456,key和value之间空格会被trim掉
  3. 分组表示方式:[group],例如:[demo]
  4. 变量表示方式:${变量名},例如:user = root${demo.driver}变量只能识别读入行的变量,例如第6行的变量在第三行无法读取,变量默认不开启,需要在初始化时指定

应用

  1. Setting初始化
    Setting setting = new Setting(path,class,code,isVariable)
    path: path/xxx.setting可以在任何位置,默认是相对路径,在项目的classes文件夹下,必填
    class:xxx.class,默认相对路径改为与xxx.class文件同包下,选填
    code:CharsetUtil.xxx,文件编码(Hutool字符集工具类),选填
    isVariable:true\false,是否开启变量,默认为false,选填
  2. Setting读取配置参数
    setting.getStr(key)获取默认无分组下key的value,出现相同key取最后一行的key
    setting.getByGroup(key, group)获取group下key的value,出现相同key取最后一行的key
    setting.getStr(key, 默认值)获取默认无分组下key的value,若不存在key时,返回默认值
    setting.getStr(key, group, 默认值)获取group下key的value,若不存在key时,返回默认值
    setting.getWithLog(key);获取默认无分组下key的value,若不存在key,则打印debug日志No key define for [key]
    setting.getByGroupWithLog(key, group);获取group下key的value,若不存在key,则打印debug日志No key define for [key]
    setting.getSetting(group)获取group下所有配置键值对,组成新的Setting
  3. 重新加载配置和保存配置
    setting.reload()重新读取配置文件
    setting.autoLoad(true)在配置文件变更时自动加载
    setting.getGroups()获得所有分组名
    setting.setVarRegex(正则表达式)设定变量名的正则表达式,Setting的变量替换是通过正则查找替换的,如果Setting中的变量名其他冲突,可以改变变量的定义方式
    setting.toBean(bean)将key-value映射为对象,原理是原理是调用对象对应的setXX方法
    setting.set(key, group,value) 添加\更改key对应的value,group可不填,不填则默认为无分组配置参数
    setting.store()保存设置到文件

例子:

在classes\config下新建一个test.setting文件

#默认无分组
name = abc
sex = woman
age = ${group1.sex}
name = 张三
abc = 

#这是注释
[group1]
name = zhang 3 #这是value一部分
sex = man
age = 18

[group2]
title = welcome ${group1.name}
content = ${group1.sex}

# 下面还是group2的内容
name = hello

测试代码

//不开启变量
 Setting setting = new Setting("config/test.setting");
//开启变量
 Setting setting2 = new Setting("config/test.setting",true);

//返回:张三
setting.getStr("name")
//返回:${group1.age},因为读取不了后面的数据
setting2.getStr("age")

//返回:welcome ${group1.name}
setting.getByGroup("title","group2")
//返回:welcome zhang 3 #这是value一部分
setting2.getByGroup("title","group2")

//返回:
setting.getStr("abc","haha")
//返回:haha
setting.getStr("dd","haha")

//返回:null ,打印 DEBUG cn.hutool.setting.AbsSetting - No key define for [dd]!
setting.getWithLog("dd")

//返回:man
setting2.getSetting("group2").getStr("content")
//返回:null
setting2.getSetting("group2").getByGroup("name","group1")

//返回:hello
setting.set("name", "hello")
setting.getStr("name")
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容