C# 基础 - 日志捕获二使用 log4net

  1. 引入 log4net.dll
  2. 项目->添加->新建项->应用程序配置文件,命名为 log4net.config,并把属性的复制到输出目录设置为 如果较新则复制,后续客户端需要读取在 debug 下的这个文件;
  3. 封装日志类 WriteLog

1. log4net.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <!--<section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>-->
        <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
    </configSections>
    
    <log4net>
        <!--定义输出到单个文件中-->
        <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
            <!--定义文件存放位置,也可以使用环境变量来设置-->
            <file value="${TMP}\YunXing\log-file.txt" />
            <!--<file value="log-file.txt" />-->
            <!--定义保存方式,true表示在原有文件后追加,false表示覆盖原有文件-->
            <appendToFile value="true" />
            <layout type="log4net.Layout.PatternLayout">
                <!--每条日志首尾的文字说明-->
                <header value="[Header]&#13;&#10;" />
                <footer value="[Footer]&#13;&#10;" />
                <!--输出格式-->
                <!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                <!--<conversionPattern value="%date [%thread] %-5level %logger [%ndc] &lt;%property{auth}&gt; - %message%newline" />-->
                <conversionPattern value="记录时间:%date 线程ID:[%thread] 日志级别:%-5level 出错类:%logger property:[%property{NDC}] 异常行号:%line行- 错误描述:%message%newline" />
            </layout>
            <!-- Alternate layout using XML			
            <layout type="log4net.Layout.XMLLayout" /> -->
            <!--根据级别筛选日志,DEBUG,INFO,WARN,ERROR,FATAL-->
            <threshold value="DEBUG" />
        </appender>
        <!--定义输出到多个文件中-->
        <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
            <!--定义文件存放位置,也可以使用环境变量来设置-->
            <!-- <file value="${TMP}\log-file.txt" /> -->
            <file value="C:\MaoLog\" />
            <!--使用Unicode编码-->
            <Encoding value="UTF-8" />
            <!--定义保存方式,true表示在原有文件后追加,false表示覆盖原有文件-->
            <appendToFile value="true" />
            <!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
            <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
            <!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
            <rollingStyle value="Date" />
            <!--当日志文件达到MaxFileSize大小,就自动创建备份文件,这里设置最大备份数量-->
            <maxSizeRollBackups value="20" />
            <!--每个文件的大小。只在混合方式与文件大小方式下使用。超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。可用的单位:KB|MB|GB。不要使用小数,否则会一直写入当前日志-->
            <maximumFileSize value="1MB" />
            <!--是否固定文件名,因为是滚动记录,所以用false-->
            <staticLogFileName value="false" />
            <!--按日期产生文件夹和文件名[在日期方式与混合方式下使用,后缀必须加上&quot;或'],日志文件总的路径即file+datePattern-->
            <!--此处按日期产生文件夹,文件名固定。注意&quot; 的位置-->
            <!--<DatePattern value="yyyy-MM-dd/'TimerServer.log'"/>-->
            <!--这是按日期产生文件夹,并在文件名(TimerServer)前也加上日期-->
            <!--<DatePattern value="yyyyMMdd/yyyyMMdd'-TimerServer.log';"/>-->
            <!--这是先按日期产生文件夹,再形成下一级固定的文件夹(TimerServer/)-->
            <!--<DatePattern value="yyyyMMdd/'TimerServer/TimerServer.log'"/>-->
            <datePattern value="yyyyMMdd'.log'" />
            <!--日志记录格式,%property{Operator}、%property{Action}是自定义的输出-->
            <layout type="log4net.Layout.PatternLayout">
                <!--每条日志首尾的文字说明-->
                <header value="[***Header***]&#13;&#10;" />
                <footer value="[***Footer***]&#13;&#10;&#13;&#10;" />
                <!--输出格式,%exception异常信息,可写可不写,只要调用的时候有传入Exception,日志会自动记录-->
                <!--样例:
                [Header]
                记录时间:2017-11-30 16:04:51,258 线程ID:[19] 日志级别:ERROR 所在类:GoSun.VMapEngine.Vmap.YunXing.MainViewModel
                日志描述:实时查询数据错误。
                [Footer]-->
                <conversionPattern value="记录时间:%date 线程ID:[%thread] 日志级别:%-5level 所在类:%logger 异常行号:%line行%newline 日志描述:%message%newline%exception========================%newline%newline" />
            </layout>
            <!-- Alternate layout using XML			
            <layout type="log4net.Layout.XMLLayout" /> -->
                <!--根据级别筛选日志-->
                <!--<threshold value="INFO" />-->
        </appender>
        <!--定义输出到控制台命令行中-->
        <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
            </layout>
            <!--根据级别筛选日志-->
            <threshold value="ALL" />
        </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>
            <!--根据级别筛选日志-->
            <threshold value="INFO" />
        </appender>
        <!--定义输出到数据库中,这里举例输出到Access数据库中,数据库为C盘的log4net.mdb-->
        <appender name="AdoNetAppender_Access" type="log4net.Appender.AdoNetAppender">
            <connectionString value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C: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>
            <!--根据级别筛选日志-->
            <threshold value="INFO" />
        </appender>
        <!--定义输出到SQL Server数据库中-->
        <!--  
        在SQL Server中创建表的SQL语句  
        CREATE TABLE [dbo].[Log] (  
        [Id] [int] IDENTITY (1, 1) NOT NULL,  
        [Date] [datetime] NOT NULL,  
        [Thread] [varchar] (255) NOT NULL,  
        [Domain] [varchar] (255) NOT NULL,  
        [UserName] [varchar] (255) NOT NULL,  
        [Level] [varchar] (50) NOT NULL,  
        [Logger] [varchar] (255) NOT NULL,  
        [Message] [varchar] (4000) NOT NULL,  
        [Exception] [varchar] (2000) NULL  
        );  
        -->
        <appender name="AdoNetAppender_SQLServer" type="log4net.Appender.AdoNetAppender">
            <bufferSize value="1" />
            <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
            <!--<connectionString value="data source=[database server];initial catalog=[database name];integrated security=false;persist security info=True;User ID=[user];Password=[password]" />-->
			<connectionString value="Data Source=(local)\SQLEXPRESSR2;Initial Catalog=CHEMSRuntime;Persist Security Info=True;User ID=sa;Password=dongben" />
            <commandText value="INSERT INTO Log ([Date],[Thread],[Domain],[UserName],[Level],[Logger],[Message],[Exception]) VALUES (@log_date, @thread, @domain, @log_username, @log_level, @logger, @message, @exception)" />
            <parameter>
                <parameterName value="@log_date" />
                <dbType value="DateTime" />
                <layout type="log4net.Layout.RawTimeStampLayout" />
            </parameter>
            <parameter>
                <parameterName value="@thread" />
                <dbType value="String" />
                <size value="255" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%thread" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@domain" />
                <dbType value="String" />
                <size value="255" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%appdomain" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@log_username" />
                <dbType value="String" />
                <size value="255" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%username" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@log_level" />
                <dbType value="String" />
                <size value="50" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%level" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@logger" />
                <dbType value="String" />
                <size value="255" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%logger" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@message" />
                <dbType value="String" />
                <size value="4000" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%message" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@exception" />
                <dbType value="String" />
                <size value="2000" />
                <layout type="log4net.Layout.ExceptionLayout" />
            </parameter>
            <!--根据级别筛选日志-->
            <threshold value="INFO" />
        </appender>
        <!--定义使用UDP输出到网络-->
        <appender name="UdpAppender8081" type="log4net.Appender.UdpAppender">
            <param name="RemoteAddress" value="255.255.255.255" />
            <param name="RemotePort" value="8081" />
            <layout type="log4net.Layout.XmlLayout">
                <param name="Prefix" value="" />
            </layout>
            <!--根据级别筛选日志-->
            <threshold value="ALL" />
        </appender>
        <appender name="UdpAppender8080" type="log4net.Appender.UdpAppender">
            <param name="RemoteAddress" value="255.255.255.255" />
            <param name="RemotePort" value="8080" />
            <layout type="log4net.Layout.XmlLayout">
                <param name="Prefix" value="" />
            </layout>
            <!--根据级别筛选日志-->
            <threshold value="INFO" />
        </appender>
        <!--定义日志的输出媒介,下面定义日志以几种方式输出。也可以下面的按照一种类型或其他类型输出。-->
        <root>
            <!--文件形式记录日志-->
            <!--<appender-ref ref="LogFileAppender" />-->
            <appender-ref ref="RollingFileAppender" />
            <!--控制台控制显示日志-->
            <!--<appender-ref ref="ConsoleAppender" />-->
            <!--Windows事件日志-->
            <!--<appender-ref ref="EventLogAppender" />-->
            <!--如果不启用相应的日志记录,可以通过这种方式注释掉-->
            <!--<appender-ref ref="AdoNetAppender_Access" />-->
            <!--<appender-ref ref="AdoNetAppender_SQLServer" />-->
            <!--<appender-ref ref="UdpAppender8080" />-->
            <!--<appender-ref ref="UdpAppender8081" />-->
            <!--由高到底分别为:OFF > FATAL > ERROR > WARN > INFO > DEBUG  > ALL-->
            <level value="DEBUG" />
        </root>
    </log4net>
</configuration>

2. WriteLog

/// <summary>
/// 日志类
/// </summary>
public class WriteLog
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="path">配置文件路径</param>
    public WriteLog(string path = "log4net.config")
    {
        if (string.IsNullOrEmpty(path))
        {
            //直接读取程序配置文件app.config
            log4net.Config.XmlConfigurator.Configure();
        }
        else
        {
            log4net.Config.XmlConfigurator.Configure(new ystem.IO.FileInfo(path));
        }
    }

    private ILog GetLogger()
    {
        StackTrace st = new StackTrace(true);
        if (st.FrameCount > 2)
        {
            return LogManager.GetLogger(st.GetFrame(2).GetMethod().DeclaringType);
        }
        else
        {
            return LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
        }
    }

    #region DEBUG
    /// <summary>
    /// 调试日志 15
    /// </summary>
    /// <param name="message">日志描述</param>
    public void Debug(object message)
    {
        GetLogger().Debug(message);
    }
    
    /// <summary>
    /// 调试日志
    /// </summary>
    /// <param name="message">日志描述</param>
    /// <param name="exception">日志异常</param>
    public void Debug(object message, Exception exception)
    {
        GetLogger().Debug(message, exception);
    }

    public void DebugFormat(string format, params object[] args)
    {
        GetLogger().DebugFormat(format, args);
    }

    public void DebugFormat(string format, object arg0)
    {
        GetLogger().DebugFormat(format, arg0);
    }

    public void DebugFormat(string format, object arg0, object arg1)
    {
        GetLogger().DebugFormat(format, arg0, arg1);
    }

    public void DebugFormat(string format, object arg0, object arg1, object arg2)
    {
        GetLogger().DebugFormat(format, arg0, arg1, arg2);
    }

    public void DebugFormat(IFormatProvider provider, string format, params object[] args)
    {
        GetLogger().DebugFormat(provider, format, args);
    }
    #endregion

    #region INFO
    public void Info(object message)
    {
        GetLogger().Info(message);
    }

    public void Info(object message, Exception exception)
    {
        GetLogger().Info(message, exception);
    }

    public void InfoFormat(string format, params object[] args)
    {
        GetLogger().InfoFormat(format, args);
    }

    public void InfoFormat(string format, object arg0)
    {
        GetLogger().InfoFormat(format, arg0);
    }

    public void InfoFormat(string format, object arg0, object arg1)
    {
        GetLogger().InfoFormat(format, arg0, arg1);
    }

    public void InfoFormat(string format, object arg0, object arg1, object arg2)
    {
        GetLogger().InfoFormat(format, arg0, arg1, arg2);
    }

    public void InfoFormat(IFormatProvider provider, string format, params object[] args)
    {
        GetLogger().InfoFormat(provider, format, args);
    }
    #endregion

    #region WARN
    public void Warn(object message)
    {
        GetLogger().Warn(message);
    }

    public void Warn(object message, Exception exception)
    {
        GetLogger().Warn(message, exception);
    }

    public void WarnFormat(string format, params object[] args)
    {
        GetLogger().WarnFormat(format, args);
    }
    
    public void WarnFormat(string format, object arg0)
    {
        GetLogger().WarnFormat(format, arg0);
    }

    public void WarnFormat(string format, object arg0, object arg1)
    {
        GetLogger().WarnFormat(format, arg0, arg1);
    }

    public void WarnFormat(string format, object arg0, object arg1, object arg2)
	{
    GetLogger().WarnFormat(format, arg0, arg1, arg2);
    }

    public void WarnFormat(IFormatProvider provider, string format, params object[] args)
    {
        GetLogger().WarnFormat(provider, format, args);
    }
    #endregion

    #region ERROR
    public void Error(object message)
    {
        GetLogger().Error(message);
    }

    public void Error(object message, Exception exception)
    {
        GetLogger().Error(message, exception);
    }

    public void ErrorFormat(string format, params object[] args)
    {
        GetLogger().ErrorFormat(format, args);
    }

    public void ErrorFormat(string format, object arg0)
    {
        GetLogger().ErrorFormat(format, arg0);
    }

    public void ErrorFormat(string format, object arg0, object arg1)
    {
        GetLogger().ErrorFormat(format, arg0, arg1);
    }

    public void ErrorFormat(string format, object arg0, object arg1, object arg2)
    {
        GetLogger().ErrorFormat(format, arg0, arg1, arg2);
    }

    public void ErrorFormat(IFormatProvider provider, string format, params object[] args)
    {
        GetLogger().ErrorFormat(provider, format, args);
    }
    #endregion

    #region FATAL
    public void Fatal(object message)
    {
        GetLogger().Fatal(message);
    }

    public void Fatal(object message, Exception exception)
    {
        GetLogger().Fatal(message, exception);
    }

    public void FatalFormat(string format, params object[] args)
    {
        GetLogger().FatalFormat(format, args);
    }

    public void FatalFormat(string format, object arg0)
    {
        GetLogger().FatalFormat(format, arg0);
    }

    public void FatalFormat(string format, object arg0, object arg1)
    {
        GetLogger().FatalFormat(format, arg0, arg1);
    }

    public void FatalFormat(string format, object arg0, object arg1, object arg2)
    {
        GetLogger().FatalFormat(format, arg0, arg1, arg2);
    }

    public void FatalFormat(IFormatProvider provider, string format, params object[] args)
    {
        GetLogger().FatalFormat(provider, format, args);
    }
    #endregion

    #region 日志级别过滤标志
    public bool IsDebugEnabled
    {
        get { return GetLogger().IsDebugEnabled; }
    }
    
    public bool IsInfoEnabled
    {
        get { return GetLogger().IsInfoEnabled; }
    }

    public bool IsWarnEnabled
    {
        get { return GetLogger().IsWarnEnabled; }
    }

    public bool IsErrorEnabled
    {
        get { return GetLogger().IsErrorEnabled; }
    }

    public bool IsFatalEnabled
    {
        get { return GetLogger().IsFatalEnabled; }
    }
    #endregion
}

3. 可选的静态封装

public static class CommonHelper
{
    public static WriteLog WriteLog = new WriteLog("log4net.config");
}

4. 打日志

CommonHelper.WriteLog.Error("出错了", new Exception() {});
posted @ 2021-03-03 19:58  鑫茂  阅读(108)  评论(0编辑  收藏  举报