首页 > 代码库 > Hutool之Properties替代——Setting

Hutool之Properties替代——Setting

2024-07-17 22:38:37   217人阅读

前言

对于JDK自带的Properties读取的Properties文件，对我们来说有很多限制，首先是ISO8859-1编码导致没法加中文的value和注释（用日本的那个插件在Eclipse里可以读写，放到服务器上读就费劲了），再就是不支持变量分组等功能，因此有了Setting类。

由来

配置文件中使用变量这个需求由来已久，在Spring中PropertyPlaceholderConfigurer类就用于在ApplicationContext.xml中使用Properties文件中的变量替换。
分组的概念我第一次在Linux的rsync的/etc/rsyncd.conf配置文件中有所了解，发现特别实用具体大家可以百度。

而这两种功能后来我在jodd的Props才有所发现，它的这个配置文件扩展类十分强大，甚至支持多行等等功能，本来想直接使用，避免重复造轮子，可是发现很多特性我完全用不到，而且没有我需要的便捷功能，于是我便造了Setting这个轮子。

配置文件格式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${driver}
#密码，必须，如果密码为空，请填写 pass = 
pass = 123456

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

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

代码

代码具体请见com.xiaoleilu.hutool.demo.SettingDemo

package com.xiaoleilu.hutool.demo;

import java.io.IOException;

import com.xiaoleilu.hutool.CharsetUtil;
import com.xiaoleilu.hutool.FileUtil;
import com.xiaoleilu.hutool.Setting;

/**
 * Setting演示样例类
 * @author Looly
 *
 */
public class SettingDemo {
    public static void main(String[] args) throws IOException {
        //--------------------------------------------- 初始化
        //读取classpath下的XXX.setting，不使用变量
        Setting setting = new Setting("XXX.setting");

        //读取classpath下的config目录下的XXX.setting，不使用变量
        setting = new Setting("config/XXX.setting");

        //读取绝对路径文件/home/looly/XXX.setting（没有就创建，关于touch请查阅FileUtil）
        //第二个参数为自定义的编码，请保持与Setting文件的编码一致
        //第三个参数为是否使用变量，如果为true，则配置文件中的每个key都可以被之后的条目中的value引用形式为 ${key}
        setting = new Setting(FileUtil.touch("/home/looly/XXX.setting"), CharsetUtil.UTF_8, true);

        //读取与SettingDemo.class文件同包下的XXX.setting
        setting = new Setting("XXX.setting", SettingDemo.class, CharsetUtil.UTF_8, true);

        //--------------------------------------------- 使用
        //获取key为name的值
        setting.getString("name");
        //获取分组为group下key为name的值
        setting.getString("name", "group1");
        //当获取的值为空（null或者空白字符时，包括多个空格），返回默认值
        setting.getStringWithDefault("name", "默认值");
        //完整的带有key、分组和默认值的获得值得方法
        setting.getStringWithDefault("name", "group1", "默认值");

        //如果想获得其它类型的值，可以调用相应的getXXX方法，参数相似

        //有时候需要在key对应value不存在的时候（没有这项设置的时候）告知用户，故有此方法打印一个debug日志
        setting.getWithLog("name");
        setting.getWithLog("name", "group1");

        //重新读取配置文件，可以启用一个定时器调用此方法来定时更新配置
        setting.reload();

        //当通过代码加入新的键值对的时候，调用store会保存到文件，但是会覆盖原来的文件，并丢失注释
        setting.setSetting("name1", "value");
        setting.store("/home/looly/XXX.setting");

        //获得所有分组名
        setting.getGroups();

        //将key-value映射为对象，原理是原理是调用对象对应的setXX方法
        //setting.toObject();

        //设定变量名的正则表达式。
        //Setting的变量替换是通过正则查找替换的，如果Setting中的变量名和其他冲突，可以改变变量的定义方式
        //整个正则匹配变量名，分组1匹配key的名字
        setting.setVarRegex("\\$\\{(.*?)\\}");
    }
}

对Properties的简单封装Props(版本2.0.0开始提供)

对于Properties的广泛使用使我也无能为力，有时候遇到Properties文件又想方便的读写也不容易，于是对Properties做了简单的封装，提供了方便的构造方法（与Setting一致），并提供了与Setting一致的getXXX方法来扩展Properties类，Props类继承自Properties，所以可以兼容Properties类，具体不再做介绍，有兴趣可以看下com.xiaoleilu.hutool.Props


联系
我们