Common Logging 项目教程

Common Logging 项目教程

common-logging A portable logging abstraction for .NET 项目地址: https://gitcode.com/gh_mirrors/co/common-logging

1. 项目介绍

Common Logging 是一个为 .NET 平台提供的可移植日志抽象库。它允许开发者在不同的日志实现之间轻松切换，支持多种日志框架，如 log4net、NLog、Microsoft Enterprise Library 日志、Microsoft Application Insights、Microsoft Event Tracing for Windows 和 Serilog。Common Logging 还提供了一组基类，使得集成任何日志系统变得非常简单。

2. 项目快速启动

2.1 安装 Common Logging

首先，通过 NuGet 安装 Common Logging 包：

PM> Install-Package Common.Logging

2.2 配置 Common Logging

在你的应用程序配置文件（如 app.config 或 web.config）中添加以下配置：

<configuration>
  <configSections>
    <sectionGroup name="common">
      <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" />
    </sectionGroup>
  </configSections>
  <common>
    <logging>
      <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging">
        <arg key="level" value="INFO" />
        <arg key="showLogName" value="true" />
        <arg key="showDateTime" value="true" />
        <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" />
      </factoryAdapter>
    </logging>
  </common>
</configuration>

2.3 使用 Common Logging

在你的代码中使用 Common Logging 进行日志记录：

using Common.Logging;

public class MyClass
{
    private static readonly ILog log = LogManager.GetLogger<MyClass>();

    public void DoSomething()
    {
        log.Info("This is an informational message.");
        log.Error("This is an error message.");
    }
}

3. 应用案例和最佳实践

3.1 集成 NLog

如果你使用 NLog 作为日志框架，可以通过 NuGet 安装相应的适配器包：

PM> Install-Package Common.Logging.NLog41

然后在配置文件中添加 NLog 的配置：

<common>
  <logging>
    <factoryAdapter type="Common.Logging.NLog.NLogLoggerFactoryAdapter, Common.Logging.NLog41">
      <arg key="configType" value="INLINE" />
    </factoryAdapter>
  </logging>
</common>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <!-- NLog 配置 -->
</nlog>

3.2 集成 Microsoft Application Insights

如果你使用 Microsoft Application Insights，可以通过 NuGet 安装相应的适配器包：

PM> Install-Package Microsoft.ApplicationInsights -Version 0.17.0

然后在配置文件中添加 Application Insights 的配置：

<common>
  <logging>
    <factoryAdapter type="Common.Logging.ApplicationInsights.ApplicationInsightsLoggerFactoryAdapter, Common.Logging.ApplicationInsights">
      <arg key="InstrumentationKey" value="[YOUR APPLICATION INSIGHTS INSTRUMENTATION KEY]" />
    </factoryAdapter>
  </logging>
</common>

4. 典型生态项目

4.1 log4net

log4net 是一个广泛使用的日志框架，Common Logging 提供了对 log4net 的集成支持。你可以通过 NuGet 安装 Common.Logging.Log4Net 包来使用。

4.2 Serilog

Serilog 是一个现代的结构化日志框架，Common Logging 也提供了对 Serilog 的集成支持。你可以通过 NuGet 安装 Common.Logging.Serilog 包来使用。

4.3 Microsoft Enterprise Library

Microsoft Enterprise Library 是一个企业级应用程序块集合，Common Logging 提供了对其日志模块的集成支持。你可以通过 NuGet 安装 Common.Logging.EntLib 包来使用。

通过这些集成，Common Logging 可以帮助你在不同的日志框架之间无缝切换，提高开发效率和代码的可维护性。

common-logging A portable logging abstraction for .NET 项目地址: https://gitcode.com/gh_mirrors/co/common-logging