考虑题4所示的日志记录_基于Log4Net实现日志信息双向存储

1、引言

在上位机开发中，日志记录是必不可少的，我们可以通过日志记录做日志分析及错误追踪。初学者会采用txt文本写入来实现日志保存，但是文本写入不是线程安全，当存在多个线程同时写入日志时，就会出现一些问题。Log4net库是.Net下一个非常优秀的开源日志记录组件，是一个帮助开发者将日志信息输出到各种目标（控制台、文件、数据库等）的工具。本节主要采用开源组件Log4Net来实现错误ERROR信息文本存储，并结合SQLite数据库，将日志INFO信息存储到数据库中，便于后续的查询。

2、开发准备

首先新建一个Windows窗体应用，取名为thinger.cn.Log4NetSQLitePro，UI界面设计如下所示：

通过Nuget添加Log4Net开源组件，如下所示：

通过Nuget添加SQLite组件，如下所示：

3、文本存储

一般情况下，我们可以将一些错误及异常信息存储在文本中，便于随时打开文件进行查询，文本存储将自动以天为单位，每天对应一个文件，步骤如下：

添加一个应用程序配置文件
项目右击添加新建项，项目类型选择应用程序配置文件，名称为log4net.config，如下所示：

配置文件编写
日志配置文件增加相关节点，如下所示：

配置文件规定了日志信息的相关属性、存储方式、日志内容格式等，配置信息如下所示：

<?xml version="1.0" encoding="utf-8" ?>
<configuration><configSections><section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/></configSections><log4net><root></root><appender name="InfoAppender" type="log4net.Appender.RollingFileAppender,log4net" ><param name="File" type="" value="Log/Error/" /><param name="AppendToFile" value="true" /><param name="RollingStyle" value="Date" /><param name="DatePattern" value="yyyyMMdd&quot;.ini&quot;" /><param name="StaticLogFileName" value="false" /><layout type="log4net.Layout.PatternLayout,log4net"><param name="ConversionPattern" value="[%d]%n%m%n%n" /></layout></appender><logger name="Error"><level value="ERROR" /><appender-ref ref="InfoAppender" /></logger></log4net>
</configuration>

其中，较为重要的是日志信息的格式，对应上面文件中的ConversionPattern，值为"[%d]%n%m%n%n"，每个占位符有对应的含义，如下所示：

字符格式	说明
%m(message)	输出的日志消息
%n(newline)	换行
%d(datetime)	输出当前语句运行的时刻
%r(runtime)	输出程序执行到当前消耗的毫秒数
%t(threadid)	当前语句所在的线程ID
%p(priority)	日志的当前日志级别
%c(class)	当前日志对象的名称
%L	输出语句所在的行号
%F	输出语句所在的文件名
%-10	最小长度为10，不够空格填充

字符格式	说明
%m(message)	输出的日志消息
%n(newline)	换行
%d(datetime)	输出当前语句运行的时刻
%r(runtime)	输出程序执行到当前消耗的毫秒数
%t(threadid)	当前语句所在的线程ID
%p(priority)	日志的当前日志级别
%c(class)	当前日志对象的名称
%L	输出语句所在的行号
%F	输出语句所在的文件名
%-10	最小长度为10，不够空格填充

配置文件属性中的复制到输出目录，设置为始终复制或如果较新则复制，如下图所示：

项目的AssemblyInfo.cs类中添加一行代码，如下所示：

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", ConfigFileExtension = "config", Watch = true)]

添加一个LogHelper类，编写2个Error的方法，如下所示：

     // 错误日志带异常public static void Error(string message,Exception ex){ILog log = LogManager.GetLogger("Error");            if (log.IsErrorEnabled){log.Error(message,ex);}}// 错误日志不带异常public static void Error(string message){ILog log = LogManager.GetLogger("Error");if (log.IsErrorEnabled){log.Error(message);}}

在ini文本存储按钮事件下，调用错误日志写入，如下所示：

        private void btn_ini_Click(object sender, EventArgs e){//不带异常LogHelper.Error(this.txt_ini.Text.Trim());//带异常LogHelper.Error(this.txt_ini.Text.Trim(),new Exception("这是一条异常错误信息"));}

执行完成后，在项目目录，LogError目录下，产生一条当天日志命名的文件，打开如下所示：

4、SQLite存储

日志信息存储到数据库的好处在于便于用户通过界面进行查询，这里采用开源免费数据库SQLite，其他关系型数据库，如SQLServer、mysql，原理都是一样的，具体步骤如下所示：

创建数据库及数据表
通过SQLiteStudio软件创建一个数据库，取名为Log4NetSQLite，执行以下脚本创建一个Log数据表：

CREATE TABLE Log
(LogId        INTEGER PRIMARY KEY,Date        DATETIME NOT NULL,Level        VARCHAR(50) NOT NULL,Logger        VARCHAR(255) NOT NULL,Message        TEXT DEFAULT NULL
);

将数据库文件复制到项目根目录下的DataBase文件夹中
修改log4net.config文件，增加数据库存储相关配置，如下所示：

<?xml version="1.0" encoding="utf-8" ?>
<configuration><configSections><section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/></configSections><log4net><root></root><appender name="InfoAppender" type="log4net.Appender.RollingFileAppender,log4net" ><param name="File" type="" value="Log/Error/" /><param name="AppendToFile" value="true" /><param name="RollingStyle" value="Date" /><param name="DatePattern" value="yyyyMMdd&quot;.ini&quot;" /><param name="StaticLogFileName" value="false" /><layout type="log4net.Layout.PatternLayout,log4net"><param name="ConversionPattern" value="[%d]%n%m%n" /></layout></appender><appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender"><bufferSize value="0" /><connectionType value="System.Data.SQLite.SQLiteConnection,System.Data.SQLite" /><connectionString value="Data Source=C:UsersxiketangDesktopthinger.com.Log4NetSQLiteProthinger.com.Log4NetSQLiteProbinDebugDataBaseLog4NetSQLite.db;Version=3;" /><commandText value="INSERT INTO Log (Date, Level, Logger, Message) VALUES (@Date, @Level, @Logger, @Message)" /><parameter><parameterName value="@Date" /><dbType value="DateTime" /><layout type="log4net.Layout.RawTimeStampLayout" /></parameter><parameter><parameterName value="@Level" /><dbType value="String" /><layout type="log4net.Layout.PatternLayout"><conversionPattern value="%level" /></layout></parameter><parameter><parameterName value="@Logger" /><dbType value="String" /><layout type="log4net.Layout.PatternLayout"><conversionPattern value="%logger" /></layout></parameter><parameter><parameterName value="@Message" /><dbType value="String" /><layout type="log4net.Layout.PatternLayout"><conversionPattern value="%message" /></layout></parameter></appender><logger name="Error"><level value="ERROR" /><appender-ref ref="InfoAppender" /></logger><logger name="Info"><level value="INFO" /><appender-ref ref="AdoNetAppender" /></logger></log4net>
</configuration>

bufferSize：日志缓存写入条数设置为0时只要有一条就立刻写到数据库

connectionString：SQLite指向的是数据库文件的绝对路径

LogHelper类中增加一个Info方法，如下所示：

        public static void Info(string message){ILog log = LogManager.GetLogger("Info");if (log.IsInfoEnabled){log.Info(message);}}

在SQLite存储按钮事件下，调用Info日志写入，如下所示：

        private void btn_SQLite_Click(object sender, EventArgs e){//日志信息写入数据库LogHelper.Info(this.txt_SQLite.Text.Trim());}

执行完成后，打开数据库，查看是否有相关记录：

5、实际应用

通过上面一系列的描述，相信大家对Log4Net的应用有了一些了解，Log4Net构建的日志系统是很多项目必备的一个功能，对项目开发、调试及后续维护都有着至关重要的作用。实际使用时，我们还可以将Log4Ne作为一个简单的数据存储工具，甚至可以使用Log4Net做多表多库存储，这些内容后续再给大家进行介绍。