Fs.Core.SimpleLogger 1.0.1

Fs.Core.SimpleLogger

Fs.Core.SimpleLogger 是一个轻量级、简单易用的 .NET 日志库，无第三方依赖，适用于需要"纯洁"环境的基础类库和应用程序。

✨ 特性

• 🎯 零依赖: 无第三方 DLL 依赖，保持环境纯净
• 📝 多种处理器: 支持控制台、文件、调试输出等多种日志处理方式
• 🔧 易于使用: API 简单直观，快速上手
• 🎨 灵活扩展: 支持自定义日志处理器和格式化器
• 🐛 调试模式: 内置调试日志功能，方便开发调试
• 📧 模块化: 支持邮件发送、数据库存储等扩展模块

📦 安装

通过 NuGet Package Manager

Install-Package Fs.Core.SimpleLogger

通过 .NET CLI

dotnet add package Fs.Core.SimpleLogger

通过 PackageReference

<PackageReference Include="Fs.Core.SimpleLogger" Version="1.0.0" />

🎯 支持的框架

• .NET Standard 2.0 (支持 .NET Framework 4.6.1+, .NET Core 2.0+, .NET 5+)

📌 仓库定位

1. 无依赖第三方 DLL: 建议在需要"纯洁"的场景中使用，如非高频的基础类库、程序加载器
2. 未进行性能测试: 建议性能敏感领域使用商业库，如 NLog 或 Serilog 等

📖 参考

本项目基于 SimpleLogger 进行删减和优化。

🚀 快速开始

Usage

    public static void Main()
    {
        // Adding handler - to show log messages (ILoggerHandler)
        Logger.LoggerHandlerManager
            .AddHandler(new ConsoleLoggerHandler())
            .AddHandler(new FileLoggerHandler())
            .AddHandler(new DebugConsoleLoggerHandler());

        // Fast logging (monitor name of class and methods from which is the application logged)
        Logger.Log();

        // We define a log message
        Logger.Log("Hello world");

        // We can define the level (type) of message
        Logger.Log(Logger.Level.Fine, "Explicit define level");

        // Explicit definition of the class from which the logging
        Logger.Log<Program>("Explicit define log class");
        Logger.Log<Program>(Logger.Level.Fine, "Explicit define log class and level");

        // Settings of default type of message
        Logger.DefaultLevel = Logger.Level.Severe;

        try 
        { 
            // Simulation of exceptions
            throw new Exception();
        }
        catch (Exception exception)
        {
            // Logging exceptions
            // Automatical adjustment of specific log into the Error and adding of StackTrace
            Logger.Log(exception);
            Logger.Log<Program>(exception);
        }

        // Special feature - debug logging

        Logger.Debug.Log("Debug log");
        Logger.Debug.Log<Program>("Debug log");

        Logger.DebugOff();
        Logger.Debug.Log("Not-logged message");

        Logger.DebugOn();
        Logger.Debug.Log("I'am back!");

        Console.ReadKey();
    }

Output

12.10.2012 21:43: Info [line: 18 Program -> Main()]: There is no message
12.10.2012 21:43: Info [line: 21 Program -> Main()]: Hello world
12.10.2012 21:43: Fine [line: 24 Program -> Main()]: Explicit define level
12.10.2012 21:43: Info [line: 27 Program -> Main()]: Explicit define log class
12.10.2012 21:43: Fine [line: 28 Program -> Main()]: Explicit define log class and level
12.10.2012 21:43: Error [line: 35 Program -> Main()]: Exception of type 'System.Exception' was thrown.
12.10.2012 21:43: Error [line: 35 Program -> Main()]: Log exception -> Message: Exception of type 'System.Exception' was thrown.
StackTrace:    at SimpleLogger.Sample.Program.Main() in c:\GitHub\SimpleLogger\SimpleLogger.Sample\Program.cs:line 35

12.10.2012 21:43: Debug [line: 47 Program -> Main()]: Debug log
12.10.2012 21:43: Debug [line: 48 Program -> Main()]: Debug log
12.10.2012 21:43: Debug [line: 55 Program -> Main()]: I'am back!

Modules

Email module

    // Email module sample
    public static void EmaiLModuleSample()
    {
        // Configuring smtp server
        var smtpServerConfiguration = new SmtpServerConfiguration("userName", "password", "smtp.gmail.com", 587);

        // Creating a module
        var emailSenderLoggerModule = new EmailSenderLoggerModule(smtpServerConfiguration)
        {
            EnableSsl = true,
            Sender = "sender-email@gmail.com"
        };

        // Adding recipients
        emailSenderLoggerModule.Recipients.Add("recipients@gmail.com");

        // Add the module and it works
        Logger.Modules.Install(emailSenderLoggerModule);

        try
        {
            // Simulation of exceptions
            throw new NullReferenceException();
        }
        catch (Exception exception)
        {
            // Log exception
            // If you catch an exception error -> will be sent an email with a list of log message.
            Logger.Log(exception);
        }
    }

MS SQL database module

    // MS SQL database module sample
    public static void MsSqlDatabaseLoggerModuleSample()
    {
        var connectionString = "Your connection string";

        // Just add the module and it works! 
        Logger.Modules.Install(new MsSqlDatabaseLoggerModule(connectionString));
        Logger.Log("My first database log! ");
    }

📖 文档

更多详细文档和使用示例，请访问 GitHub 仓库。

🔗 NuGet 包

访问 NuGet 获取最新版本：https://www.nuget.org/packages/Fs.Core.SimpleLogger/

🤝 贡献

欢迎贡献代码和提出问题！请访问 GitHub Issues。

📄 许可证

本项目采用 MIT 许可证。

👥 作者

由 FsDiG 团队开发和维护。

更新时间: 2023-09-13 (星期三) by Zcb