日志记录类库log4net的使用总结

　　log4net是一个开源的日志记录类库，经过配置后可以自动抓取程序中的错误、异常信息，并写入磁盘，也可以在异常发生时执行其他指定的操作，比如：通知某人右键、写入数据库等。这里写个ASP.NET MVC4应用LogNet的Demo：

1.建立ASP.NET MVC4网站，在web.config中写入log4net的配置文件（就是添加两个节点）

<configuration>
  <configSections>
    <!-->需要添加第一个的节点<-->
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  </configSections>

  <!-->需要添加第二个的节点<-->
  <log4net>
    <!--错误日志配置 ：其中name 可以程序员自己定义,但是这个名字一定要和 <logger name="logerror">下面的
    <appender-ref ref="ErrorAppender"/> 中 ref的值保持一致
    -->
    <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
      <!--日志文件存储的位置是：Log\LogError\-->
      <param name="File" value="Log\LogError\" />
      <!--表示将内容以追加的形式，保存到日志文件中-->
      <param name="AppendToFile" value="true" />
      <!--每天的日志备份数可以有100个-->
      <param name="MaxSizeRollBackups" value="100" />
      <!--表示每个日志文件的大小只能是10M-->
      <param name="MaxFileSize" value="10240" />
      <!--文件名称是固定格式的-->
      <param name="StaticLogFileName" value="false" />
      <!--文件名称是固定格式为:yyyyMMdd-->
      <param name="DatePattern" value="yyyyMMdd" />
      <!--每天都是以yyyyMMdd来进行命名文件-->
      <param name="RollingStyle" value="Date" />
      <!--设定写入的日志格式-->
      <layout type="log4net.Layout.PatternLayout">
        <param name="ConversionPattern" value="%n异常时间：%d [%t] %n异常级别：%-5p %n异 常 类：%c [%x] %n%m %n " />
      </layout>
    </appender>
    <!--log4net.LogManager.GetLogger("logerror")用这个来选择这种类型-->
    <!--additivity="false"表示错误记录只写入一次-->
    <logger name="logerror" additivity="false">
      <!--这个配置文件，如果配置成ALL:表示可以记录 1、信息日志(Info)  2、警告日志(Warn) 3、错误日志(Error)-->
      <level value="ALL" />
      <appender-ref ref="ErrorAppender" />
    </logger>
    <root>
      <level value="ALL" />
      <appender-ref ref="ErrorAppender" />
    </root>
  </log4net>
</configuration>

2.建立负责日志记录的LogHelper类

public class LogHelper
    {
        //通过配置文件的logerror 进行日志写入对象的实例化
        public static readonly log4net.ILog logerror = log4net.LogManager.GetLogger("logerror");   //选择<logger name="logerror">的配置 

        //public static readonly log4net.ILog loginfo = log4net.LogManager.GetLogger("loginfo");   //选择<logger name="loginfo">的配置 

        static LogHelper()
        {
            SetConfig();
        }

        /// <summary>
        /// 初始化web.config中的<log4net>节点中的配置
        /// </summary>
        public static void SetConfig()
        {
            log4net.Config.XmlConfigurator.Configure();
        }

        ///// <summary>
        ///// 设置自定义的Log4Net配置文件
        ///// </summary>
        ///// <param name="configFile"></param>
        //public static void SetConfig(System.IO.FileInfo configFile)
        //{
        //    log4net.Config.XmlConfigurator.Configure(configFile);
        //}

        /// <summary>
        /// 负责将信息日志写入到日志文件
        /// </summary>
        public static void WriteInfo(string msg)
        {
            //检查信息日志是否允许
            if (logerror.IsInfoEnabled)
            {
                //表示写入信息级别的日志
                logerror.Info(msg);
            }
        }

        /// <summary>
        /// 负责将警告日志写入到日志文件
        /// </summary>
        public static void WriteWran(string msg)
        {
            if (logerror.IsWarnEnabled)
            {
                //表示写入警告级别的日志
                logerror.Warn(msg);
            }
        }

        /// <summary>
        /// 负责将错误日志写入到日志文件
        /// </summary>
        public static void WriteError(string msg)
        {
            if (logerror.IsErrorEnabled)
            {
                //表示写入异常级别的日志
                logerror.Error(msg);
            }
        }
    }

3.建立网站与log4net的联系，使log4net能够自动记录网站在运行时出现的异常

MVC4 版本：

    /// <summary>
    /// 新建一个继承HandleErrorAttribute的异常类，重写OnException(ExceptionContext filterContext)方法捕捉网站运行时出现的异常。
    /// </summary>
    public class MyExceptionAttribute : HandleErrorAttribute
    {
        public override void OnException(ExceptionContext filterContext)
        {
            Exception exp = filterContext.Exception;
            ViewResult view = new ViewResult();
            view.ViewName = "/Views/Shared/Error.cshtml";   //新建一个视图对象，当网站出现异常时，跳转到自定义的错误页面
            view.ViewData["Error"] = exp.Message;
            filterContext.Result = view;
            filterContext.ExceptionHandled = true;

            while (exp.InnerException != null)
            {
                exp = exp.InnerException;
            }

            LogHelper.WriteError(exp.Message);
        }
    }

Asp.Net版本：通过在Global.asax的 Application_Error(Object sender, EventArgs e) 事件中，调用LogHelper类的方法来捕获网站异常记录

public class Global : System.Web.HttpApplication
    {
        void Application_End(object sender, EventArgs e)
        {
            //  在应用程序关闭时运行的代码

        }

        void Session_Start(object sender, EventArgs e)
         {
             // 在新会话启动时运行的代码
 
         }
 
         void Session_End(object sender, EventArgs e)
         {
             // 在会话结束时运行的代码。 
             // 注意: 只有在 Web.config 文件中的 sessionstate 模式设置为
             // InProc 时，才会引发 Session_End 事件。如果会话模式设置为 StateServer 
             // 或 SQLServer，则不会引发该事件。
 
         }
 
         /// <summary>
         /// 程序启动时配置log4net
         /// </summary>
         /// <param name="sender"></param>
         /// <param name="e"></param>
         protected void Application_Start(Object sender, EventArgs e)
         {
             //若不想把log4net配置文件写在web.config中，也可以另外手动指定。
             //XmlConfigurator.Configure(new FileInfo(HttpContext.Current.Server.MapPath("~/App_Data/log4net.config")));
         }
 
         /// <summary>
         /// 程序出错时通过log4net写日志
         /// </summary>
         /// <param name="sender"></param>
         /// <param name="e"></param>
         protected void Application_Error(Object sender, EventArgs e)
         {
             Exception objExp = HttpContext.Current.Server.GetLastError();
             LogHelper.WriteLog("
客户机IP:" + Request.UserHostAddress 
                 + "
错误地址:" + Request.Url 
                 + "
异常信息:" + Server.GetLastError().Message, objExp);
         }
     }

4.关闭log4net日志记录功能

　　在配置文件web.config中找到节点<level value="ALL" />，将value值设置成比ERROR高的等级就不会记录日志。value值对应的等级如下：

　　OFF
　　FATAL
　　ERROR
　　WARN
　　INFO
　　DEBUG
　　ALL
由下往上，OFF优先级别最高，设置OFF就不再记录日志