C#利用log4net和sqlite数据库记载日志

1 安装包

两个包：

• log4net
  
• System.Data.SQLite
  

第二个包也可以利用Microsoft.Data.Sqlite，查到的资料显示假如情况利用的是 .NET Core 或 .NET 5+，则建议利用Microsoft.Data.Sqlite。但是我并没有测试第二个包，可能利用上有区别。
2 下载Sqlite

假如本地没有sqlite情况的话，需要先下载。官网下载链接
进去之后直接找各自情况对应的版本，假如是windows情况的话，直接下载下图中标记的tool，中间那个下载链接是下载sqlite3.dll，不过我并不清楚如何利用。

tool解压之后有如下几个文件，双击打开sqlite3.exe即可。

3 Sqlite常用命令

打开是一个命令行界面，可以利用.help查看常用的命令及解释。

1. .help

复制代码

创建数据库文件利用.open xxx，这条语句，假如发现数据库文件存在，就会直接打开，假如不存在，就会先创建再打开。

1. .open test.db

复制代码

在目录内可以看到创建的数据库文件。

.databases可以查询所有数据库文件

.tables可以查询所有表（我还未创建，所以现在还没有表）

sql语句的话可以查询相干资料。
查询的数据以标准格式显示。

1. .header on
2. .mode column
3. SELECT * FROM COMPANY;

复制代码

当然sqlite也有可视化的软件，但是我现在没用到，所以没有下载安装，需要的话可以自行查询。
4 创建日志相干基本表

利用命令创建日志表，包含id（利用自增，当然可以换成uuid或者其它形式）、日期、线程号、级别（info、error这些）、记载者、具体记载的信息、异常信息。具体内容要对应log4net的设置。

1. CREATE TABLE Log (
2.   Id INTEGER PRIMARY KEY AUTOINCREMENT,
3.   Date DATETIME,
4.   Thread VARCHAR(255),
5.   Level VARCHAR(50),
6.   Logger VARCHAR(255),
7.   Message TEXT,
8.   Exception TEXT
9. );

复制代码

5 log4net设置

更换数据库连接。sql语句的内容对应数据库基本表的字段。

1. <configuration>
2.   <configSections>
3.     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
4.   </configSections>
6.   <log4net>
7.     <appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">
8.       <bufferSize value="1" />
9.       <connectionType value="System.Data.SQLite.SQLiteConnection, System.Data.SQLite" />
10.       <connectionString value="Data Source=./database/logs.db;Version=3;" />
11.       <commandText value="INSERT INTO Log (Date, Thread, Level, Logger, Message, Exception) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception)" />
12.       
13.       <parameter>
14.         <parameterName value="@log_date" />
15.         <dbType value="DateTime" />
16.         <layout type="log4net.Layout.RawTimeStampLayout" />
17.       </parameter>
18.       <parameter>
19.         <parameterName value="@thread" />
20.         <dbType value="String" />
21.         <size value="255" />
22.         <layout type="log4net.Layout.PatternLayout">
23.           <conversionPattern value="%thread" />
24.         </layout>
25.       </parameter>
26.       <parameter>
27.         <parameterName value="@log_level" />
28.         <dbType value="String" />
29.         <size value="50" />
30.         <layout type="log4net.Layout.PatternLayout">
31.           <conversionPattern value="%level" />
32.         </layout>
33.       </parameter>
34.       <parameter>
35.         <parameterName value="@logger" />
36.         <dbType value="String" />
37.         <size value="255" />
38.         <layout type="log4net.Layout.PatternLayout">
39.           <conversionPattern value="%logger" />
40.         </layout>
41.       </parameter>
42.       <parameter>
43.         <parameterName value="@message" />
44.         <dbType value="String" />
45.         <size value="4000" />
46.         <layout type="log4net.Layout.PatternLayout">
47.           <conversionPattern value="%message" />
48.         </layout>
49.       </parameter>
50.       <parameter>
51.         <parameterName value="@exception" />
52.         <dbType value="String" />
53.         <size value="2000" />
54.         <layout type="log4net.Layout.ExceptionLayout" />
55.       </parameter>
56.     </appender>
58.     <root>
59.       <level value="ALL" />
60.       <appender-ref ref="AdoNetAppender" />
61.     </root>
62.   </log4net>
63. </configuration>

复制代码

6 日志记载

把生成的db文件拷到步伐里，这个文件就是记载文件的数据库了，其它的都不告急。当然，假如想查看数据库的话，也可以把sqlite3.exe拷过来。
读取log4net的设置建议写在AssemblyInfo.cs，这样步伐启动时会默认加载设置文件。

1. //Log4net配置
2. [assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch = true)]

复制代码

具体步伐如下：

1. private static readonly ILog log = LogManager.GetLogger(typeof(Form1));
3. log.Info("这是一条info语句");
4. log.Warn("这是一条warn语句");
5. log.Error("这是一条错误语句", new Exception("测试异常"));

复制代码

查看日志是否正常写入数据库。

7 利用C#步伐查询sqlite

步伐如下：

1. // 构建连接字符串
2. string connectionString = $"Data Source=./database/SoftWareBaseLog.db;Version=3;";
4. // 创建 SQLite 连接
5. using (var connection = new SQLiteConnection(connectionString))
6. {
7.     connection.Open();
9.     // 创建 SQL 命令
10.     string sql = "SELECT Message FROM Log where Level='ERROR'";
11.     using (var command = new SQLiteCommand(sql, connection))
12.     {
13.         // 执行命令并读取数据
14.         using (var reader = command.ExecuteReader())
15.         {
16.             while (reader.Read())
17.             {
18.                 string msg = reader.GetString(0);
19.                 Console.WriteLine(msg);
20.             }
21.         }
22.     }
23. }

复制代码

8 实时显示日志

现在所有日志都写到数据库里了，那要是还想实时显示到界面上，当然也有很多方式实现，不过我这里建议实时显示可以利用log4net的自有功能。
好比我想利用winform中的listbox来实时显示日志，可以建立一个Appender（附加），继承于log4net的AppenderSkeleton，这是一个抽象类，有一个抽象方法。
具体的，可以参考以下步伐，这里会显示所有的日志，假如需要过滤的话，可以在这个基础上改。另外，一定一定一定要给this.Layout赋值，这是日志在界面上的显示方式，假如没有写的话，就会劳绩一个报错：“A layout must be set”，去网上搜这条内容，不一定能找到办理方案。

1. public class ListBoxAppender : AppenderSkeleton
2. {
3.     private ListBox _ListBox;
5.     public ListBoxAppender(ListBox box)
6.     {
7.         _ListBox = box;
8.         this.Layout = new PatternLayout("%date [%thread] %-5level %logger - %message%newline");
9.     }
11.     protected override void Append(LoggingEvent loggingEvent)
12.     {
13.         // 获取日志信息
14.         string logMessage = RenderLoggingEvent(loggingEvent);
16.         // 更新 UI 控件
17.         if (_ListBox.InvokeRequired)
18.         {
19.             _ListBox.Invoke(new Action(() => AppendText(logMessage)));
20.         }
21.         else
22.         {
23.             AppendText(logMessage);
24.         }
25.     }
27.     private void AppendText(string text)
28.     {
29.         _ListBox.Items.Add(text);
30.     }
31. }

复制代码

只需要给log4net设置一次就可以利用，这样，每次调用日志记载，界面上的lbxLog控件就可以一直显示最新的日志信息。

1. // 添加自定义 Appender
2. var listBoxAppender = new ListBoxAppender(lbxLog);
3. log4net.Config.BasicConfigurator.Configure(listBoxAppender);

复制代码

但是，测试出现了标题，在多线程、短时间添加多条日志的情况下会导致界面卡死，猜测是多条日志抢一个listbox的索引出现的标题，更好的方案是添加缓存机制，生产者-消耗者模式。
生产者只记载到队列里即可，这里为了避免队列堆积，利用了定长的一个概念，太多的日志堆积会丢掉一部份数据。

1. public class LogQueueAppender : AppenderSkeleton
2. {
3.     /// <summary>
4.     /// 锁对象
5.     /// </summary>
6.     private static readonly object _lock = new object();
8.     private static LogQueueAppender Instance { get; set; }
10.     /// <summary>
11.     /// 日志队列
12.     /// 不再直接更新控件，在日志频繁时会出现控件卡死的情况
13.     /// </summary>
14.     private ConcurrentQueue<string> LogQueue { get; } = new ConcurrentQueue<string>();
16.     private LogQueueAppender()
17.     {
18.         //Layout必须赋值，否则会报错
19.         this.Layout = new PatternLayout("%date [%thread] %-5level %logger - %message%newline");
20.     }
22.     /// <summary>
23.     /// 获取实体对象
24.     /// </summary>
25.     /// <returns></returns>
26.     public static LogQueueAppender GetInstance()
27.     {
28.         if (Instance == null)
29.         {
30.             lock (_lock)
31.             {
32.                 if (Instance == null)
33.                 {
34.                     Instance = new LogQueueAppender();
35.                 }
36.             }
37.         }
39.         return Instance;
40.     }
42.     /// <summary>
43.     /// 获取日志队列
44.     /// </summary>
45.     /// <returns></returns>
46.     public ConcurrentQueue<string> GetLogQueue()
47.     {
48.         return LogQueue;
49.     }
51.     /// <summary>
52.     /// 覆写Append方法
53.     /// </summary>
54.     /// <param name="loggingEvent"></param>
55.     protected override void Append(LoggingEvent loggingEvent)
56.     {
57.         // 获取日志信息
58.         string logMessage = RenderLoggingEvent(loggingEvent);
59.         AppendText(logMessage);
60.     }
62.     /// <summary>
63.     /// 添加日志信息
64.     /// </summary>
65.     /// <param name="text"></param>
66.     private void AppendText(string text)
67.     {
68.         //最多存储200条日志，多余的会直接丢弃
69.         if (LogQueue.Count >= 200)
70.         {
71.             LogQueue.TryDequeue(out string message);               
72.         }
73.         LogQueue.Enqueue(text);
74.     }

复制代码

而消耗者负责将日志信息更新到界面上，这里每次只更新一条日志信息，我认为足够了，当然这可以改成一次更新多条信息，避免日志堆积。

1. /// <summary>
2. /// 读取日志信息
3. /// </summary>
4. private void LoadLog()
5. {
6.     LogThreadRunFlag = true;
7.     Task.Factory.StartNew(() => {
8.         while (LogThreadRunFlag == true)
9.         {
10.             bool flag = LogQueueAppender.GetInstance().GetLogQueue().TryDequeue(out string log);
11.             if (flag)
12.             {
13.                 lvwLog.Invoke(new Action(() => AppendText(log)));
14.             }
15.             Thread.Sleep(50);
16.         }
17.     }, TaskCreationOptions.LongRunning);           
18. }
20. /// <summary>
21. /// 添加到界面中
22. /// </summary>
23. /// <param name="text">日志信息</param>
24. private void AppendText(string text)
25. {
26.     if (lvwLog.Items.Count == 100)
27.     {
28.         lvwLog.Items.Clear();
29.     }
30.     lvwLog.Items.Add(text);
31.     if (text.Contains("ERROR"))
32.     {
33.         lvwLog.Items[lvwLog.Items.Count - 1].ForeColor = Color.Red;
34.     }
35. }

复制代码

另外，控件换成了listview，因为这个可以很方便地“高亮”错误日志。相干listview的设置如下：

1. lvwLog.View = View.Details; // 设置为竖向排列
2. lvwLog.Scrollable = true; // 确保滚动条可用
3. lvwLog.Columns.Add("日志信息", -2);   //添加一列数据，并占满全行
4. lvwLog.DoubleBuffered(true);    //使用双缓冲，避免闪烁

复制代码

结果如下：

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。