美学原理日记记录工具

当软件开发、测试和生产条件遭到,日志记录是杀重大的,采用合适的日记记录工具、设计合理之日记输出格式,有利于帮助开发人员明确程序的履流程与错误的高效稳定及更正。日志记录作为软件开发周期中之第一组成部分,本文介绍几种植常用的日记记录工具: 

  • log4net
  • NLog
  • log4j
  • SLF4J

其间,log4net 和 NLog 主要用以 C#/.net 平台,log4j 和 SLF4J 主要用来
Java 开发。

log4net

参考:Apache log4net
官网;

免费的开源日志记录组件,log4net 库是基于 Apache log4j 框架在 Microsoft
.NET 平台的实现。

关于 log4net 的核心介绍,可以瞻仰:log4net Tutorial –
CodeProject;

特点

  •  Distinct Goals: speed and flexibility
  •  多种路线输出:日志信息输出及:[1]. 控制台;[2]. 文件;[3].
    数据库;
  •  支持多 .Net 框架,支持多日记信息等,支持多格式输出
  •  XML Configuration + Dynamic Configuration

主干用

log4net.dll 引用 + 配置文件 log4net.xml

当下,最新版本的 .dll 文件是:log4net
2.0.8

本有的重点研究 log4net 的部署文件:log4net.xml

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

  <log4net>
    <root>
      <level value="ALL" />
      <appender-ref ref="RollingLogFileAppender" />
      <appender-ref ref="ColoredLogConsoleAppender" />
    </root>

    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender,log4net">
      <param name="File" value="Log\" />
      <param name= "AppendToFile" value= "true" />
      <param name= "DatePattern" value= "yyyyMMdd".log"" />
      <param name= "RollingStyle" value= "Date" />
      <param name="StaticLogFileName" value="false" />
      <lockingModel type="log4net.Appender.FileAppender.MinimalLock" />
      <layout type="log4net.Layout.XMLLayout,log4net">
        <param name="Header" value="" />
        <param name="Footer" value="" />
        <param name="ConversionPattern" value="[%d] [%t] %-5p %c-(%line)  %m%n" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
         <param name="LevelMin" value="ALL" />
         <param name="LevelMax" value="OFF" />
      </filter>
    </appender>

    <appender name="ColoredLogConsoleAppender" type="log4net.Appender.ColoredConsoleAppender,log4net">      
      <mapping>
        <level value="INFO" />
        <foreColor value="Grey" />
      </mapping>
      <mapping>
        <level value="WARN" />
        <foreColor value="Green" />
      </mapping>
      <mapping>
        <level value="ERROR" />
        <foreColor value="Red, HighIntensity" />
      </mapping>
      <layout type="log4net.Layout.PatternLayout,log4net">
         <param name="ConversionPattern" value="[%d] [%t] %-5p %c-(%line) %m%n" />
      </layout>
    </appender>
  </log4net>
</configuration>

首先针对 log4net 配置文件之格式作说明,以下简单种艺术是当价格的:

<param name="keyName" value="valueName" />
<keyName value="valueName" />

脚对 .xml 文件被几乎单重点标签作说明:

[0.1].RollingFileAppender

RollingFileAppender 基于 FileAppender,FileAppender 和
RollingFileAppender 都是为此来以日志写副到文本文件中,RollingFileAppender
提供更多之支配选项

[0.2].ColoredConsoleAppender

ColoredConsoleAppender 基于
ConsoleAppender,ConsoleAppender
和 ColoredConsoleAppender 都是因此来以日志写副到控制台,ColoredConsoleAppender 提供再多的操纵选项 

[1].level

日记信息控制级别,由没有到高 ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF,默认
DEBUG,只记录 >=level 的日志信息

个中,ALL表示同意持有的日记请求,OFF表示拒绝所有的求

[2].appender-ref

概念日志对象所使用的 Appender

[3].RollingStyle

日记文件滚动方式,支持 Date、Size、Composite 三栽样式,具体地:

  •  Date:日期滚动,每天一个日志文件
  •  Size:文件大小滚动,匹配如下 2 单参数:
    •  MaximumFileSize:日志文件大小限制,支持 KB|MB|GB
    •  MaxSizeRollBackups:日志文件个数限制,默认 ``-1 表示无限制
  •  Composite:Date + Size 的合体版,适于日志量比较大的状

[4].layout

日记信息输出格式,支持 XMLLayout、PatternLayout,具体地:

  •  PatternLayout:经典格式
  •  XMLLayout:XML格式

至于 Layout 的详细信息,参见下的 深入理解 – Layout 部分。

[5].lockingModel

文本锁类型,允许多独过程可以写副同一个文本,RollingFileAppender
本身不是线程安全的,若在程序中没有进展线程安全范围,可于此地配置、确保写副安全。支持有限种植档次:

  •  ExclusiveLock:排它锁
  •  MinimalLock:最小锁定

外,需要留意的几只问题

// 如果是网站项目,须在项目中的 AssemblyInfo.cs 文件的最后一行中添加
[assembly: log4net.Config.DOMConfigurator(ConfigFile = "Web.config", Watch = true)] 

于 log4net 中,最常用之是 RollingFileAppender,各种常用的不同配置参见:Log4net中的RollingFileAppender解析;

下面是 log4net 的主导调用方法:读取 log4net.xml 文件,日志信息记录。

using log4net;

namespace log4net_sqh
{
    public class Program
    {
        static void Main(string[] args)
        {
            string assemblyFilePath = Assembly.GetExecutingAssembly().Location;
            string assemblyDirPath = Path.GetDirectoryName(assemblyFilePath);
            string configFilePath = assemblyDirPath + " \\log4net.xml";
            log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo(configFilePath));

            ILog Logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

            Logger.Fatal("fatal, 严重错误");
            Logger.Error("error, 错误");
            Logger.Warn("warn, 警告");
            Logger.Info("info, 信息");
            Logger.Debug("debug, 调试");           

            Console.Read();
        }
    }
}

连带内容可参见:C#行使Log4Net记录日志;

里面,MethodBase.GetCurrentMethod().DeclaringType
用于取声明该成员的类似。ConfigureAndWatch 方法读取配置文件
log4net.xml,相比 Configure
方法,当配置文件发出浮动时会见重复加载。不同阶段的日志信息记录支持多重载方法:

void Info(object message);
void Info(object message, Exception exception);
void InfoFormat(string format, params object[] args);

下提供如下链接,可以参照:

  • 至于读取 log4net 配置文件,参考:log4net
    配置文件读取方法;
  • 有关 log4net 的配备问题,可详细参考:官方 log4net
    configuration;

除此之外独立使用 log4net.xml 文件作为 log4net
的布置文件外,亦不过径直行使项目自带的 app.config(CS程序)或
web.config(BS程序) 文件,只要用 <log4net> 结点放在 <configuration>
结点中,但 <log4net> 结点必须以 <configSections>
结点的下,否则不见面记日志。

style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”font-size: 14px; color: #000000;”>直接用配备文件 app.Config 或
web.Config 配置使用系统的运作参数,比单独做一个 .xml
配置文件,简洁方便:

  • style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”font-size: 14px; color: #000000;”>提供广泛的
    connectionStrings 和 appSettings,给出 数据库连接 和
    常见的键/值表的定义访问方法
  • style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”color: blue;”> style=”font-family: Consolas; font-size: 9pt;”> style=”color: #a31515;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: red;”> style=”color: black;”> style=”color: black;”> style=”color: #a31515;”> style=”color: #a31515;”> style=”font-size: 14px; color: #000000;”>提供从定义段configSections,可以活动定义段元素,eg.
    log4net、assembly

脚为闹一个 app.config 文件之模板代码:

美学原理 1

运用并宣读取 app.config 文件之布信息,项目应注意:

[1]. 添加引用程序集 System.configuration
[2]. 名称空间添加 using System.Configuration; 

关于加载 log4net.config
配置
文本,可以用不同的办法,相关消息参考:log4net
配置文件配置方式;

(1)Configuration Attributes

拖欠方法经过添加 Assembly
Attribute,在类型的 AssemblyInfo.cs 文件被补充加如下代码,指示程序于 app.config
中读取配置

[assembly: log4net.Config.XmlConfigurator(Watch=true)]

(2)appSettings

拖欠方式在配置文件中上加如下配置

<appSettings>
  <add key="log4net.Config" value="log4net.config"/>
  <add key="log4net.Config.Watch" value="True"/>
</appSettings>

(3)Configuration Files

该办法可经过如下两栽艺术实现

  • Using the .NET System.Configuration API
  • Reading the file contents directly

推荐第一种方式,在次入口采取如下代码

log4net.Config.XmlConfigurator.Configure(new FileInfo("app.config")); 或 
log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo("app.config"));

亚种植办法就是是前方说的单身行使一个 log4net.xml 文件作为配置文件之办法

Only one log4net element can be specified in the xml file, but it may/can be located anywhere in the XML hierarchy. 

随即三种办法,Configuration Files 拥有绝对控制权,appSettings
次之,assembly-level attributes 最弱。

一个不大的恢宏知识

app.configexe.configvshost.exe.config

  • app.config是自定义之布局文件,vshost.exe.config和exe.config是程序运行时自动创建的情跟app.config一样的公文
  • vshost.exe.config是程序运行时用的布文件,exe.config是程序运行后会复制到vshost.exe.config
  • 起app.config复制到exe.config再复制到vshost.exe.config
  • 针对 .config 文件之读写操作,实际是对准 exe.config,该文件必不可少

至于 app.config
文件配置问题,可参看:有关从定义配置结点;

深入明

新型版本的源码文件:log4net-2.0.8-src.zip

log4net 有四个举足轻重组件,分别是:

  • Logger(记录器)
  • Appender(附着器)
  • Layout(布局)
  • Repository(库)

脚分别实际介绍各个零部件:

1
Logger

应用程序交互的关键组件,产生日志消息,日志消息经 Layout
的格式化处理才会输出。

Log4net 框架定义一个 ILog 接口,所有的 logger
类(包括由定义之logger类)都必须实现之接口。

public interface ILog
{
   // 基本方法
   void Debug(object message);
   void Info(object message);
   void Warn(object message);
   void Error(object message);
   void Fatal(object message);

   // 以上的每一个方法都有多个重载的方法,用来支持异常处理及格式化处理
   void Debug(object message, Exception ex);
   void DebugFormat(...);
        ...

   //属性用来检查Logger的日志级别
   bool isDebugEnabled;
        ...
}

Log4net 框架定义一个 LogManager 类,管理有的 logger 对象。该类的
GetLogger() 静态方法,用我们提供的讳创办 Logger 对象要探寻已经存在的
Logger 对象

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

办法 GetLogger() 的入参可以利用由定义的日记名字
“logger-name”,也得采用如下参数作为入参

System.Reflection.MethodBase.GetCurrentMethod().DeclaringType

每当应用程序中可以创建多独 Logger,每个实例化的 Logger 对象都叫 log4net
框架当作命名实体(named entity)来分别维护。 

2
Appender

概念输出介质,log4net 支持多种形式的日志消息输出。

一个 Appender 对象少省地用拥有的日记消息传递到输出流,可以利用 Appender Filters 按照不同之规范过滤日志事件。

3Layout

用以控制 Appender 的出口格式,可以是线性的或者XML,但是一个 Appender
只能有一个 Layout。log4net 支持多 layout:

  • PatternLayout:经典格式,最常因此
  • SimpleLayout:简单格式,只输出日志级别及信内容
  • XMLLayout:XML格式
  • RawTimeStampLayout:可格式化时间,常用于出口及数据库

有关 layout 结点的布局说明:

  • %d:datetime,当前言的日子时,%d{HH:mm:ss,fff} 可以独自展示时间

  • %p:priority,日志级别

  • %m:message,输出的日记消息
  • %n:newline,换行
  • %t:threadid,当前言所在线程ID
  • %c:class,当前日记对象的名称
  • %L:输出语句所在的行号
  • %F:输出语句所在的文件称
  • %-数字:表示该项的太小长,如果不够,则就此空格填充

4
Repository

肩负日志对象组织结构的护。

扩展应用

于攻读 log4net 的尾声,实现 log4net 输出 xml 格式的日志:

  • 使用 log4net 自带的 XmlLayout
  • 自定义 XmlLayout

动用从定义 XmlLayout 格式,务必如下:

  • write a class deriving from XmlLayoutBase,override the FormatXml method
  • instruct your appender with yourXmlLayout

第一为起布局文件 app.config,基本跟齐,layout 使用于定义的 XmlLayout

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

  <log4net>
    <root>
      <level value="ALL" />
      <appender-ref ref="RollingLogFileAppender" />
    </root>

    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender" >
      <param name="File" value="log\" />
      <param name="AppendToFile" value="true" />
      <param name="RollingStyle" value="Date" />
      <param name="datePattern" value="yyyyMMdd'.txt'" />
      <param name="staticLogFileName" value="false" />
      <layout type="MyNamespace.MyXmlLayout">
        <param name="Header" value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;&#13;&#10;&lt;Root&gt;&#13;&#10;" />
        <param name="Footer" value="&lt;/Root&gt;&#13;&#10;" />
      </layout>
    </appender>    
  </log4net>

  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
  </startup>
</configuration>

其中, 表示 \r\n
换行。

下一场,自定义类 MyXmlLayout 继承自 XmlLayoutBase,重写 FormatXml 方法:

namespace MyNamespace {
    public class MyXmlLayout : XmlLayoutBase
    {
        protected override void FormatXml(XmlWriter writer, LoggingEvent loggingEvent)
        {
            // 自定义 XML 文档格式
            ... ...
        }
    }
}

欠方法吃唯独坐从定义显示的 xml 文件内容。其中,类 XmlLayoutBase 定义如下

public abstract class XmlLayoutBase : LayoutSkeleton
{
    protected XmlLayoutBase();

    public override void ActivateOptions() { }
    public override void Format(TextWriter writer, LoggingEvent loggingEvent);
    {
        XmlTextWriter xmlTextWriter = new XmlTextWriter(new ProtectCloseTextWriter(writer));
        xmlTextWriter.Formatting = Formatting.None;
        xmlTextWriter.Namespaces = false;
        this.FormatXml(xmlTextWriter, loggingEvent);
        xmlTextWriter.WriteWhitespace(SystemInfo.NewLine); // 换行
        xmlTextWriter.Close(); // 关闭流
    }

    protected abstract void FormatXml(XmlWriter writer, LoggingEvent loggingEvent);
}

除此之外,主函数调用方式维持不更换。

时至今日,xml
格式日志文件中心不过正常输出。但是该公文或者有缩进、中文格式、xml读取的问题,需做如下修正:

[1].
缩进 XML

在 log4net 的源码 src\Layout\XMLLayoutbase.cs 中,在
Format 方法被上加如下代码

// 注意是使用 XmlTextWriter,而不是 XmlWriter
xmlTextWriter.Formatting = Formatting.Indented;
xmlTextWriter.Indentation = 2;

为中标编译,还亟需改 src\AssemblyInfo.cs 文件,添加 false 关闭
log4net 的大签名

#if fasle && STRONG && (CLI_1_0 || NET_1_0 || NET_1_1 || NETCF_1_0 || SSCLI)
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile(@"..\..\..\log4net.snk")]
#endif

用转的 log4net.dll 文件替换项目受到的 .dll 文件即可。

参考:改 log4net,生成缩进
XML;

[2].
汉语格式

在 log4net 的源码 src\Util\Transform.cs 中,更新如下代码

private static Regex INVALIDCHARS = 
    new Regex(@"[^\x09\x0A\x0D\x20-\xFF\u00FF-\u07FF\uE000-\uFFFD\u4e00-\u9fa5]",RegexOptions.Compiled); 

[3].
XML 读博多少题目

在 log4net 的源码 src\Layout\XMLLayout.cs 中,方法 ActivateOptions 修正如下

将 ":" 全部改成 "_" 

参考:修改
log4net,支持中文格式;

[4].
<Root> 结点问题

眼下转变的 xml 文件,根结点只有 <Root>,没有 </Root>

至于怎么解决,有待于越研究。

时,在行使的当儿要专门处理一下,为 xml 文档添加 </Root>

NLog

免费的 .NET 开源日志框架,NLog
允许打定义从跟踪消息的起源(source)到记录跟踪信息之对象(target)的规则。

有关 NLog
的详细信息,参考官网:NLog;CodeProject –
Introduction to
NLog;

属性特点

  • Easy-to-configure:configuration file or programmatically
  • Templatable:layout renders
  • Extensible:write custom targets or pass custom values
  • 字符串延迟加载
  • 支持异步日志记录

NLog 与 log4net 相比,具体细节而参见:[日志框架对比 NLog VS

Log4net](http://www.cnblogs.com/qinjin/p/DonetLogCompare.html);[两者比较

逗比版](http://www.cnblogs.com/wanglee/archive/2013/05/22/3092474.html);

安排文件

NLog 同 log4net 一样,但是比 log4net 更简单,NLog 使用路由表(routing
table)进行布局,log4net 使用层次性的 appender
配置,同样支撑有限种植形式之布方式

  • 单身的 NLog.Config 配置文件,直接以 <nlog> 作为根结点
  • 当 App.config/Web.config
    文件被补充加 NLog 的配备结点

无采取啊一样栽配备方式,配置内容与动用方法是相同的。配置信息结点包括个别片

  • targets:输出目标,支持 File、Mail、Console、DataBase等,每个
    target 代表一个输出目标,包括2只属性

    • name:输出模板名称,在 <rules> 中采取
    • type:输出类型,NLog can dynamically write to one of multiple
      targets for each log message
  • rules:路由于规则,将日志与出口目标匹配起来
    • name:日志记录者的讳 (允许以通配符*)
    • minlevel/maxlevel:日志范围的最低/高级别
    • level/levels:单一日志级别/一多级日志级别,逗号分隔
    • writeTo:规则匹配时日志信息应于勾勒副的一样密密麻麻目标,由逗号分隔

先是种方式,特别注意不要含中文!

其次种艺术,特别注意在 App.config/Web.config 中必管 <configSections>
结点存在而是根结点 <configuration>
的率先只结点,否则程序会报错:配置体系不能初始化,文件结构形式如下

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="nlog" type="NLog.Config.ConfigSectionHandler, nLog"/>
  </configSections>

  <nlog>
    <targets>
      <target />
    </targets>

    <rules>
      <logger />
    </rules>  
  </nlog>
</configuration>

着力以

NLog.dll 引用 + 配置文件

当下 NLog 的源码最新版本是:NLog 4.4.10 –
Source;

1)添加引用

添加对 NLog 的引用,有 2 种方法

  • 经 Nuget,添加 NLog 和 NLog Configuration 两个文本
  • 工具-Nuget程序包管理器-程序包管理器控制台,输入 Install-Package NLog
    和 Install-Package NLog.config 

要么直接当次中上加 NLog.dll 引用,并 using NLog; 

2)配置结点 <nlog>

配置文件 <nlog>
结点支持多个行程由于规则和输出目标,非常灵活,下面直接吃有结点配置信息

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="nlog" type="NLog.Config.ConfigSectionHandler, nLog"/>
  </configSections>

  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        autoReload="true" 
      throwExceptions="false">
    <targets>
      <!-- 控制台 -->
      <target name="myLogConsole" xsi:type="ColoredConsole"
              layout="${date:format=HH\:mm\:ss}> ${level:padding=-5} ${message}"/>
      <!-- 文件(每天一个日志文件) -->
      <target name="myRollingLogFile" xsi:type="File"
              fileName="${basedir}/Log/${date:format=yyyyMMdd}.txt" keepFileOpen="false"
              layout="${date:format=HH\:mm\:ss} ${level:uppercase=true:padding=-5} ${message}" />
    </targets>

    <rules>
      <logger name="*" minlevel="Debug" writeTo="myLogConsole" />
      <logger name="*" minlevel="Info" WriteTo="myRollingLogFile" />
    </rules>  
  </nlog>
</configuration>

里面,autoReload=”true”
表示自动重新部署,无需更开程序、更新配备信息。

特别提示,在 源码文件\examples\targets\Configuration
File 下有丰富多采的 NLog 配置文件可以参考。

关于对部署文件之扩大使用

[1]. 完完全全结点 <nlog>
配置属性 internalLogLevel 和 internalLogFile

用来查看 NLog
输出日志时之里信息,比如配置文件信息错误等,不过会有效率影响。

[2]. File Archival Based on
Time or Size

Log files can be automatically archived by moving them to another
location after reaching certain size or time.

// 按时间滚动归档
<targets>
    <target name="onTimeFile" xsi:type="File"
        layout="${longdate} ${level:padding=-5} ${message}" 
        fileName="${basedir}/Log/logfile.txt" 
        archiveFileName="${basedir}/Archives/log.{#}.txt"
        archiveEvery="Day"
        archiveNumbering="Rolling"
        maxArchiveFiles="30"
        concurrentWrites="true"
        keepFileOpen="false"
        encoding="iso-8859-2" />
</targets>    

// 按大小滚动归档
<targets>
    <target name="file" xsi:type="File"
        layout="${longdate} ${level:padding=-5} ${message}" 
        fileName="${basedir}/Log/logfile.txt" 
        archiveFileName="${basedir}/Archives/log.{#####}.txt"
        archiveAboveSize="102400" // unit:Byte
        archiveNumbering="Sequence"
        concurrentWrites="true"
        keepFileOpen="false"
        encoding="iso-8859-2" />
</targets>

Archive Numbering 的解释和另配置信息但参见:File target
Configuration;

[3].
Layout:格式化输出(CSV/XML

Layouts provide a way to format the contents of the logs as it is
written to a file. There are 2 main kinds of layouts:

  • simple layout – just a string,which is composed of Layout
    Renderers
  • structural layouts – which can output XML, CSV, and other complex
    formats

第一,CSV 格式的结点配置

<target name="myCsv" xsi:type="File" fileName="${basedir}/file.csv">
  <layout xsi:type="CSVLayout">
     <column name="Time" layout="${longdate}" /> 
     <column name="Level" layout="${level}"/>
     <column name="Message" layout="${message}" />
  </layout>
</target>

脚给出 XML 格式的结点配置

结点如何配置,暂时不明确
仅有的信息可参见:
[1]. Configuring NLog to log exceptions in an XML output?

当程序中调用方法:

namespace NLogSqh {
    public class Program {

        public static NLog.Logger logger = null;        
        public static void Main(string[] args)
        {
            logger = NLog.LogManager.GetCurrentClassLogger();

            logger.Trace("Trace");
            logger.Debug("Debug");
            logger.Info("Info");
            logger.Warn("Warn");
            logger.Error("Error");
            logger.Fatal("Fatal");                                 
        }
    }
}

参考:NLog
学习系列;NLog
文章系列;

log4j

log for java(log4j)是 Apache 的开源项目功能强大的日志组件,Java
编写的笃定、快速和灵活的日记框架(API),主要使用为 Java 项目。

一个细致编排的日志代码提供快捷的调节、维护方便、应用程序的运作时信息结构化存储。

脚下新型的 Generation 是 Apache log4j 2,最新的 Release 是 Log4j
2.8.2,相关代码:

  • binary:apache-log4j-2.8.2-bin.zip
  • source:apache-log4j-2.8.2-src.zip

每当编译前,最好应正确安装 PATH 和
CLASSPATH ,项目被极好以 /src/ 目录下存放 log4j.properties
文件。

特性特点

  • 线程安全
  • 参数配置化
  • 强日记等级,多种输出介质

log4j 包括三只根本组件

  • loggers:记录日志信息
  • appenders:日志记录方式、输出介质等消息
  • layouts:日志信息格式化

下是 log4j 组件虚拟图

美学原理 2

输出介质:支持控制台、文件、数据库等

  • ConsoleAppender:控制台
  • FileAppender:文件
  • RollingFileAppender:文件大小滚动生成日志,达到指定尺寸时生成一个初的日记文件
  • DailyRollingFileAppender:时间滚动生成日志文件
  • WriterAppender:将日志信息为流格式发送至自由指定的地方,eg.
    数据库

核心以

log4j 的累累音讯可参照
log4net,此有小过,往事不要再领取。

Log4j
支持少数种配备文件格式,一栽是XML格式的文本,一种植是Java特性文件(键=值)

log4j 通过 log4j.properties
文件(key-value形式)保存属性配置。默认情况下,日志管理于 CLASSPATH
查找一个名叫吧 log4j.properties 的公文。基本格式如下:

# Define the root logger with appender file
log4j.rootLogger = DEBUG, FILE

# Define the file appender
log4j.appender.FILE = org.apache.log4j.FileAppender
log4j.appender.FILE.File = ${log}/log.out
log4j.appender.FILE.Append = true
log4j.appender.FILE.Threshold= INFO

# Define the layout for file appender 
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout 
log4j.appender.FILE.layout.conversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n

足用上述格式转换为 xml 形式,两者如出一辙

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>

    <appender name="FILE" class="org.apache.log4j.FileAppender">
       <param name="file" value="${log}/log.out" />
       <param name="append" value="true" />
       <layout class="org.apache.log4j.PatternLayout">
          <param name="conversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n" />
       </layout>
    </appender>

    <logger name="log4j.rootLogger" additivity="false">
       <level value="ALL"/>
       <appender-ref ref="FILE"/>
    </logger>

</log4j:configuration>

当 Java 程序中调用如下:

import org.apache.log4j.Logger;

import java.io.*;
import java.sql.SQLException;
import java.util.*;

public class log4jExample
{
   public static void main(String[] args) throws IOException,SQLException
   {     
       PropertyConfigurator.configure("log4j.properties"); // 入参为配置文件的路径
       Logger logger = Logger.getLogger( log4jExample.class.getName() );
       logger.debug("DEBUG");
       logger.info("INFO");
   }
}

有关配置文件来几单需要注意的题目:

[1].
log4j.properties 文件被干净节点配置格式

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

[2].
关于 appender 结点属性配置

// 为不同的 appender 配置日志输出级别
log4j.appender.AppenderName.Threshold = DEBUG
// 所有的消息都会被立即输出,默认 true
log4j.appender.AppenderName.ImmediateFlush = true 

[3].
对于项目中 log4j.xml 和 log4j.properties 不以 CLASSPATH
路径的,在路先后中要一直加载两单文件

DOMConfigurator.configure(log4j_xml_Path);  
PropertyConfigurator.configure(log4j_properties_Path);

除此上述基本配备外,可以扩大 FileAppender,支持 Date 和 Size
滚动日志,详情信息参见:log4j
日志配置教学;

1Date:按日期滚动,支持多
DatePattern

# Define the file appender
log4j.appender.FILE=org.apache.log4j.DailyRollingFileAppender

# Set the DatePattern
log4j.appender.FILE.DatePattern='.' yyyy-MM-dd'.log'

2Size:按文件大小滚动

# Define the file appender
log4j.appender.FILE=org.apache.log4j.RollingFileAppender

# Set the maximum file size before rollover
log4j.appender.FILE.MaxFileSize=10MB
# Set the the backup index
log4j.appender.FILE.MaxBackupIndex=10

至于 log4j 的详细信息,参考官网:log4j
官网;

SLF4J

Commons Logging
通用日志接口,用户可以自由选择第三着日志组件作为具体落实。通过动态查找体制,在程序运行时自动寻有真正以的日记框架。代码依赖之凡
common-logging 而未具体的日记组件,
避免与现实的日志方案一直耦合,必要常常可转日志实现之老三正值组件。

import org.apache.commons.logging.Log;  
import org.apache.commons.logging.LogFactory;  

public class A {  
    private static Log logger = LogFactory.getLog(this.getClass());  
}  

Commons Logging + log4j
作为Java日志的经典组合,但是 Commons Logging 存在

  • ClassLoader 问题
  • 为了避免多余的字符串拼接,必须 isDebugEnabled() 判断逻辑

的问题,log4j 团队开发有日记门面框架SLF4J。

Simple Logging Facade for
Java(SLF4J,简单日志门面),不是现实的日记解决方案,用于服务各种日志系统,为不同的日志框架提供联合之日记接口,在编译时绑定相应的日志框架(静态绑定)。关于
SLF4J 的详细信息,参见:SLF4J 官网;

接近 JDBC,但是比较 JDBC 更简便易行,无需加载驱动、只需要加上特定的担保。

面向 Java,推荐 SLF4J,而不是 log4j

参见:何以使用SLF4J而无是Log4J来举行Java日志;胡要下SLF4J而休是Log4J;

性特点

  • 单独为各种日志系统
  • Parameterized Logging,提供基于占位符(place
    holder)的日志记录道,可读性强
  • 日记信息(String)延迟构建,减少 String 池过多消耗堆内存

着力采用

SLF4J 只是一个日志外壳,需要以列蒙投入
slf4j-jdk14.jar、slf4j-log4j12.jar 或
logback.jar,将日志调用转发到骨子里的日志框架。SLF4J 是一个抽象层(
Abstraction Layer),使您的代码独立为自由一个特定的日志API,具体地:

SLF4J 应用 Facade(门面)设计模式,SLF4J 所提供的中心 API
是提供部分对外的接口及一个 LoggerFactory 工厂类

SLF4J
提供联合的日记记录接口,只要按该提供的方法记录即可,最终日志格式、日志级别、输出方式等由现实的日志系统的安排来落实,因此在运用中好灵活切换到不同的日记系统,用户用自己梦想之日志系统
loging APIs。

因 log4j 为例,SLF4J 的绑定操作实现如下

美学原理 3

  • slf4j-api 作为日志接入的接口,编译时 slf4j-api 的 public final class
    LoggerFactor 类中 private final static void bind()
    方法会寻找并绑定具体的日志实现类似,主要透过调用
    StaticLoggerBinder.getSingleton() 方法
  • slf4j-log4j12 是链接 slf4j-api 和 log4j 的高中级适配器,该类实现
    slf4j-api 中 LoggerFactoryBinder 接口,从而以编译时绑定
    slf4j-log4j12 的 getSingleton() 方法
  • log4j 是具体的日志系统,通过 slf4j-log4j12 初始化 log4j

其间,SLF4J 的主干是 slf4j api(slf4j-api.jar包),该 .jar
包只提供日志记录接口。有关对 SLF4J 基本认识,参见:初识
SLF4J;

SLF4J 不依赖让其它例外的 class loader 机制。实际上,SLF4J
与已发日记实现之绑定是在编译时静态执行的,具体绑定工作是透过一个 .jar包
实现之,使用时如将相应的jar包(只发生一个)放到类路径上即可,SLF4J 通过
.jar包 来报告使用啊种日志系统贯彻。

美学原理 4

以 Java 程序中调用如下,通过工厂类 LoggerFactory 创建日志目标

import org.apache.SLF4J.Logger;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestSlf4j 
{
    private static final Logger logger = LoggerFactory.getLogger(TestSlf4j.class);

    public static void main(String[] args) 
    {
        logger.info("Hello {}", "SLF4J");
    }
} 

留意,在档次遭到 Maven 依赖应如下设置

<!-- slf4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.12</version>
</dependency>

<!-- slf4j-log4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.12</version>
</dependency>

<!-- log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

切实实现过程讲解与:SLF4J+log4j
原理实现与源码分析;SLF4J
源码剖析;

深入研讨

目前 Latest STABLE version 是
slf4j-1.7.25.zip;其中,SLF4J
的着力包为

// 核心包
slf4j-api-1.7.25.jar
// 核心包源码
slf4j-api-1.7.25-sources.jar

修 SLF4J 的源码,可以从以下三单确保起来

slf4j-api,slf4j-log4j12

SLF4J 有五独重要组件,分别是:

  • ILoggerFactory:工厂接口
  • LoggerFactory:工厂类
  • LoggerFactoryBinder:日志框架绑定接口
  • Logger:日志接口
  • StaticLoggerBinder:日志框架绑定实现类似

此间先让有总体的流水线:LoggerFactory 调用 getILoggerFactory()
方法,该方法会初始化 LoggerFactory,即由此在 bind() 方法中加载 classpath
中之 StaticLoggerBinder 类,并依据加载结果设置当前 LoggerFactory
的初始化状态,从而以 getILoggerFactory() 方法中通过时 LoggerFactory
的状态判断返回的 ILoggerFactory 实例。下面分别介绍各个系组件:

1ILoggerFactory

该接口就提供一个 getLogger() 方法,用于获取日志实例。

public interface ILoggerFactory {
    // 所有日志框架均通过该方法获取Logger实例
    public Logger getLogger(String name);
}

富有的日记框架都用实现该接口。

2LoggerFactory

担当找系统里日志的实现,提供 getLogger() 创建日志实例。

public static Logger getLogger(String name) {
    ILoggerFactory iLoggerFactory = getILoggerFactory();
    return iLoggerFactory.getLogger(name);
}

该类的 getLogger()
方法通过调用该类的 getILoggerFactory()
方法取得日志工厂接口的实例,再调用接口提供的 getLogger()
方法获得具体的日记实例。首先看下该类的 getILoggerFactory() 方法

public static ILoggerFactory getILoggerFactory() 
{
    if (INITIALIZATION_STATE == UNINITIALIZED) {
        synchronized (LoggerFactory.class) {
            if (INITIALIZATION_STATE == UNINITIALIZED) {
                INITIALIZATION_STATE = ONGOING_INITIALIZATION;
                performInitialization();  // 初始化
            }
        }
    }
    switch (INITIALIZATION_STATE) {
    case SUCCESSFUL_INITIALIZATION:
        return StaticLoggerBinder.getSingleton().getLoggerFactory();
    case NOP_FALLBACK_INITIALIZATION:
        ... ...
}

第一步工厂初始化,第二步调用 StaticLoggerBinder.getSingleton().getLoggerFactory()
返回日志工厂接口的实例,具体查看下的(5)StaticLoggerBinder
部分。

此地看下 performInitialization() 方法,用于 绑定日志框架+校验日志框架版本号,代码如下

private final static void performInitialization() 
{
    bind();  // 绑定日志框架
    if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {
        versionSanityCheck();  // 校验日志框架版本号
    }
}

其中,bind() 方法是 SLF4J 最核心之代码,实现日志框架绑定,具体地

private final static void bind() {
    try {
        Set<URL> staticLoggerBinderPathSet = null;
        // skip check under android, see also
        // http://jira.qos.ch/browse/SLF4J-328
        if (!isAndroid()) {
            staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();  // 寻找可能的日志框架
            reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);  // 输出搜索到的所有StaticLoggerBinder日志
        }

        // the next line does the binding:实现绑定
        StaticLoggerBinder.getSingleton(); 
        INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
        reportActualBinding(staticLoggerBinderPathSet);  // 输出最终实际绑定的StaticLoggerBinder日志
        fixSubstituteLoggers();
        replayEvents();
        // release all resources in SUBST_FACTORY
        SUBST_FACTORY.clear();
    } 
    catch () {
        ... ...
    }
}

欠方法会加载并绑定找见的率先独 StaticLoggerBinder
类,并调用该类的 getSingleton() 方法,完成日志框架的绑定。其中,

private static String STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class";

static Set<URL> findPossibleStaticLoggerBinderPathSet() 
{
    Set<URL> staticLoggerBinderPathSet = new LinkedHashSet<URL>();
    try 
    {
        ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();

        Enumeration<URL> paths;
        if (loggerFactoryClassLoader == null) {
            paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
        } 
        else {
            paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);
        }

        while (paths.hasMoreElements()) {
            URL path = paths.nextElement();
            staticLoggerBinderPathSet.add(path);
        }
    } 
    catch (IOException ioe) {
        Util.report("Error getting resources from path", ioe);
    }
    return staticLoggerBinderPathSet;
}

findPossibleStaticLoggerBinderPathSet() 方法会查找项目根本路径下的 “org/slf4j/impl/StaticLoggerBinder.class”
文件。然后 reportMultipleBindingAmbiguity() 方法会报告文本查找的结果信息

private static void reportMultipleBindingAmbiguity(Set<URL> binderPathSet) {
    if (binderPathSet.size() > 1) 
    {
        Util.report("Class path contains multiple SLF4J bindings.");
        for (URL path : binderPathSet) {
            Util.report("Found binding in [" + path + "]");
        }
        Util.report("See " + MULTIPLE_BINDINGS_URL + " for an explanation.");
    }
}

倘找到多独,则输出 “Class path contains
multiple SLF4J bindings” 提示信息,表示来差不多个日志框架绑定了
SLF4J。

3Logger

欠接口提供不同层级日志信息记录的顺序艺术。

public interface Logger {
    public void debug(String msg);
    public void debug(String format, Object... arguments);
    ... ...
    info, warn, error
}

4LoggerFactoryBinder

日记框架绑定接口,仅且提供 2 单艺术

public interface LoggerFactoryBinder {
    public ILoggerFactory getLoggerFactory();
    public String getLoggerFactoryClassStr();
}

每个支持 SLF4J 的日志框架必须有一个落实该接口的 StaticLoggerBinder
类。

5StaticLoggerBinder

落实 LoggerFactoryBinder 接口,类 LoggerFactory 调用该类的
getSingleton() 和 getLoggerFactory() 方法返回具体日志框架的接口实例,以
slf4j-log4j12.jar 呢条例

// 单例模式
public class StaticLoggerBinder implements LoggerFactoryBinder 
{
    private static final StaticLoggerBinder SINGLETON = new StaticLoggerBinder();
    public static final StaticLoggerBinder getSingleton() {  // 静态方法
        return SINGLETON;
    }

    private static final String loggerFactoryClassStr = Log4jLoggerFactory.class.getName();
    public String getLoggerFactoryClassStr() {
        return loggerFactoryClassStr;
    }

    private final ILoggerFactory iloggerFactory;
    public ILoggerFactory getLoggerFactory() {
        return iloggerFactory;
    }
    private StaticLoggerBinder() {
        iloggerFactory = new Log4jLoggerFactory();  // 日志框架log4j的工厂类
        ... ...
    }

    public static String REQUESTED_API_VERSION = "1.6.99"; // !final
}

此类的构造函数中新盘一个 log4j 的日记工厂接口实例,并通过
getLoggerFactory() 方法返回。再深刻地,查看 log4j的厂子类
Log4jLoggerFactory

public class Log4jLoggerFactory implements ILoggerFactory 
{ 
    ConcurrentMap<String, Logger> loggerMap;  // key: name (String), value: a Log4jLoggerAdapter;
    public Log4jLoggerFactory() {
        loggerMap = new ConcurrentHashMap<String, Logger>();  // 线程安全的HashMap类
        org.apache.log4j.LogManager.getRootLogger();  // force log4j to initialize
    }

    // 实现接口 ILoggerFactory 的 getLogger() 方法
    public Logger getLogger(String name) {
        Logger slf4jLogger = loggerMap.get(name);
        ... ...
    }
}

内部,ConcurrentHashMap 用于缓存所有之前创建的 Log4jLoggerAdapter
类实例,日志框架 log4j 的厂子类实现了接口 ILoggerFactory,调用 org.apache.log4j.LogManager.getRootLogger()
完成对 log4j 的绑定,通过调用 getLogger()
方法返回一个 Log4jLoggerAdapter 类实例,这是为 Log4j 的 Logger 接口及
slf4j 的 Logger 接口不完全相同,需要在 Log4j 的 Logger
对象及展开一层封诈。该类维护一个 org.apache.log4j.Logger
logger 对象,用于日志记录

public final class Log4jLoggerAdapter extends MarkerIgnoringBase 
                                      implements LocationAwareLogger, Serializable
{
    final transient org.apache.log4j.Logger logger;

    Log4jLoggerAdapter(org.apache.log4j.Logger logger) {
        this.logger = logger;
        this.name = logger.getName();
    }
}

内部,接口 LocationAwareLogger 继承了 Logger 接口,是指向 Logger
接口的包裹

public interface LocationAwareLogger extends Logger { ... }

具体详细信息参见:slf4j源码剖析 –
xingoo;

综合,要实现一个匹配 SLF4J 的日志系统,最中心需要三只八九不离十:

  • StaticLoggerBinder 类,实现 LoggerFactoryBinder 接口
  • XxxLoggerFactory 类,实现 ILoggerFactory 接口
  • XxxLogger 类,实现 Logger 接口