Properties 扩展 - Props

简介

Props 是对 Java 标准的 Properties 类的增强封装，提供了更加便捷的读取、写入、解析等功能。Props 继承自 Properties，因此可以完全兼容原生的 Properties。同时，Props 也提供了与 Setting 类似的丰富方法，如获取字符串、整数、布尔值等，简化了配置文件的操作。

1. 使用场景

• 配置文件读取：在项目中，需要读取 .properties 文件的配置，并将其转换为具体的数据类型（如字符串、整数、布尔值等）。
• 动态配置：在运行时需要加载和切换不同的配置文件，可以使用 Props 轻松实现。
• 简化配置管理：通过 Props 可以方便地管理和解析项目中的多个配置文件，避免复杂的手动解析。

2. 主要方法与示例

2.1 构造方法

Props 提供了多种构造方式，包括通过文件路径、文件对象、输入流等方式加载配置文件。

示例：通过文件路径加载配置文件

import cn.hutool.setting.dialect.Props;

public class PropsExample {
    public static void main(String[] args) {
        // 通过文件路径加载配置文件
        Props props = new Props("config/test.properties");

        // 获取配置项
        String user = props.getProperty("user");
        String driver = props.getStr("driver");

        System.out.println("User: " + user);
        System.out.println("Driver: " + driver);
    }
}

• 方法签名：
  • public Props(String path)
  • public Props(File file)
  • public Props(InputStream inputStream)
• 参数说明：
  • path：配置文件的路径。
  • file：配置文件的文件对象。
  • inputStream：配置文件的输入流。
• 作用：用于加载配置文件并初始化 Props 对象，适用于项目中需要加载配置文件的场景。

2.2 getStr - 获取字符串类型的配置值

getStr 方法用于获取字符串类型的配置值，相比 getProperty 更加直观简洁。

示例：获取配置项的字符串值

import cn.hutool.setting.dialect.Props;

public class PropsExample {
    public static void main(String[] args) {
        // 加载配置文件
        Props props = new Props("config/test.properties");

        // 获取字符串配置项
        String driver = props.getStr("driver");
        System.out.println("Driver: " + driver);
    }
}

• 方法签名：
  • public String getStr(String key)
  • public String getStr(String key, String defaultValue)
• 参数说明：
  • key：配置项的键。
  • defaultValue：当配置项不存在时返回的默认值。
• 作用：用于简化获取字符串配置值的过程，适用于获取常见的配置项如数据库连接信息、路径等。

2.3 getInt - 获取整数类型的配置值

getInt 方法用于获取整数类型的配置值，并支持默认值的设置。

示例：获取配置项的整数值

import cn.hutool.setting.dialect.Props;

public class PropsExample {
    public static void main(String[] args) {
        // 加载配置文件
        Props props = new Props("config/test.properties");

        // 获取整数配置项
        int timeout = props.getInt("timeout", 30);
        System.out.println("Timeout: " + timeout);
    }
}

• 方法签名：
  • public Integer getInt(String key)
  • public Integer getInt(String key, Integer defaultValue)
• 参数说明：
  • key：配置项的键。
  • defaultValue：当配置项不存在时返回的默认值。
• 作用：用于获取整数类型的配置值，适用于需要读取数值配置项的场景，如超时时间、端口号等。

2.4 getBool - 获取布尔类型的配置值

getBool 方法用于获取布尔类型的配置值，并支持默认值的设置。

示例：获取配置项的布尔值

import cn.hutool.setting.dialect.Props;

public class PropsExample {
    public static void main(String[] args) {
        // 加载配置文件
        Props props = new Props("config/test.properties");

        // 获取布尔配置项
        boolean isEnabled = props.getBool("enabled", false);
        System.out.println("Is Enabled: " + isEnabled);
    }
}

• 方法签名：
  • public Boolean getBool(String key)
  • public Boolean getBool(String key, Boolean defaultValue)
• 参数说明：
  • key：配置项的键。
  • defaultValue：当配置项不存在时返回的默认值。
• 作用：用于获取布尔类型的配置值，适用于读取开关类配置项的场景，如功能开关、调试模式等。

3. 实际应用场景

• 项目配置管理：在应用程序中加载和管理多种配置文件，如数据库配置、API 接口配置、系统参数配置等，可以通过 Props 轻松完成。
• 动态配置读取：在运行时根据需求动态加载不同的配置文件，适用于需要切换环境或配置的场景。
• 增强的类型支持：Props 提供了对多种数据类型（如字符串、整数、布尔值等）的支持，避免了手动类型转换的繁琐操作。

4. 常用方法补充

除了 getStr、getInt、getBool 外，Props 还提供了其他常用方法，如：

• getLong(String key, Long defaultValue)：获取长整型配置值。
• getDouble(String key, Double defaultValue)：获取双精度浮点型配置值。
• getArray(String key)：获取数组类型配置值，支持逗号分隔的字符串解析。

5. 注意事项

• 确保配置文件路径正确，加载时可以相对路径或绝对路径。
• 当获取配置项时，如果不存在且未提供默认值，会返回 null，因此建议在获取时处理可能的 null 值。