Jc.Log 1.4.20

JcLog 模块文档

概述

JcLog 是一个轻量级日志模块，用于在 C# 应用程序中进行日志记录。本文档详细介绍如何使用 JcLog 进行有效的日志管理，包括初始化、配置、日志写入和错误处理。

初始化和配置

JcLog 可以通过多种方式初始化，允许自定义日志名称和根目录。使用 JcLogOptions 进行详细配置，包括日志保留策略和是否输出到控制台。

示例

var logOptions = new JcLogOptions { LogName = "应用日志", RootFolder = "日志目录", RetentionDays = 30 };
var logger = new JcLog(logOptions);

写入日志

JcLog 提供了多种写入日志的方法，包括信息日志、警告和错误，支持将字符串或可序列化的对象作为日志内容。

示例

logger.WriteLog("这是一条信息日志");
logger.WriteError("这是一条错误日志");
logger.WriteWaring("这是一条警告日志");

解析日志

功能

• 解析日志文件，将文本行转换为结构化的日志条目。
• 支持提取时间戳、日志类型、消息内容，以及可选的序列化对象数据。

使用方法

解析日志文件

要解析一个日志文件，您需要创建一个 JcLogParser 实例，并调用 ParseLogFile 方法，传入日志文件的路径。

var parser = new JcLogParser();
var logEntries = parser.ParseLogFile("路径到您的日志文件");

LogEntry 结构

每个 LogEntry 对象包含以下属性：

• Timestamp：日志条目的时间戳。
• LogType：日志类型（如 info, warning, error）。
• Message：日志消息内容。
• AdditionalData：如果日志中包含了序列化的对象数据，此属性将包含该数据的动态表示。

案例

假设您有一个日志文件 app.log，格式如下：

12:34:56.789>[INFO]>这是一个信息日志
12:35:00.123>[ERROR]>这是一个错误日志>{"错误码":404,"错误信息":"未找到"}

使用 JcLogParser 解析此文件将产生以下结果

foreach(var entry in logEntries)
{
    Console.WriteLine($"时间: {entry.Timestamp}, 类型: {entry.LogType}, 消息: {entry.Message}");
    if(entry.AdditionalData != null)
    {
        Console.WriteLine($"额外数据: {entry.AdditionalData}");
    }
}

输出:

时间: 12:34:56.789, 类型: INFO, 消息: 这是一个信息日志
时间: 12:35:00.123, 类型: ERROR, 消息: 这是一个错误日志
额外数据: {"错误码":404,"错误信息":"未找到"}

错误处理和日志保留

JcLog 自动处理写入过程中的异常，保证应用程序的稳定性。通过配置 JcLogOptions 中的 RetentionDays 来管理日志文件的保留期限。

日志文件管理

JcLog 根据日期自动创建日志文件，并根据保留策略自动清理旧日志文件，优化磁盘空间使用。

结论

JcLog 提供了一个简单而强大的日志记录解决方案，适用于需要在 C# 应用程序中进行高效日志管理的场景。通过上述示例和说明，开发者可以轻松集成和使用 JcLog 进行日志记录。