Hutool - Setting：功能更强大的 Setting 配置文件和 Properties 封装

一、简介

在 Java 开发中，配置文件是管理项目配置信息的重要手段，常见的配置文件格式有 .properties 文件。然而，传统的 Properties 类在处理配置信息时功能相对有限，例如不支持分组、注释等。Hutool - Setting 模块对配置文件进行了更强大的封装，提供了比 Properties 更丰富的功能，支持分组配置、自动加载、变量引用等，让配置文件的管理和使用更加便捷。

二、引入依赖

如果你使用 Maven 项目，在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

若使用 Gradle 项目，在 build.gradle 中添加：

implementation 'cn.hutool:hutool-all:5.8.16'

三、基本使用示例

1. 创建和读取简单的 Setting 文件

首先，在 src/main/resources 目录下创建一个 config.setting 文件，内容如下：

# 这是一个注释
key1 = value1
key2 = value2

然后，在 Java 代码中读取该配置文件：

import cn.hutool.setting.Setting;

public class SimpleSettingExample {
    public static void main(String[] args) {
        // 加载配置文件
        Setting setting = new Setting("config.setting");
        // 获取配置项的值
        String value1 = setting.getStr("key1");
        String value2 = setting.getStr("key2");
        System.out.println("key1 的值: " + value1);
        System.out.println("key2 的值: " + value2);
    }
}

在上述代码中，使用 Setting 类的构造函数加载 config.setting 文件，然后使用 getStr 方法获取配置项的值。

2. 使用分组配置

可以在 config.setting 文件中使用分组来组织配置信息，修改 config.setting 文件如下：

# 全局配置
global.key = globalValue

# 分组配置
[group1]
key1 = group1Value1
key2 = group1Value2

[group2]
key1 = group2Value1
key2 = group2Value2

Java 代码中读取分组配置：

import cn.hutool.setting.Setting;

public class GroupSettingExample {
    public static void main(String[] args) {
        Setting setting = new Setting("config.setting");
        // 获取全局配置项的值
        String globalValue = setting.getStr("global.key");
        System.out.println("全局配置 key 的值: " + globalValue);

        // 获取分组 1 的配置项的值
        String group1Value1 = setting.getStr("key1", "group1");
        String group1Value2 = setting.getStr("key2", "group1");
        System.out.println("分组 1 key1 的值: " + group1Value1);
        System.out.println("分组 1 key2 的值: " + group1Value2);

        // 获取分组 2 的配置项的值
        String group2Value1 = setting.getStr("key1", "group2");
        String group2Value2 = setting.getStr("key2", "group2");
        System.out.println("分组 2 key1 的值: " + group2Value1);
        System.out.println("分组 2 key2 的值: " + group2Value2);
    }
}

在这个示例中，使用 getStr 方法的第二个参数指定分组名称来获取分组内的配置项的值。如果不指定分组名称，则默认从全局配置中获取。

四、自动加载和重载配置

Hutool - Setting 支持自动加载和重载配置文件，当配置文件发生变化时，会自动重新加载配置信息。

import cn.hutool.setting.Setting;

import java.util.concurrent.TimeUnit;

public class AutoReloadExample {
    public static void main(String[] args) throws InterruptedException {
        // 加载配置文件并开启自动重载，间隔时间为 5 秒
        Setting setting = new Setting("config.setting", true, 5, TimeUnit.SECONDS);
        while (true) {
            String value = setting.getStr("key1");
            System.out.println("key1 的值: " + value);
            TimeUnit.SECONDS.sleep(3);
        }
    }
}

在上述代码中，Setting 类的构造函数的第二个参数设置为 true 表示开启自动重载，第三个参数指定重载的间隔时间，第四个参数指定时间单位。程序会每隔一段时间自动检查配置文件是否有变化，如果有变化则重新加载配置。

五、变量引用

Hutool - Setting 支持在配置文件中使用变量引用，例如修改 config.setting 文件如下：

basePath = /home/user/data
dataPath = ${basePath}/subdir

Java 代码中读取引用变量的配置项：

import cn.hutool.setting.Setting;

public class VariableReferenceExample {
    public static void main(String[] args) {
        Setting setting = new Setting("config.setting");
        String dataPath = setting.getStr("dataPath");
        System.out.println("dataPath 的值: " + dataPath);
    }
}

在这个示例中，dataPath 配置项引用了 basePath 的值，Hutool - Setting 会自动解析并替换引用的变量。

六、注意事项

• 配置文件编码：默认情况下，Hutool - Setting 以 UTF - 8 编码读取配置文件。如果配置文件使用其他编码，需要在 Setting 类的构造函数中指定编码。

• 文件路径：如果配置文件不在 src/main/resources 目录下，需要指定完整的文件路径。

• 并发访问：在多线程环境下使用 Setting 对象时，要注意并发访问的问题。Hutool - Setting 本身是线程安全的，但在修改配置文件或进行复杂操作时，可能需要额外的同步措施。

通过使用 Hutool - Setting，开发者可以更方便地管理和使用配置文件，提高开发效率，尤其是在处理复杂的配置信息时，其优势更加明显。