.NET版开源日志框架Log4Net详解

zoukankan html css js c++ java

.NET版开源日志框架Log4Net详解

来源：Yaopengfei
链接：http://www.cnblogs.com/yaopengfei/p/9428206.html

一、Log4Net简介

Log4net是从Java中的Log4j迁移过来的一个.Net版的开源日志框架，它的功能很强大，可以将日志分为不同的等级，以不同的格式输出到不同的存储介质中，比如：数据库、txt文件、内存缓冲区、邮件、控制台、ANSI终端、远程接收端等等，我们这里主要介绍最常用的两种：txt文件和数据库。

（PS：其它的存储介质详见 http://logging.apache.org/log4net/release/config-examples.html）

Log4net将日志分为五个级别，分别是： FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息），每个级别都对应着一组重载方法进行调用。

官网地址：http://logging.apache.org/log4net/index.html
Nuget地址：https://www.nuget.org/packages/log4net/
Nuget安装：Install-Package log4net
最新版本：2.0.8 （2018-08-09）

本节主要围绕两个主要的存储介质：【txt文件】和【SQLServer数据库】展开，涵盖的知识点有：

①. 基本的使用步骤。
②. 初始化关联配置文件的几种形式。
③. 代码调用详解。
④. 配置文件详解。
⑤. 简单的封装和在MVC框架中的调用。

二、基本使用步骤

我们先以控制台程序为例，简单介绍Log4net存储日志到txt文本文档中，后面在做代码的详解。

1、新建01-SimpleDemo控制台程序，通过指令【Install-Package log4net】安装相应程序集。

2、在默认配置文件中App.config(B/S程序则为web.config)中进行配置，主要分两块：

A. 在<configuration></configuration>节点下新增节点下新增(要在其最顶部)：

<configSections>
　<section name = "log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
</configSections>

B. 在<configuration></configuration>根节点下,配置log4net的核心配置代码, 主要节点如下：

<log4net> <appender> </appender> <root></root> </log4net>

详细代码如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
</configSections>

<log4net>

<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

<file value="D:MyLog1" />
<appendToFile value="true" />

<param name="StaticLogFileName" value="false" />

<param name="DatePattern" value="yyyyMMdd".log"" />
<rollingStyle value="Date" />

<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%newline %n记录时间：%date %n线程ID:[%thread] %n日志级别： %-5level %n出错类：%logger property: [%property{NDC}] - %n错误描述：%message%newline %n"/>
</layout>

<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
</appender>
<root>
<level value="ALL"></level>
<appender-ref ref="RollingFileAppender"></appender-ref>
</root>
</log4net>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6" />
</startup>
</configuration>

3、代码调用

log4net.Config.XmlConfigurator.Configure();
ILog log = LogManager.GetLogger("test");
log.Debug("调试信息");

4、运行结果

截止此处，日志保存成功。

三、初始化配置文件

前面提到在默认配置文件中App.config(B/S程序则为web.config)中进行配置，可以通过代码 log4net.Config.XmlConfigurator.Configure(); 来初始化配置，或者还可以通过 [assembly: log4net.Config.XmlConfigurator()] 反射的形式进行初始化配置，二者可以达到同样的效果，代表了两种初始化配置文件的形式。

PS： [assembly: log4net.Config.XmlConfigurator()] 可以加在当前使用文件的 namespace上作用于当前文件，或者加在Properties/AssemblyInfo.cs中，则该项目全局都无须再初始化了。

在实际项目中，默认的配置文件里可能包含很多框架的信息，这个时候把 log4net的配置代码再放入进去，就会显得有点杂乱，或者有些“奇葩”的人把默认配置文件改名了，这个时候使用上述默认的两种方式就不好用了，那么这种情况怎么处理呢？

这里重点介绍通过 log4net.Config.XmlConfigurator.Configure(); 来关联配置文件。

情况一：使用默认配置文件的情况

1、代码配置：log4net.Config.XmlConfigurator.Configure();
2、反射配置：[assembly: log4net.Config.XmlConfigurator()]

情况二：修改默认配置文件的名称为：App1.config (这里只是举例，很少有修改默认配置文件名称的)

1、代码配置：首先将App1.config文件的属性中的“生成操作”改为“ 嵌入的资源”，然后通过以下代码进行配置。

Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.App1.config");
log4net.Config.XmlConfigurator.Configure(xml);

注：代码中的 _01_SimpleDemo 为命名空间名。

2、反射配置：[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.xml")]

注：用这种方式属性中的：复制到输出目录需要改为：始终复制，生成操作不需要配置，使用默认：无即可

情况三：新建单独xml文件，进行log4net的配置 (推荐采用这种方式，和原配置文件区分开，单独配置方便，处理方式和情况二是一致的)

1、代码配置：首先将log4net.xml文件的属性中的“生成操作”改为“ 嵌入的资源”，然后通过以下代码进行配置。

Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
log4net.Config.XmlConfigurator.Configure(xml);

注：代码中的 _01_SimpleDemo 为命名空间名。

情况四：无论是修改默认配置文件的名称为或者新建单独的xml作为配置文件 → 可以通过绝对路径的方式进行处理【不推荐这种方式】

1、直接写绝对路径（注意这种方式【不需要】配置文件属性为 “嵌入的资源”）

log4net.Config.XmlConfigurator.Configure(new FileInfo(@"D:-我的开发之路DotNet体系-DotNet框架篇-Log4net详解Code-SimpleDemolog4net.xml"));

2 通过代码获取绝对路径（注意这种方式【不需要】配置文件属性的“生成操作”改为 “嵌入的资源”，但需要改为“始终复制”，确保输出到bin文件下）

string assemblyFilePath = Assembly.GetExecutingAssembly().Location;
string assemblyDirPath = Path.GetDirectoryName(assemblyFilePath);
string configFilePath = assemblyDirPath + " //log4net.xml";
log4net.Config.XmlConfigurator.Configure(new FileInfo(configFilePath));

PS：B/S程序下通过 log4net.Config.XmlConfigurator.Configure(new FileInfo(Server.MapPath("~") + @"/log4net.xml")); 来配置。

四、代码调用详解

Log4net允许多个ILog对象同时存在，通过代码：ILog log = LogManager.GetLogger("xxx"); 来创建。

A: 日志级别由高到低分别为：FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息），另外还有 OFF和 ALL 。

几点说明：OFF表示所有信息都不写入，ALL表示所有信息都写入，我们也可以通过：<root><level value = "WARN" ></ level ></root>这样配置，表示WARN级别以及高于WARN以上的级别才会被写入日志。

B: 写入日志的方法有：Debug、Error、Fatal、Info、Warn五个方法，每个方法都有两个重载，如下图：

分享在使用配置文件为log4net.xml的情况下的调用代码：

Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
log4net.Config.XmlConfigurator.Configure(xml);
ILog log = LogManager.GetLogger("test");
log.Debug("调试信息");
log.Info("一般信息");
log.Warn("警告");
try
{
int.Parse("ddd");
}
catch (Exception ex)
{
log.Error("一般错误", ex);
}
log.Fatal("致命错误");

五、配置文件详解

Log4net的配置文件主要分为两大部分：分别是【自定义配置节点】和
【核心代码配置】，自定义配置节点代码固定，如下图，核心代码配置主要位于：<log4net></log4net>节点中，里面包括<appender></appender>节点配置日日志输出途径和 <root></root>节点，用于设置记录日志的级别和启用哪些输出途径。　　

几点说明：

1、自定义配置节点 <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> 代码固定，直接复制即可。

2、<root></root> 节点主要用来：配置日志的的输出级别和加载日志的输出途径。

A： level中的value值表示该值及其以上的日志级别才会输出，日志级别包括：OFF > FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息） > ALL ，比如：

<level value="INFO"></level> 表示只有INFO及其以上的日志级别才会被保存。
PS：OFF表示所有信息都不写入，ALL表示所有信息都写入。

B： <appender-ref></appender-ref>标签用于加载日志的输出途径代码，通过ref和appender标签的中name属性相关联，比如：

<appender-ref ref="RollingFileAppender"></appender-ref> 表示开启txt文档保存日志的方式。

3、<appender></appender>节点，用来配置日志的输出途径的，本节主要介绍了输出到【txt文本文档】中和【数据库】。

A：分享一下数据库的表结构，详细配置见下面的代码分享，需要注意字段类型相匹配，并且要显式指定其长度。

B：关于txt文本文档的命名，可以存放到一个文件夹里，也可以按照时间来区分文件夹，并且命名可以动态+指定命名的方式。

C：关于日志文件大小的说明和文件个数的说明，主要需要三个节点配合使用（实际开发中，如果一个txt特别大，打开的时候会非常的慢，卡顿，所以该步骤有必要配置一下）。

PS：首先要配置 RollingStyle 节点为Size模式或者Composite模式，然后配置 maximumFileSize 节点设置每个文件的大小，最后配置 MaxSizeRollBackups 节点，设置日志文件的个数。超出大小后在所有文件名后自动增加正整数重新命名，数字最大的最早写入。

用下面的代码简单测试一下：

<param name="RollingStyle" value="Composite" />
<param name="maximumFileSize" value="10KB" />
<param name="MaxSizeRollBackups" value="5" />

详细代码如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
</configSections>

<log4net>


<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

<param name="File" value="D:MyLog1" />



<param name="AppendToFile" value="true" />

<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

<Encoding value="UTF-8" />

<param name="StaticLogFileName" value="false" />

<param name="RollingStyle" value="Composite" />


<param name="DatePattern" value="yyyy-MM-dd".log"" />







<param name="maximumFileSize" value="10MB" />

<param name="MaxSizeRollBackups" value="5" />

<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="记录时间：%date %n线程ID:[%thread] %n日志级别：%-5level %n出错类：%logger property: [%property{NDC}] - %n错误描述：%message%newline %n%newline"/>
</layout>
</appender>


<appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">

<param name="BufferSize" value="1" />

<connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />

<connectionString value="data source=localhost;initial catalog=LogDB;integrated security=false;persist security info=True;User ID=sa;Password=123456" />

<commandText value="INSERT INTO LogInfor ([threadId],[log_level],[log_name],[log_msg],[log_exception],[log_time]) VALUES (@threadId, @log_level, @log_name, @log_msg, @log_exception,@log_time)" />


<parameter>
<parameterName value="@threadId" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%thread" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_level" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%level" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_name" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%logger" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_msg" />
<dbType value="String" />
<size value="5000" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%message" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_exception" />
<dbType value="String" />
<size value="2000" />
<layout type="log4net.Layout.ExceptionLayout" />
</parameter>

<parameter>
<parameterName value="@log_time" />
<dbType value="DateTime" />
<layout type="log4net.Layout.RawTimeStampLayout" />
</parameter>
</appender>

<root>



<level value="ALL"></level>

<appender-ref ref="RollingFileAppender"></appender-ref>
<appender-ref ref="AdoNetAppender"></appender-ref>
</root>
</log4net>
</configuration>

六、简单的封装及完整代码分享

这里模拟在系统框架中对Log4net进行简单的封装，然后在MVC框架中调用，并分享全部代码。

步骤一：新建Ypf.Utils类库，作为工具类库，引入log4net程序集，并将前面用到的log4net.xml 复制进来，改属性为嵌入资源，然后新建LogUtils类（不要起名为LogHelp），对Log4net的方法进行简单的封装，主要包括：初始化代码、ILog实例创建、五类日志级别的封装。

log4net.xml文件代码如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
</configSections>

<log4net>


<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

<param name="File" value="D:MyLog1" />



<param name="AppendToFile" value="true" />

<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

<Encoding value="UTF-8" />

<param name="StaticLogFileName" value="false" />

<param name="RollingStyle" value="Composite" />


<param name="DatePattern" value="yyyy-MM-dd".log"" />







<param name="maximumFileSize" value="10MB" />

<param name="MaxSizeRollBackups" value="5" />

<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="记录时间：%date %n线程ID:[%thread] %n日志级别：%-5level %n出错类：%logger property: [%property{NDC}] - %n错误描述：%message%newline %n%newline"/>
</layout>
</appender>


<appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">

<param name="BufferSize" value="1" />

<connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />

<connectionString value="data source=localhost;initial catalog=LogDB;integrated security=false;persist security info=True;User ID=sa;Password=123456" />

<commandText value="INSERT INTO LogInfor ([threadId],[log_level],[log_name],[log_msg],[log_exception],[log_time]) VALUES (@threadId, @log_level, @log_name, @log_msg, @log_exception,@log_time)" />


<parameter>
<parameterName value="@threadId" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%thread" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_level" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%level" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_name" />
<dbType value="String" />
<size value="100" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%logger" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_msg" />
<dbType value="String" />
<size value="5000" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%message" />
</layout>
</parameter>

<parameter>
<parameterName value="@log_exception" />
<dbType value="String" />
<size value="2000" />
<layout type="log4net.Layout.ExceptionLayout" />
</parameter>

<parameter>
<parameterName value="@log_time" />
<dbType value="DateTime" />
<layout type="log4net.Layout.RawTimeStampLayout" />
</parameter>
</appender>

<root>



<level value="ALL"></level>

<appender-ref ref="RollingFileAppender"></appender-ref>
<appender-ref ref="AdoNetAppender"></appender-ref>
</root>
</log4net>
</configuration>

LogUtils类代码如下：

using log4net;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;

namespace Ypf.Utils
{
public class LogUtils
{
//可以声明多个日志对象
public static ILog log = LogManager.GetLogger(typeof(LogUtils));

#region 01-初始化Log4net的配置
/// <summary>
/// 初始化Log4net的配置
/// xml文件一定要改为嵌入的资源
/// </summary>
public static void InitLog4Net()
{
Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("Ypf.Utils.log4net.xml");
log4net.Config.XmlConfigurator.Configure(xml);
}
#endregion

/************************* 五种不同日志级别 *******************************/
//FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息）

#region 01-DEBUG（调试信息）
/// <summary>
/// Debug
/// </summary>
/// <param name="msg">日志信息</param>
public static void Debug(string msg)
{
log.Debug(msg);
}
/// <summary>
/// Debug
/// </summary>
/// <param name="msg">日志信息</param>
/// <param name="exception">错误信息</param>
public static void Debug(string msg, Exception exception)
{
log.Debug(msg, exception);
}

#endregion

#region 02-INFO（一般信息）
/// <summary>
/// Info
/// </summary>
/// <param name="msg">日志信息</param>
public static void Info(string msg)
{
log.Info(msg);
}
/// <summary>
/// Info
/// </summary>
/// <param name="msg">日志信息</param>
/// <param name="exception">错误信息</param>
public static void Info(string msg, Exception exception)
{
log.Info(msg, exception);
}
#endregion

#region 03-WARN（警告）
/// <summary>
/// Warn
/// </summary>
/// <param name="msg">日志信息</param>
public static void Warn(string msg)
{
log.Warn(msg);
}
/// <summary>
/// Warn
/// </summary>
/// <param name="msg">日志信息</param>
/// <param name="exception">错误信息</param>
public static void Warn(string msg, Exception exception)
{
log.Warn(msg, exception);
}
#endregion

#region 04-ERROR（一般错误）
/// <summary>
/// Error
/// </summary>
/// <param name="msg">日志信息</param>
public static void Error(string msg)
{
log.Error(msg);
}
/// <summary>
/// Error
/// </summary>
/// <param name="msg">日志信息</param>
/// <param name="exception">错误信息</param>
public static void Error(string msg, Exception exception)
{
log.Error(msg, exception);
}
#endregion

#region 05-FATAL(致命错误)
/// <summary>
/// Fatal
/// </summary>
/// <param name="msg">日志信息</param>
public static void Fatal(string msg)
{
log.Fatal(msg);
}
/// <summary>
/// Fatal
/// </summary>
/// <param name="msg">日志信息</param>
/// <param name="exception">错误信息</param>
public static void Fatal(string msg, Exception exception)
{
log.Fatal(msg, exception);
}

#endregion
}
}

步骤二：新建名Ypf.MVC的MVC5框架，添加对Ypf.Utils类库的引用，在Global.asax全局文件中添加对对Log4net进行初始化。

然后就可以愉快的进行调用测试了哦。

/// <summary>
/// 测试log4net
/// 首先需要再Global中初始化log4net
/// </summary>
/// <returns></returns>
public ActionResult Index()
{
//FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息）
LogUtils.Debug("出错了");
try
{
int.Parse("ddf");
}
catch (Exception ex)
{
LogUtils.Debug("出错了",ex);
}

LogUtils.Info("出错了");
try
{
int.Parse("ddf");
}
catch (Exception ex)
{
LogUtils.Info("出错了", ex);
}

LogUtils.Warn("出错了");
try
{
int.Parse("ddf");
}
catch (Exception ex)
{
LogUtils.Warn("出错了", ex);
}

LogUtils.Error("出错了");
try
{
int.Parse("ddf");
}
catch (Exception ex)
{
LogUtils.Error("出错了", ex);
}

LogUtils.Fatal("出错了");
try
{
int.Parse("ddf");
}
catch (Exception ex)
{
LogUtils.Fatal("出错了", ex);
}
return View();
}

看完本文有收获？请转发分享给更多人~

查看全文

相关阅读:
redis 安装报错
 eclipse 启动后，闪退
 java 读取文件路径空格和中文的处理
 阿里云里面的Linux 系统挂载数据盘
 云服务器 ECS Linux 系统盘数据转移方法
 Redis批量删除Key
快速搭建 SpringCloud 微服务开发环境的脚手架
 用这个库 3 分钟实现让你满意的表格功能：Bootstrap-Table
Python 命令行之旅：深入 click 之选项篇
 Python 命令行之旅：深入 click 之参数篇

原文地址：https://www.cnblogs.com/hgmyz/p/12351828.html