项目源文件下载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

 

 

ASP.NET Core2基于RabbitMQ对Web前端实现推送功能

 

在我们很多的Web应用中会遇到需要从后端将指定的数据或消息实时推送到前端，通常的做法是前端写个脚本定时到后端获取，或者借助WebSocket技术实现前后端实时通讯。因定时刷新的方法弊端很多（已不再采用），所以基于WebSocket技术实现的通讯方案正越来越受大家喜爱，于是在ASP.NET中就有了鼎鼎大名的Signalr。但Signalr不是咱们这里的主角，这里将给大家介绍另一套基于WebSocket的前后端通讯方案，可以给大家在应用中多一个选择。

 

准备

在开始动手前，咱们先简单介绍下方案的组成部分，如下：

RabbitMQ：是一个成熟的MQ队列服务，由 Erlang 语言开发的 AMQP 的开源实现。这里用来接收后端的指令并广播到前端（基于topic模式）。关于更多RabbitMQ的实现可以查看我另一篇文章，传送门

RabbitMQ插件stomp：是一个让RabbitMQ支持stomp协议的插件，必需安装后才能通过RabbitMQ实现前端通讯。安装说明在此：http://www.rabbitmq.com/stomp.html

stomp.js：是一个基于stomp协议的客户端实现，底层基于WebSocket通讯协议。这里用于前端实现WebSocket通讯。官网地址：https://github.com/jmesnil/stomp-websocket

Lezhima.Rest：是一个基于ASP.NET Core2的Web Api后端程序，用来模拟向前端发送指令。

Lezhima.Site：是一个纯前端技术的前端程序，用来模拟前端实时接收后台的指令。

 

实现

如上面所述，我们已经清楚了整个实现思路，那么下面就来看看具体的代码实现吧。

1、首先来看看Lezhima.Rest的MQ生产者代码，如下：

复制代码
  1 /// <summary>
  2 /// MQ生产者，采用topic模式推送指定内容
  3 /// </summary>
  4 /// <param name="objText"></param>
  5 public static void PushMessage(string objText)
  6 {
  7     //创建MQ连接工厂
  8     var factory = new ConnectionFactory()
  9     {
 10         HostName = "localhost",
 11         Port = 5672,
 12         UserName = "fans",
 13         Password = "123456"
 14     };
 15     //创建MQ连接
 16     using (var connection = factory.CreateConnection())
 17     using (var channel = connection.CreateModel())
 18     {
 19         //绑定交换器
 20         channel.ExchangeDeclare(exchange: "topic/test", type: "topic");
 21         var body = Encoding.UTF8.GetBytes(objText);
 22         //对指定routingkey发送内容
 23         channel.BasicPublish(exchange: "amq.topic",
 24                             routingKey: "test",
 25                             basicProperties: null,
 26                             body: body);
 27     }
 28 }
复制代码

 

2、Lezhima.Site的前端代码，如下：

复制代码
  1 <!DOCTYPE html>
  2 <html>
  3 <head>
  4     <meta charset="utf-8">
  5     <link href="main.css" rel="stylesheet" type="text/css" />
  6     <script src="Script/jquery.js"></script>
  7     <script src="stomp.js"></script>
  8     <style>
  9 
 10         .box {
 11             width: 440px;
 12             float: left;
 13             margin: 0 20px 0 20px;
 14         }
 15         .box div, .box input {
 16             border: 1px solid;
 17             -moz-border-radius: 4px;
 18             border-radius: 4px;
 19             width: 100%;
 20             padding: 5px;
 21             margin: 3px 0 10px 0;
 22         }
 23 
 24         .box div {
 25             border-color: grey;
 26             height: 300px;
 27             overflow: auto;
 28         }
 29 
 30         div code {
 31             display: block;
 32         }
 33 
 34         #first div code {
 35             -moz-border-radius: 2px;
 36             border-radius: 2px;
 37             border: 1px solid #eee;
 38             margin-bottom: 5px;
 39         }
 40     </style>
 41 </head>
 42 <body lang="en">
 43     <div id="first" class="box">
 44         <h2>接收来自后端的消息</h2>
 45         <div></div>
 46     </div>
 47     <script>
 48         var has_had_focus = false;
 49         //封装个接收呈现方法
 50         var pipe = function (el_name) {
 51             var div = $(el_name + ' div');
 52             var print = function (m) {
 53                 div.append($("<code>").text('后端的指令：'+ m));
 54                 div.scrollTop(div.scrollTop() + 10000);
 55             };
 56             return print;
 57         };
 58 
 59         //RabbitMQ的服务地址
 60         var mqUrl = "ws://localhost:15674/ws";
 61         //声明个Stompjs客户端
 62         var client = Stomp.client(mqUrl);
 63 
 64         var print_first = pipe('#first', function (data) {
 65             client.send('/topic/test', { "content-type": "text/plain" }, data);
 66         });
 67 
 68         //监听连接事件
 69         var on_connect = function (x) {
 70             id = client.subscribe("/topic/test", function (d) {
 71                 print_first(d.body);
 72             });
 73         };
 74         var on_error = function () {
 75             console.log('error');
 76         };
 77         //连接MQ
 78         client.connect('fans', '123456', on_connect, on_error, '/');
 79 
 80     </script>
 81 </body>
 82 </html>
 83
复制代码

 

3、分别运行“Lezhima.Rest”与“Lezhima.Site”程序后，效果是这个样子的，如下：

1543044548(1)

 

总结

1、借助RabbitMQ实现前后端通讯功能时，必需先安装RabbitMQ插件stomp，通过该插件可使RabbitMQ支持WebSocket通讯能力。而我们的后端开发人员只需通过“生产者”方法按需向MQ发送数据即可，MQ将根据routingKey广播给所有客户端（消费者）。

2、前端借助stomp.js可以简便的实现与RabbitMQ通讯，并绑定相应的routingKey后承担MQ消费者的能力，以达到前后端即时推送的效果。