log4net初探（winform）_log4net git-CSDN博客

本文链接：https://blog.csdn.net/andyqingliu/article/details/103543264

一. 前言

给朋友做了一个简单的小工具，用winform，发现随着需求与问题的复杂度越来越高，收集使用过程中输出的log信息成为很重要的一件事，出现报错或者结果不对的时候，通过log信息很容易跟踪问题。

最开始想直接通过winform里面的控件来显示log信息，后来发现随着问题的复杂度越来越高，维护起来也很不方便。
从而产生了寻找log库文件的想法，随手一搜，没有经过仔细对比，直接就看到log4net。

Apache出品，可以控制输出日志信息到目的地，可以是控制台，文本文件，数据库，邮件，远端服务器等等。。。

二.安装与环境配置

项目右键Manage NuGet Packages for solution, 在Browse里面搜索log4net,by Apache的那个就是。Install之后会自动安装到项目文件夹的packages文件夹下面。

比较坑的是环境配置。。。

由于是winform应用（C/S程序），需要在App.Config文件里面的configuration标签下第一个位置添加如下标记：

<configSections>
	<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>

注意，一定要在第一个位置添加。 用来标识log4net配置所在的位置。

在AssemblyInfo.cs文件里面添加如下标识

[assembly: log4net.Config.XmlConfigurator(Watch = true)]

用来监视配置文件，当配置文件发生变化的时候就会重新加载，注意，一定要加上这个，否则可能改了配置文件发现无法生效。

然后需要在App.Config里面新加一个log4net的标签，标记log4net的配置。如下所示：

    <?xml version="1.0" encoding="utf-8" ?>
	    <configuration>
	    	<configSections>
	    		<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
	    	</configSections>
	    	<startup> 
	    		<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
	    	</startup>
	    	<appSettings>
	    		<add key="IsWriteLog" value="1"/>
	    	</appSettings>
	    	<log4net>
	    		<appender name="TestFileAppender" type="log4net.Appender.FileAppender" >
	    		<!-- 设置log文件的名称与位置 -->
	    		<file value="Config\Log.txt" />
	    		<appendToFile value="false" />
	    
	    		<layout type="log4net.Layout.PatternLayout">
	    			<conversionPattern value="%d [%t] %-5p %c - %m%n" />
	    		</layout>
	    	</appender>
	    
	    	<logger name="TestLogger">
	    		<level value="ALL" />
	    		<appender-ref ref="TestFileAppender" />
	    	</logger>
	    </log4net>
	 </configuration>

其中，appender标记了当前log的输出方式，type可以是文件输出，控制台输出，数据库输出等。

file value 指定了文件的输出目录。

appendToFile value指定了是否以追加的方式写文件。设置为false会每次覆盖上一次的log。设置为true会从上一次的末尾添加log信息。

conversionPattern value指定了log文件的格式样式，%d代表date，也可以写成%date,%t也可以写成%thread，输出线程名称，没有线程名称就输出线程序号，%-5p的p代表level，就是log的输出级别，-5代表占五个字符的位置，不够拿空格占位。%c也可以写成%logger,代表输出logger的名字（配置文件里面可以定义多个logger），%m代表%message,代表输出的字符串，%n代表%newline，输出之后换行。

PatternLayout Class详细描述了这些参数代表的意义，参见链接
https://logging.apache.org/log4net/release/sdk/index.html

logger标签里面定义了level value,表示log的级别。高到底分别为：OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL，ALL代表该级别的logger要全部输出.

程序里面通过名称调用logger的办法如下：

private static readonly ILog LogInfo = LogManager.GetLogger("TestLogger");

程序里面的添加key = IsWriteLog, value = 1是为了控制log输出的开关。其实也可以直接设置log的级别来控制log的输出与否。

string logState = ConfigurationManager.AppSettings["IsWriteLog"];

IsEnableLog = logState.Equals("1");

log4net的官方文档看链接：https://logging.apache.org/log4net/release/manual/configuration.html

三.log的辅助类

光有log信息貌似不太行，有时候需要log输出的代码行，被哪个方法调用，所在的文件等等信息。例如代码如下：

public static int GetLineNum()
{
    StackTrace st = new StackTrace(true);
    StackFrame sf = st.GetFrame(3);
    return sf.GetFileLineNumber();
}

public static string GetFileName()
{
    StackTrace st = new StackTrace(true);
    StackFrame sf = st.GetFrame(3);
    return sf.GetFileName();
}

public static string GetMethodName()
{
    StackTrace st = new StackTrace(true);
    StackFrame sf = st.GetFrame(3);
    return sf.GetMethod().Name;
}

private static string GetFormatStr()
{
    string fileName = Util.GetFileName();
    string methodName = Util.GetMethodName();
    int codeLineNum = Util.GetLineNum();
    string formatStr = string.Format("{0}[{1}()]({2})", fileName, methodName, codeLineNum);
    return formatStr;
}

public static void Log(string str, params object[] args)
{
    if (Util.IsEnableLog)
    {
    	LogInfo.InfoFormat(GetFormatStr() + str, args);
    }
}

解释一下：最后这个Log()方法是项目调用的公用方法，StackFrame sf = st.GetFrame(3);里面的3代表要找到堆栈的第三层堆栈信息。因为这里log（）方法里面取了GetFormatStr()，而这个方法又取了GetLineNum，GetFileName，GetMethodName，而这三个方法里面才取堆栈信息，所以是3.为了在log输出的时候能够带上代码所在行，文件位置信息，所以包装了Log()方法以方便在项目调用过程中的log能都按这个格式输出，方便代码追踪。