YTUtils 库实用工具 Readme

作者

彭木德

开发起始时间

2024年3月27日

简介

YTUtils 是一个为.NET应用程序提供便捷辅助功能的库。本Readme文件主要介绍库中两个核心组件：

JsonConfigHelper.cs

描述

JsonConfigHelper 类位于 YTUtils.JsonConfigure 命名空间内，是一个专用于读取、写入和管理JSON配置文件的助手类。它借助强大的Json.NET库，实现了简单易用的JSON配置数据加载、编辑和保存功能。

主要特性与功能

• 加载JSON配置文件：能够加载指定文件名的JSON配置文件，如果文件不存在，则创建一个新的空JSON对象并将其写入新文件；
• 键值操作：向JSON配置对象中插入或更新键值对，并能实时同步到文件中；
• 深度读取：支持根据嵌套键路径从JSON配置对象中读取特定键值；
• 数据一致性保证：确保在整个读写过程中数据的一致性和正确性。

使用示例可在各个方法内部的注释说明中查阅。

---

LogHelper.cs

描述

LogHelper 类同样是YTUtils库的一部分，它是为项目提供统一日志管理的助手类，底层基于log4net库实现。

核心功能

• 多级别日志记录：包含Info、Debug、Error和Fatal四个级别的日志记录方法；
• 自动元数据填充：利用Caller Information特性自动填充日志输出的源文件路径、成员名称及行号，便于追踪问题源头；
• 配置文件处理：在类初始化时，默认读取当前程序的“Config\log4net.config”作为日志配置文件；
• 清理机制：提供了ReleaseLogerConfigure方法，用于在适当时候删除临时生成的配置文件（如果有）。

开发者可参考类内提供的方法注释来了解具体的使用场景和示例。