在软件开发、测试以及生产条件中,日志记录是不行重大的,采纳合适的日记记录工具、设计合理的日记输出格式,有利于匡助开发人士明确程序的施行流程以及错误的急迅稳定和更正。日志记录作为软件开发周期中的首要组成部分,本文介绍三种常用的日记记录工具: 

  • 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.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格式
  • Raw提姆(Tim)eStampLayout:可格式化时间,常用于出口到数据库

有关 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
的详细音讯,参考官网:NLogCodeProject –
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,相关代码:

在编译前,最好应正确安装 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(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 接口

相关文章

网站地图xml地图