C# Log4Net用法

2023-03-27 20:25:47

目录

一、简介

二、配置文件

样式1

样式2

样式3

三、Logger 用法

1.新建项目

2.配置文件的设置

3.日志管理类

4.测试

结束


一、简介

log4net是一款优秀的第三方日志框架,可以很容易的加载到开发项目中(引用log4net的dll,再配置些基本参数即可),帮助程序员把日志信息输出到各种不同的目标,常见的有文本、数据库、windows日志、邮件、内存缓冲区等目标。

二、配置文件

log4net 输出的日志样式,可以由自己来决定,设置就在配置文件中,下面是不同的配置文件,不同的样式展示。

样式1

<?xml version="1.0"?>
<configuration>
	<configSections>
		<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
	</configSections>
	<log4net>
		<!--定义输出到文件中-->
		<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
			<!--定义文件存放位置-->
			<file value="log\\" />
			<appendToFile value="true" />
			<rollingStyle value="Date" />
			<datePattern value="yyyy\\yyyyMM\\yyyyMMdd'.txt'" />
			<staticLogFileName value="false" />
			<param name="MaxSizeRollBackups" value="100" />
			<layout type="log4net.Layout.PatternLayout">
				<!--每条日志末尾的文字说明-->
				<!--输出格式-->
				<!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
				<conversionPattern value="%newline %n记录时间:%date %n线程ID:[%thread] %n日志级别:  %-5level %n出错类:%logger property: [%property] %n错误描述:%message%newline %n" />
			</layout>
		</appender>
		<root>
			<level value="ALL" />
			<!--文件形式记录日志-->
			<appender-ref ref="RollingLogFileAppender" />
		</root>
	</log4net>
</configuration>

日志效果:

普通日志和错误日志都在同一文件里

日志路径:

路径是按日期来分的。

样式2

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
	<configSections>
		<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
	</configSections>

	<log4net>
		<logger name="logerror">
			<appender-ref ref="ErrorAppender" />
		</logger>
		<!-- 信息日志类 -->
		<logger name="loginfo">
			<appender-ref ref="InfoAppender" />
		</logger>
		<!--定义输出到文件中-->
		<appender name="InfoAppender" type="log4net.Appender.RollingFileAppender">
			<!--定义文件存放位置-->
			<file value="log\\"/>
			<appendToFile value="true"/>
			<rollingStyle value="Date"/>
			<datePattern value="yyyyMMdd'.log'"/>
			<staticLogFileName value="false"/>
			<!--定义文件最大个数,超过按顺序删除-->
			<param name="MaxSizeRollBackups" value="100"/>
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<maximumFileSize value="50MB" />
			<layout type="log4net.Layout.PatternLayout">
				<!--每条日志末尾的文字说明-->
				<!--输出格式-->
				<!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
				<conversionPattern value="%date:   %message%newline %n"/>
			</layout>
		</appender>
		<appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
			<!--定义文件存放位置-->
			<file value="log\\Error\\"/>
			<appendToFile value="true"/>
			<rollingStyle value="Date"/>
			<datePattern value="yyyyMMdd'.log'"/>
			<staticLogFileName value="false"/>
			<!--定义文件最大个数,超过按顺序删除-->
			<param name="MaxSizeRollBackups" value="100"/>
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<maximumFileSize value="50MB" />
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="Error" />
				<levelMax value="Error" />
			</filter>
			<layout type="log4net.Layout.PatternLayout">
				<!--每条日志末尾的文字说明-->
				<!--输出格式-->
				<!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
				<conversionPattern value="%date: %message%newline %n"/>
			</layout>
		</appender>
	</log4net>

</configuration>

错误日志效果:

错误日志路径:

普通日志效果:

普通日志路径:

样式3

<?xml version="1.0"?>
<configuration>
	<configSections>
		<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
	</configSections>
	<log4net>
		<!-- 错误日志类-->
		<logger name="logerror">
			<level value="ALL" />
			<appender-ref ref="ErrorAppender" />
		</logger>
		<!-- 信息日志类 -->
		<logger name="loginfo">
			<level value="ALL" />
			<appender-ref ref="InfoAppender" />
		</logger>
		<!-- 错误日志附加介质-->
		<appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
			<param name="File" value="Log\\LogError\\" />
			<param name="AppendToFile" value="true" />
			<param name="MaxSizeRollBackups" value="100" />
			<param name="MaxFileSize" value="10240" />
			<param name="StaticLogFileName" value="false" />
			<param name="DatePattern" value="yyyyMMdd&quot;.htm&quot;" />
			<param name="RollingStyle" value="Date" />
			<!--布局-->
			<layout type="log4net.Layout.PatternLayout">
			<param name="ConversionPattern" value="&lt;HR COLOR=red&gt;%n异常时间:%d [%t] &lt;BR&gt;%n异常级别:%-5p &lt;BR&gt;%n异 常 类:%c [%x] &lt;BR&gt;%n%m &lt;BR&gt;%n &lt;HR Size=1&gt;"  />
			</layout>
		</appender>
		<!-- 信息日志附加介质-->
		<appender name="InfoAppender" type="log4net.Appender.RollingFileAppender">
			<param name="File" value="Log\\LogInfo\\" />
			<param name="AppendToFile" value="true" />
			<param name="MaxFileSize" value="10240" />
			<param name="MaxSizeRollBackups" value="100" />
			<param name="StaticLogFileName" value="false" />
			<param name="DatePattern" value="yyyyMMdd&quot;.htm&quot;" />
			<param name="RollingStyle" value="Date" />
			<!-- 信息日志布局-->
			<layout type="log4net.Layout.PatternLayout">
			<param name="ConversionPattern" value="&lt;HR COLOR=blue&gt;%n日志时间:%d [%t] &lt;BR&gt;%n日志级别:%-5p &lt;BR&gt;%n日 志 类:%c [%x] &lt;BR&gt;%n%m &lt;BR&gt;%n &lt;HR Size=1&gt;"  />
			</layout>
		</appender>
	</log4net>
</configuration>

错误日志效果:

错误日志路径:

普通日志效果:

 普通日志路径:

这个样式,个人还是非常推荐的。布局漂亮,普通日志,和错误日志单独分开。

三、Logger 用法

1.新建项目

新建一个C# 控制台项目,我这里用的 .Net6,安装log4net插件

找到当前项目的 Debug 文件夹,因为此时还没有生成项目,所有里面什么文件都没有,在里面添加一个文本文档,重命名为: log4net.config

注意这里,log4net.config 文件名你要是直接复制过去,在文件名的前后,可能会有空格,这会导致系统找不到配置文件,从而无法输出日志,千万要注意,我就遇到过几次。

2.配置文件的设置

然后打开 log4net.config 文件,根据上面第二节的配置文件,选择一种配置文件的输出类型然后复制到 log4net.config 文件中,比如这里我使用第一种配置文件,个人更推荐第三种配置文件,或者你自己写一个都可以。

3.日志管理类

接下来,我们添加代码,新建一个 Logger.cs ,用来控制日志的输出类型,比如:正常日志,错误日志


[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", ConfigFileExtension = "config", Watch = true)]
namespace Utils
{
    public class Logger
    {
        private static readonly log4net.ILog loginfo = log4net.LogManager.GetLogger("loginfo");
        private static readonly log4net.ILog logerror = log4net.LogManager.GetLogger("logerror");
        
        public static void WriteInfo(string info)
        {
            Console.WriteLine(info);
            if (loginfo.IsInfoEnabled)
            {
                loginfo.Info(info);
            }
        }

        public static void WriteError(string error)
        {
            Console.WriteLine(error);
            if (logerror.IsErrorEnabled)
            {
                logerror.Error(error);
            }
        }

        public static void WriteError(string info, Exception ex)
        {
            Console.WriteLine(info);
            if (logerror.IsErrorEnabled)
            {
                logerror.Error(info, ex);
            }
        }
    }
}

4.测试

调用 logger 类中的日志输出

using Utils;

namespace Log4netTest
{
    internal class Program
    {
        static void Main(string[] args)
        {
            try
            {
                Logger.WriteInfo("这是一条输出消息");
                int result = int.Parse("");//故意写一个错误
            }
            catch (Exception ex)
            {
                Logger.WriteError("Main方法出现异常:" + ex.Message);
            }

            Console.ReadKey();
        }
    }
}

点击运行之后,我们找到项目目录的 bin/Debug 文件夹下,会发现多出一个 log 文件夹

 找对对于的路径

打开 txt 文件,就可以看到错误日志 

结束

如果这个帖子对你有用,欢迎 关注 + 点赞 + 留言,谢谢

end

  • 作者:熊思宇
  • 原文链接:https://blog.csdn.net/qq_38693757/article/details/113606839
    更新时间:2023-03-27 20:25:47