hutool.setting.setting

配置文件工具类

Module Contents

Classes

SettingUtil

配置文件工具类

API

class hutool.setting.setting.SettingUtil

配置文件工具类

支持 .properties/.setting 格式,支持 key=value 和 key: value 两种写法。

static load(path: str, charset: str = 'utf-8') dict

加载配置文件

支持的格式:
  • key=value

  • key: value

  • # 注释行

  • ! 注释行

参数:
  • path – 配置文件路径

  • charset – 文件编码,默认为 ‘utf-8’

返回:

解析后的配置字典

static get(props: dict, key: str, default: Any = None) Any

获取配置值

参数:
  • props – 配置字典

  • key – 配置键

  • default – 默认值

返回:

配置值,不存在时返回默认值

static _parse_value(value: str) Any

解析配置值的类型

参数:

value – 字符串类型的值

返回:

解析后的值(bool、int、float或原始字符串)

static store(props: dict, path: str, charset: str = 'utf-8', comment: str = '') None

将配置字典持久化到文件

参数:
  • props – 配置字典

  • path – 文件路径

  • charset – 文件编码

  • comment – 文件头部注释

static to_dict(props: dict) dict

将配置字典转为普通字典(别名,直接返回副本)

参数:

props – 配置字典

返回:

字典副本

static create() dict

创建空配置字典

返回:

空字典

static set_value(props: dict, key: str, value) None

设置配置值

参数:
  • props – 配置字典

  • key – 键名

  • value – 值

static get_group(props: dict, prefix: str) dict

获取指定前缀的配置组

参数:
  • props – 配置字典

  • prefix – 组前缀

返回:

过滤后的字典