文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

C#如何使用日志组件log4net

2023-07-01 00:44

关注

本篇内容介绍了“C#如何使用日志组件log4net”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!

一、概述

log4net库是Apache log4j框架在Microsoft .NET平台的实现,是一个帮助程序员将日志信息输出到各种目标(控制台、文件、数据库等)的工具。

1、下载与版本

Apache log4net ™,最新版本log4net 2.0.8

2、Log4net的结构

log4net 有四种主要的组件,分别是Logger(记录器), Repository(库), Appender(附着器)以及 Layout(布局)。

3、日志的级别

如果没有定义LEVEL的值,则缺省为DEBUG。

比如:定义一个日志对象,设置级别为INFO,表示比INFO级别高(或相等)的日志将被记录。即log.Info(“XX”)将记录,log.Debug(“**”)不记录

二、建立log4net配置文件

config/log4net.config文件:

<log4net>  <root>    <level value="INFO" />    <appender-ref ref="RollingFileAppender" />    <appender-ref ref="ColoredConsoleAppender" />  </root>  <logger name="MessageHandler">    <level value="ERROR" />    <appender-ref ref="SmtpAppender" />  </logger>  <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">    <file value="Log\pamsdc" />    <threshold value="INFO" />    <appendToFile value="true" />    <rollingStyle value="Composite" />    <datePattern value="yyyyMMdd" />    <maxSizeRollBackups value="100"></maxSizeRollBackups>    <layout type="log4net.Layout.PatternLayout">      <header value="[Header]" />      <footer value="[Footer]" />      <conversionPattern value="%date [%thread] %-5level %logger [%ndc] <%property{auth}> - %message%newline" />    </layout>  </appender>  <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">    <mapping>      <level value="WARN" />      <foreColor value="White" />      <backColor value="Red, HighIntensity" />    </mapping>    <layout type="log4net.Layout.PatternLayout">      <header value="[Header]" />      <footer value="[Footer]" />      <conversionPattern value="%date [%thread] %-5level %logger [%ndc] <%property{auth}> - %message%newline" />    </layout>  </appender>  <appender name="SmtpAppender" type="log4net.Appender.SmtpAppender,log4net">    <to value="" />    <from value="GPEHZ-MIS@GoldPeak" />    <subject value="PAMS DC 致命错误" />    <smtpHost value="192.50.6.248" />    <bufferSize value="32" />    <lossy value="true" />    <Authentication value="Basic"/>    <Username value="GPEHZ-MIS@GoldPeak"/>    <Password value=""/>    <evaluator type="log4net.Core.LevelEvaluator,log4net">      <threshold value="ERROR" />    </evaluator>    <layout type="log4net.Layout.PatternLayout,log4net">      <conversionPattern value="日期:%date 线程:[%thread] 级别: %-5level 类:%logger [%ndc] < %property{auth}> - 消息:%message%newline" />    </layout>  </appender></log4net>

1、配置文件

配置信息一般放在单独的配置文件中,也可以放在在程序的配置文件里,如app.config 或web.config. 或者任意文件中。 
log4net框架会在相对于AppDomain.CurrentDomain.BaseDirectory 属性定义的目录路径下查找配置文件。

框架在配置文件里要查找的唯一标识是标签。一个完整的配置文件的例子如下:

<?xml version="1.0" encoding="utf-8" ?><configuration>  <configSections>    <section name="log4net"  type="log4net.Config.Log4NetConfigurationSectionHandler,            log4net-net-1.0" />  </configSections>  <log4net>    ..  </log4net></configuration>

2、Logger

Logger是应用程序需要交互的主要组件,它用来产生日志消息。产生的日志消息并不直接显示,还要预先经过Layout的格式化处理后才会输出。 
Logger提供了多种方式来记录一个日志消息,你可以在你的应用程序里创建多个Logger,每个实例化的Logger对象都被log4net框架作为命名实体(named entity)来维护。这意味着为了重用Logger对象,你不必将它在不同的类或对象间传递,只需要用它的名字为参数调用就可以了。

log4net框架使用继承体系,在框架的体系里所有的日志对象都是根日志(root logger)的后代。也就是说,如果有两个logger,分别被定义为a.b.c和a.b,那么我们说a.b是a.b.c的祖先。每一个logger都继承了祖先的属性 。这种缺省的继承方式也可以通过显式地设定标签的additivity属性为false而改变。 
Log4net框架定义了一个ILog接口,所有的logger类都必须实现这个接口。如果你想实现一个自定义的logger,你必须首先实现这个接口。

Log4net框架定义了一个叫做LogManager的类,用来管理所有的logger对象。它有一个GetLogger()静态方法,用我们提供的名字参数来检索已经存在的Logger对象。如果框架里不存在该Logger对象,它也会为我们创建一个Logger对象。代码如下所示: 

log4net.ILog log = log4net.LogManager.GetLogger("logger-name");

通常来说,我们会以类(class)的类型(type)为参数来调用GetLogger(),以便跟踪我们正在进行日志记录的类。

3、Appender

一个好的日志框架应该能够产生多目的地的输出。比如说输出到控制台或保存到一个日志文件。log4net 能够很好的满足这些要求。它使用一个叫做Appender的组件来定义输出介质。正如名字所示,这些组件把它们附加到Logger日志组件上并将输出传递到输出流中。你可以把多个Appender组件附加到一个日志对象上。 Log4net框架提供了几个Appender组件。

关于log4net提供的Appender组件的完整列表可以在log4net框架的帮助手册中找到。有了这些现成的Appender组件,一般来说你没有必要再自己编写了。但是如果你愿意,可以从log4net.Appender.AppenderSkeleton类继承。

log4net的各种Appender配置示例

http://logging.apache.org/log4net/release/config-examples.html

输出方式主要包括:

4、PatternLayout中的转换模式

例如,转换模式为%r [%t]%-5p %c - %m%n 的 PatternLayout 将生成类似于以下内容的输出: 
176 [main] INFO org.foo.Bar - Located nearest gas station.

三、定义配置文件

当我们创建了上面的配置文件后,我们接下来需要把它和我们的应用联系起来。缺省的,每个独立的可执行程序集都会定义它自己的配置。

log4net框架使用 log4net.Config.XmlConfiguratorAttribute在程序集的级别上定义配置文件。

1、在Winfrom中,在AssemblyInfo.cs中添加如下代码:

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch = true)]//关联log4net.config文件//或者[assembly: log4net.Config.XmlConfigurator(ConfigFileExtension = "log4net", Watch = true)]//关键到xxx.exe.log4net或xxx.dll.log4net,并监测变化。

2、在asp.net中,在Global.asax文件中的Application_Start方法中增加:

log4net.Config.XmlConfigurator.Configure(new System.IO.FileInfo("log4net.config"));//或者log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo(Server.MapPath(@”Config.log4net.config”)))

四、调用log4net写日志

1、创建或获取日志对象

日志对象会使用在配置文件里定义的Logger的Name属性。如果某个日志对象没有事先在配置文件里定义,那么框架会根据继承结构获取祖先节点的属性,最终的,会从根root日志获取属性。如下所示:

Log4net.ILog log = Log4net.LogManager.GetLogger("MyLogger"); //或Log4net.ILog log = Log4net.LogManager.GetLogger(typeof(_Default));//或Log4net.ILog log = Log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

2、输出日志信息

if (log.IsDebugEnabled)    log.Debug("message"); if (log.IsInfoEnabled)    log.Info("message); log.Logger.Repostory.Shutdown()//关闭日志

五、更改Appender设置

1、获取root的Appender

log4net.Repository.Hierarchy.Hierarchy h = (log4net.Repository.Hierarchy.Hierarchy)log4net.LogManager.GetRepository();log4net.Appender.AppenderCollection ac = h.Root.Appenders;

2、获取指定Logger的Appender:不包括继承的Appender

log4net.ILog logger = log4net.LogManager.GetLogger(typeof(_Defaut));log4net.Appender.AppenderCollection ac = ((log4net.Repository.Hierarchy.Logger)logger.Logger).Appenders;

3、更改Appender设置

for (int i = 0; i < ac.Count; i++){    log4net.Appender.RollingFileAppender rfa = ac[i] as log4net.Appender.RollingFileAppender;    if (rfa != null)    {        rfa.File = "xxx.log";//程序运行时动态的设定log日志的文件名        rfa.Writer = new System.IO.StreamWriter(rfa.File, rfa.AppendToFile, rfa.Encoding);    } }

六、自定义appender

日志保存于内存中,到一定阈值之后才将数据post到服务器,同时可配置服务端接受数据的地址

1、定义myMemAppender类

public class MyMemAppender : AppenderSkeleton{    private ArrayList eventQueue;    public string RemoteAddress { get; set; }    public int QueueSize { get; set; }    public MyMemAppender() : base()    {        eventQueue = new ArrayList();    }    protected override void Append(log4net.Core.LoggingEvent loggingEvent)    {        lock (eventQueue.SyncRoot)        {            eventQueue.Add(loggingEvent);            if (eventQueue.Count >= QueueSize)            {                lock (eventQueue.SyncRoot)                {                    SaveToServer();                    eventQueue.Clear();                }            }        }    }    private void SaveToServer()    {        lock (eventQueue.SyncRoot)        {            List logList = new List();            foreach (log4net.Core.LoggingEvent evt in eventQueue)            {                try                {                    LogModel m = Newtonsoft.Json.JsonConvert.DeserializeObject(evt.RenderedMessage);//或者evt.MessageObject as LogModel                    logList.Add(m);                }                catch (Exception ex)                {                    Console.Write(ex.ToString());                    continue;                }            }            //将logList序列化上传至remoteAddress        }    }    virtual public LoggingEvent[] GetEvents()    {        lock (eventQueue.SyncRoot)        {            return (LoggingEvent[])eventQueue.ToArray(typeof(LoggingEvent));        }    }}

2、注册Appender

(1)root根目录下追加

配置文件方式:

<?xml version="1.0" encoding="utf-8" ?><log4net debug="true"><appender name="myMemAppender" type="LogSystem.Common.MyMemAppender">    <param name="QueueSize" value="10"/>    <param name="RemoteAddress" value="http://localhost/PostLogData.aspx"/></appender><root>   <level value="ALL"/>   <appender-ref ref="myMemAppender" /></root></log4net>

代码方式:

MyMemAppender appender = new MyMemAppender();appender.QueueSize = 5;appender.RemoteAddress = "http://localhost:57427/PostLogData.aspx";log4net.Config.BasicConfigurator.Configure(appender);ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

(2)指定Logger名下追加Appender:

MyMemAppender appender = new MyMemAppender();appender.Name = "MyMemAppender";appender.QueueSize = 5;appender.RemoteAddress = "http://localhost:57427/PostLogData.aspx";Logger logger1 = (Logger)LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);logger1.Level = Level.Info;IAppender appendered = logger1.GetAppender("MyMemAppender");if (appendered != null) logger1.RemoveAppender("MyMemAppender");logger1.AddAppender(appendered);appender.ActivateOptions();

“C#如何使用日志组件log4net”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识可以关注编程网网站,小编将为大家输出更多高质量的实用文章!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯