Log4Net使用学习笔记

项目源文件下载https://files.cnblogs.com/files/ckym/Log4NetTestSourceCode.zip

Log4net是一款非常好用的日志记录的框架,使用它可以实现将日志输出到控制台,文件,数据库等功能

网上有很多log4net的使用教程,一些非常简陋,一些又很深奥,我学习使用log4net的时候查阅了很多资料,为了可以记住相关功能的实现方式,故记录这篇文章,仅用于初学者使用此文档来进行学习,如有错误,请大神不吝赐教,更多深入用法和原理请大家查询相关文档。

1. 1.   新建一个控制台应用程序(Core)
2. 2.   在Nuget中安装log4net完成之后新建一个log4net的配置文件,配置文件示例如下

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

<log4net>

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

<layout type="log4net.Layout.PatternLayout" value="%date [%thread] %-5level %logger - %message%newline" />

</appender>

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

<file value="log-file.log" />

<appendToFile value="true" />

<layout type="log4net.Layout.PatternLayout">

<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

</layout>

</appender>

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

<file value="Log/" />

<appendToFile value="true" />

<rollingStyle value="Composite" />

<staticLogFileName value="false" />

<datePattern value="yyyyMMdd'.log'" />

<maxSizeRollBackups value="10" />

<maximumFileSize value="1MB" />

<layout type="log4net.Layout.PatternLayout">

<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

</layout>

</appender>

<!-- name属性指定其名称,type则是log4net.Appender命名空间的一个类的名称,意思是,指定使用哪种介质-->

<appender name="ADONetAppender" type="MicroKnights.Logging.AdoNetAppender, log4net.AdoNetAppender">

<!--日志缓存写入条数 设置为0时只要有一条就立刻写到数据库-->

<bufferSize value="1" />

<!--日志数据库连接串-->

<connectionType value="System.Data.SqlClient.SqlConnection, System.Data" />

<connectionString value="Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=SCTest;Integrated Security=True;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False;" />

<!--日志数据库脚本-->

<commandText value="INSERT INTO Sys_Logs (ID,CreateTime,CreateUser,LogLevel,Message,UserIP) VALUES (4,@CreateTime,@CreateUser,@LogLevel,@CustomMessage,@UserIP)" />

<!--日志时间LogDate -->

<parameter>

<parameterName value="@CreateTime" />

<dbType value="DateTime" />

<layout type="log4net.Layout.RawTimeStampLayout" />

</parameter>

<parameter>

<parameterName value="@LogLevel" />

<dbType value="String" />

<size value="200" />

<layout type="log4net.Layout.PatternLayout">

<conversionPattern value="%p" />

</layout>

</parameter>

<parameter>

<parameterName value="@CustomMessage" />

<dbType value="String" />

<size value="3000" />

<layout type="Log4NetTest.CustomLayout,Log4NetTest">

<conversionPattern value="%CustomMessage{CustomMessage}" />

</layout>

</parameter>

<!--自定义UserName -->

<parameter>

<parameterName value="@CreateUser" />

<dbType value="String" />

<size value="30" />

<layout type="Log4NetTest.CustomLayout,Log4NetTest" >

<conversionPattern value = "%CreateUser{CreateUser}"/>

</layout>

</parameter>

<parameter>

<parameterName value="@UserIP" />

<dbType value="String" />

<size value="20" />

<layout type="Log4NetTest.CustomLayout,Log4NetTest" >

<conversionPattern value = "%UserIP{UserIP}"/>

</layout>

</parameter>

</appender>

<!-- Setup the root category, add the appenders and set the default level -->

<root>

<level value="ALL" />

<appender-ref ref="ConsoleAppender" />

<appender-ref ref="FileAppender" />

<appender-ref ref="RollingLogFileAppender" />

<appender-ref ref="ADONetAppender" />

</root>

</log4net>

接着在App.config中添加如下行

<configuration>

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

</configuration>

然后再Main文件中添加如下代码

ILoggerRepository repository = LogManager.CreateRepository("MyCustomRepository");

//BasicConfigurator.Configure(repository);//简单配置,只能写日志到控制台

//读取配置文件的方式实现

//var log4NetConfig = new XmlDocument();

//log4NetConfig.Load(File.OpenRead("log4net.config"));

//XmlConfigurator.Configure(repository, log4NetConfig["log4net"]);

//直接使用文件的方式

//注意,要求所有的配置文件必须放置在Debug文件夹下面,否则会造成程序不报错,但是也不能正确写入文件的问题

XmlConfigurator.Configure(repository, new FileInfo("log4net.config"));

ILog log = LogManager.GetLogger(repository.Name,"MyCustomLogger");

//log.Debug("This is a Log info From Log4net Test");

//log.Info("NETCorelog4net log");

//log.Info("test log");

//log.Error("error");

//log.Info("linezero");

//记录日志到数据库

CustomLogInfo logInfo = new CustomLogInfo() { ID = new Random().Next(1, 100), Message = "This is a Log info By Log4Net", CreateUser = "SC", UserIP = Dns.GetHostAddresses(Dns.GetHostName())[0].ToString() };

log.Debug(logInfo);

Console.WriteLine("日志记录完成!");

Console.ReadKey();

根据注释取消或者注释掉相关的代码,点击运行,可以看到日志输出到文件，或者控制台,或者数据库文件

异常处理：

1. 找不到AdoNetAppender

在使用log4net2.0.8的时候我们运行会发现报错,因为2.0.8的版本没有提供AdoNetAppender,所以需要我们自己去实现,源代码在项目中可以找到,其他数据库,例如MySql,Oracle等数据库一样的实现方式

1. 实现自定义的转换器和布局,这个可以参考原代码的实现和注释,即可实现相关的功能(注意需要反射的只是).

下面是输出的日志模板的一下缩写对应的关系,可以参考,这些是log4net中自带的转换器实现的。

1）NewLinePatternConverter

作用：换行；通配符：%newline，%n

2）LoggerPatternConverter

作用：显示Logger名；通配符：%logger，%c

3）TypeNamePatternConverter

作用：显示类名；通配符：%C，%class，%type

4）DatePatternConverter

作用：显示时间；通配符：%d，%date

5）ExceptionPatternConverter

作用：异常信息；通配符：%exception

6）LineLocationPatternConverter

作用：语句所在的行号；通配符：%L，%line

7）MessagePatternConverter

作用：信息内容；通配符：%message，%m

8）LevelPatternConverter

作用：消息等级；通配符：%level，%p