设置文件-Setting

简介

Setting除了兼容Properties文件格式外,还提供了一些特有功能,这些功能包括:

  • 各种编码方式支持
  • 变量支持
  • 分组支持

首先说编码支持,在Properties中,只支ISO8859-1导致在Properties文件中注释和value没法使用中文,(用日本的那个插件在Eclipse里可以读写,放到服务器上读就费劲了),因此Setting中引入自定义编码,可以很好的支持各种编码的配置文件。

再就是变量支持,在Setting中,支持${key}变量,可以将之前定义的键对应的值做为本条值得一部分,这个特性可以减少大量的配置文件冗余。

最后是分组支持。分组的概念我第一次在Linux的rsync的/etc/rsyncd.conf配置文件中有所了解,发现特别实用,具体大家可以自行百度之。当然,在Windows的ini文件中也有分组的概念,Setting将这一概念引入,从而大大增加配置文件的可读性。

配置文件格式example.setting

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

配置文件可以放在任意位置,具体Setting类如何寻在在构造方法中提供了多种读取方式,具体稍后介绍。现在说下配置文件的具体格式 Setting配置文件类似于Properties文件,规则如下:

  1. 注释用#开头表示,只支持单行注释,空行和无法正常被识别的键值对也会被忽略,可作为注释,但是建议显式指定注释。同时在value之后不允许有注释,会被当作value的一部分。
  2. 键值对使用key = value 表示,key和value在读取时会trim掉空格,所以不用担心空格。
  3. 分组为中括号括起来的内容(例如配置文件中的[demo]),中括号以下的行都为此分组的内容,无分组相当于空字符分组,即[]。若某个keyname,分组是group,加上分组后的key相当于group.name。
  4. 支持变量,默认变量命名为 ${变量名},变量只能识别读入行的变量,例如第6行的变量在第三行无法读取,例如配置文件中的${driver}会被替换为com.mysql.jdbc.Driver,为了性能,Setting创建的时候构造方法会指定是否开启变量替换,默认不开启。

代码

代码具体请见cn.hutool.setting.test.SettingTest

  1. Setting初始化
  1. //读取classpath下的XXX.setting,不使用变量
  2. Setting setting = new Setting("XXX.setting");
  3. //读取classpath下的config目录下的XXX.setting,不使用变量
  4. setting = new Setting("config/XXX.setting");
  5. //读取绝对路径文件/home/looly/XXX.setting(没有就创建,关于touc请查阅FileUtil)
  6. //第二个参数为自定义的编码,请保持与Setting文件的编码一致
  7. //第三个参数为是否使用变量,如果为true,则配置文件中的每个key都以被之后的条目中的value引用形式为 ${key}
  8. setting = new Setting(FileUtil.touc("/home/looly/XXX.setting"), CharsetUtil.CHARSET_UTF_8, true);
  9. //读取与SettingDemo.class文件同包下的XXX.setting
  10. setting = new Setting("XXX.setting", SettingDemo.class,CharsetUtil.CHARSET_UTF_8, true);
  1. Setting读取配置参数
  1. //获取key为name的值
  2. setting.getStr("name");
  3. //获取分组为group下key为name的值
  4. setting.getByGroup("name", "group1");
  5. //当获取的值为空(null或者空白字符时,包括多个空格),返回默认值
  6. setting.getStr("name", "默认值");
  7. //完整的带有key、分组和默认值的获得值得方法
  8. setting.getStr("name", "group1", "默认值");
  9. //如果想获得其它类型的值,可以调用相应的getXXX方法,参数相似
  10. //有时候需要在key对应value不存在的时候(没有这项设置的时候)告知户,故有此方法打印一个debug日志
  11. setting.getWithLog("name");
  12. setting.getByGroupWithLog("name", "group1");
  13. //获取分组下所有配置键值对,组成新的Setting
  14. setting.getSetting("group1")
  1. 重新加载配置和保存配置
  1. //重新读取配置文件
  2. setting.reload();
  3. //在配置文件变更时自动加载
  4. setting.autoLoad(true);
  5. //当通过代码加入新的键值对的时候,调用store会保存到文件,但是会盖原来的文件,并丢失注释
  6. setting.set("name1", "value");
  7. setting.store("/home/looly/XXX.setting");
  8. //获得所有分组名
  9. setting.getGroups();
  10. //将key-value映射为对象,原理是原理是调用对象对应的setXX方法
  11. UserVO userVo = new UserVo();
  12. setting.toBean(userVo);
  13. //设定变量名的正则表达式。
  14. //Setting的变量替换是通过正则查找替换的,如果Setting中的变量名其他冲突,可以改变变量的定义方式
  15. //整个正则匹配变量名,分组1匹配key的名字
  16. setting.setVarRegex("\\$\\{(.*?)\\}");