log4net使用方法

项目利用log4net来记录日志。

一、引入log4net

项目中引入log4net可以通过nuget引入，这种方式还是比较方便简单的，而且不用害怕某天log4net的程序集误删除。

二、配置log4net

如果不自定义配置，可以使用默认的log4net配置，如果自定义log4net配置可以以xml文件的形式来保存配置内容。自定义配置内容如下。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <appSettings></appSettings>
  
  <log4net>
    <!--定义输出到文件中-->
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--定义文件存放位置-->
      <file value="log/log" />
      <appendToFile value="false" />
      <rollingStyle value="Date" />
      <datePattern value="yyyyMMdd&quot;.txt&quot;" />
      <layout type="log4net.Layout.PatternLayout">
        <!--每条日志末尾的文字说明-->
        <header value="&#13;&#10;[============================应用程序日志开始============================ ]&#13;&#10;" />
        <footer value="&#13;&#10;[ ============================应用程序日志结束============================]&#13;&#10;" />
        <!--输出格式-->
        <!--样例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
        <conversionPattern value="记录时间：%date 线程ID:[%thread] 日志级别：%-5level 类名或程序集名：%logger property:[%property{NDC}] - 描述：%message%newline" />
      </layout>
    </appender>
    
    <!--定义输出到控制台命令行中-->
    <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
      <layout type="log4net.Layout.PatternLayout">
        <!--输出格式-->
        <conversionPattern value="%date [%thread] 日志级别：%-5level 类名或程序集名：%logger property:[%property{NDC}] - 描述：%message%newline" />
      </layout>
    </appender>
    
    <!--定义输出到windows事件中-->
    <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
      </layout>
    </appender>
    
    <!--定义输出到数据库中，这里举例输出到Access数据库中，数据库为log4net.mdb（可以自定义路径）-->
    <appender name="AdoNetAppender_Access" type="log4net.Appender.AdoNetAppender">
      <connectionString value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=logDB/log4net.mdb" />
      <commandText value="INSERT INTO LogDetails ([LogDate],[Thread],[Level],[Logger],[Message]) VALUES (@logDate, @thread, @logLevel, @logger,@message)" />
      <!--定义各个参数-->
      <parameter>
        <parameterName value="@logDate" />
        <dbType value="String" />
        <size value="240" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%date" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@thread" />
        <dbType value="String" />
        <size value="240" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%thread" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@logLevel" />
        <dbType value="String" />
        <size value="240" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%level" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@logger" />
        <dbType value="String" />
        <size value="240" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%logger" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@message" />
        <dbType value="String" />
        <size value="240" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%message" />
        </layout>
      </parameter>
    </appender>
    <!--定义日志的输出媒介，下面定义日志以四种方式输出。也可以下面的按照一种类型或其他类型输出。-->
    
    <root>
      <!--文件形式记录日志-->
      <appender-ref ref="RollingFileAppender" />
      <!--控制台控制显示日志-->
      <appender-ref ref="ConsoleAppender" />
      <!--Windows事件日志-->
      <appender-ref ref="EventLogAppender" />
      <!--定义输出到数据库中。 如果不启用相应的日志记录，可以通过这种方式注释掉-->
      <!--<appender-ref ref="AdoNetAppender_Access" />-->
      
    </root>

  </log4net>
</configuration>

注意：由于权限问题，在web应用程序中windows事件日志或许不可用，主要是为了服务器更安全，不建议在生产环境中开启。具体原因见官方资料：http://logging.apache.org/log4net/release/faq.html#trouble-EventLog

三，程序中初始化log4net

在网站或应用程序运行开始时初始化log4net自定义配置，使日志信息的输出按照自定义好的方式输出或保存。代码如下。

private static ILog logger;

/// <summary>
        /// 初始化应用程序日志
        /// </summary>
        private static void LogConfigure()
        {
                  //获取log4net配置文件路径  
            string path = PathHelper.MapPath("config", "log4net.config");
            if (System.IO.File.Exists(path))
            {
                //使用自定义的配置初始化log4net  
                log4net.Config.XmlConfigurator.Configure(new System.IO.FileInfo(path));
            }
            //实例化log4net，参数为类或程序集名称  
            logger = log4net.LogManager.GetLogger("Program");
            //输出日志信息，信息级别：info  
            logger.Info("初始化应用程序日志");
        }

注：Web应用程序可以在Global.asax中的Application_Start方法中执行此方法。可以使用以下方式来获取log4net配置文件路径。获取log4net配置文件路径方式：string path = Server.MapPath("config/log4net.config");

四、封装为一个日志工具

public static class Logger
    {
        static Logger()
        {
            LoadLog4NetConfig();
        }
        public static ILog Log { get; private set; }

        private static void LoadLog4NetConfig()
        {
            log4net.Config.XmlConfigurator.ConfigureAndWatch(
                new FileInfo(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Config\\log4net.config")));
            Log = LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
            Log.Info("已加载日志配置");
        }
    }

封装为日志工具类放在Common组件中可以在任何项目中引用，输出日志时直接调用即可。

示例：

try
                {
                    pushAnswersList.EndInvoke(callback);
                }
                catch (Exception ex)
                {
                    Logger.Log.Error("通知答案列表时异常.", ex);
                }