C++日记记录工具

其中,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|WA宝马X5N|E福特ExplorerROPRADO|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,具体地:

  •  帕特ternLayout:经典格式
  •  XMLLayout:XML格式

有关 Layout 的详细新闻,参见上边包车型地铁 深刻驾驭 – Layout 部分。

[5].lockingModel

文件锁类型,允许三个进程能够写入同3个文书,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 配置使用系统的周转参数,比单独做3个 .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 文件的沙盘代码:

C++ 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"));

其次种办法正是前面说的单身使用1个 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一样的文书
  • C++,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
只好有3个 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
的详细音信,参考官网: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 代表二个输出指标,包罗叁个性情
    • 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
文章系列

SLF4J

康芒斯 Logging
通用日志接口,用户能够自由选择第二方日志组件作为具体贯彻。通过动态查找体制,在程序运营时自动找出真正使用的日记框架。代码信赖的是
common-logging 而非具体的日志组件,
制止与实际的日志方案平昔耦合,供给时可更改日志完成的第1方组件。

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 是2个抽象层(
Abstraction Layer),使你的代码独立于自由一个一定的日志API,具体地:

SLF4J 应用 Facade(门面)设计格局,SLF4J 所提供的核心 API
是提供部分对外的接口以及3个 LoggerFactory 工厂类

SLF4J
提供联合的日志记录接口,只要根据其提供的办法记录即可,最后日志格式、日志级别、输出格局等由现实的日志系统的安排来兑现,因而在行使中得以灵活切换成差异的日志系统,用户使用自个儿愿意的日记系统
loging APIs。

以 log4j 为例,SLF4J 的绑定操作完成如下

C++ 2

  • 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包 来告诉使用哪一种日志系统贯彻。

C++ 3

在 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

该接口仅提供1个 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
}

该类的构造函数中新建2个 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 接口
  • log4net
  • NLog
  • log4j
  • SLF4J

在软件开发、测试以及生产条件中,日志记录是那么些重庆大学的,选取合适的日志记录工具、设计合理的日记输出格式,有利于协助开发职员显著程序的进行流程以及错误的快速稳定和勘误。日志记录作为软件开发周期中的主要组成都部队分,本文介绍二种常用的日志记录工具: 

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 组件虚拟图

C++ 4

输出介质:帮忙控制台、文件、数据库等

  • ConsoleAppender:控制台
  • FileAppender:文件
  • RollingFileAppender:文件大小滚动生成日志,达到内定尺寸时生成二个新的日志文件
  • DailyRollingFileAppender:时间滚动生成日志文件
  • WriterAppender:将日志消息以流格式发送到任意内定的地点,eg.
    数据库

基本使用

log4j 的好多音讯方可参考
log4net,此部分略过,往事不要再提。

Log4j
援救两种配备文件格式,一种是XML格式的文本,一种是Java性情文件(键=值)

log4j 通过 log4j.properties
文件(key-value方式)保存属性配置。暗中同意情形下,日志管理在 CLASSPATH
查找1个名为 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
官网