Log4net在.Net Winform项目中的使用

16 篇文章 0 订阅

在这里插入图片描述

Log4net是一个流行的日志记录工具,可以帮助开发人员在应用程序中实现高效的日志记录。本文将提供一个详细的分步骤示例,来帮助您在.Net Winform项目中使用Log4net。



一、安装Log4net

  1. 打开Visual Studio工具。
  2. 选择您的.Net Winform项目,并右击选择“管理NuGet程序包”。
  3. 在NuGet程序包管理器中搜索并安装"log4net"。

二、配置Log4net

  1. 在您的Winform项目中,创建一个名为“log4net.config”的XML文件,用于配置Log4net。
  2. 在log4net.config文件中,添加以下配置代码:
<log4net>
   <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <file value="logs\log.txt" />
      <appendToFile value="true" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="10" />
      <maximumFileSize value="5MB" />
      <staticLogFileName value="true" />
      <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
      </layout>
   </appender>
   <root>
      <level value="ALL" />
      <appender-ref ref="RollingFileAppender" />
   </root>
</log4net>

这个配置文件将日志记录到一个名为“logs\log.txt”的文件中。您可以根据需要进行自定义配置。


三、在项目中使用Log4net

  1. 在您的Winform项目的任何地方,导入log4net的命名空间:
using log4net;
  1. 在您的代码中,声明一个静态的ILog对象来进行日志记录:
private static readonly ILog log = LogManager.GetLogger(typeof(YourForm));
  1. 在需要记录日志的地方,使用ILog对象的方法来记录日志。例如:
log.Info("Information log message");
log.Debug("Debug log message");
log.Error("Error log message");

四、初始化Log4net

  1. 在您的Winform项目的入口点或App.config文件中,添加以下初始化代码:
[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config")]

这将告诉Log4net使用先前创建的log4net.config文件进行配置。


五、运行应用程序并检查日志

  1. 运行您的.Winform应用程序。
  2. 检查日志目录中的log.txt文件,以查看记录的日志消息。

六、完整代码示例

以下是我修改完善后的代码示例,可以直接复制粘贴使用

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
	<configSections>
		<!--添加自定义节点:log4net type:解析类名,程序集名(log4net.dll)-->
		<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
	</configSections>
	<!--只保留创建日期是最近15天的-->
	<log4net OverdueDays="15">
		<root>
			<!--<level value="DEBUG"/>-->
			<!--控制级别,由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
			<!--比如定义级别为INFO,则INFO级别向下的级别,比如DEBUG日志将不会被记录-->
			<level value="ALL"/>
			<!--根据log级别记录到不同的日志文件-->
			<appender-ref ref="DebugLogger" />
			<appender-ref ref="InfoLogger" />
			<!--<appender-ref ref="WarnLogger" />-->
			<appender-ref ref="ErrorLogger" />
			<!--<appender-ref ref="FatalLogger" />-->
		</root>

		<!--Debug文件日志记录器-->
		<appender name="DebugLogger" type="log4net.Appender.RollingFileAppender">
			<!--日志存放文件夹-->
			<file value="Log\Debug_Log\"/>
			<!--是否追加到文件-->
			<appendToFile value="true" />
			<!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<!--使用UTF-8编码-->
			<Encoding value="UTF-8" />
			<!--最多产生的日志文件数,超过则只保留最新的n个。设定值value="-1"为不限文件数-->
			<maxSizeRollBackups value="10"/>
			<!--是否只写到一个文件中-->
			<StaticLogFileName value="false"/>
			<!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
			<rollingStyle value="Date" />
			<!--日期的格式,每天换一个文件记录,如不设置则永远只记录一天的日志,需设置-->
			<param name="datePattern" value="yyyy-MM/yyyy-MM-dd.'log'" />
			<!--过滤设置,LevelRangeFilter为使用的过滤器。-->
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="DEBUG" />
				<levelMax value="DEBUG" />
			</filter>
			<!--日志格式-->
			<layout type="log4net.Layout.PatternLayout">
				<!-- 输出格式 日期,日志级别,消息,换行-->
				<param name="ConversionPattern" value="%date [%-5p] %message%n" />
			</layout>
		</appender>

		<!--InfoLog文件日志记录器-->
		<appender name="InfoLogger" type="log4net.Appender.RollingFileAppender">
			<!--日志存放文件夹-->
			<file value="Log\Run_Log\"/>
			<!--是否追加到文件-->
			<appendToFile value="true" />
			<!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<!--使用UTF-8编码-->
			<Encoding value="UTF-8" />
			<!--最多产生的日志文件数,超过则只保留最新的n个。设定值value="-1"为不限文件数-->
			<maxSizeRollBackups value="10"/>
			<!--是否只写到一个文件中-->
			<StaticLogFileName value="false"/>
			<!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
			<rollingStyle value="Date" />
			<!--日期的格式,每天换一个文件记录,如不设置则永远只记录一天的日志,需设置-->
			<param name="datePattern" value="yyyy-MM/yyyy-MM-dd.'log'" />
			<!--过滤设置,LevelRangeFilter为使用的过滤器。-->
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="INFO" />
				<levelMax value="INFO" />
			</filter>
			<!--日志格式-->
			<layout type="log4net.Layout.PatternLayout">
				<!-- 输出格式 日期,日志级别,消息,换行-->
				<param name="ConversionPattern" value="%date [%-5p] %message%n" />
			</layout>
		</appender>

		<!--WarnLog文件日志记录器-->
		<appender name="WarnLogger" type="log4net.Appender.RollingFileAppender">
			<!--日志存放文件夹-->
			<file value="Log\Warn\"/>
			<!--是否追加到文件-->
			<appendToFile value="true" />
			<!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<!--使用UTF-8编码-->
			<Encoding value="UTF-8" />
			<!--最多产生的日志文件数,超过则只保留最新的n个。设定值value="-1"为不限文件数-->
			<maxSizeRollBackups value="10"/>
			<!--是否只写到一个文件中-->
			<StaticLogFileName value="false"/>
			<!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
			<rollingStyle value="Date" />
			<!--日期的格式,每天换一个文件记录,如不设置则永远只记录一天的日志,需设置-->
			<param name="datePattern" value="yyyy-MM/yyyy-MM-dd.'log'" />
			<!--过滤设置,LevelRangeFilter为使用的过滤器。-->
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="WARN" />
				<levelMax value="WARN" />
			</filter>
			<!--日志格式-->
			<layout type="log4net.Layout.PatternLayout">
				<!-- 输出格式 日期,日志级别,消息,换行-->
				<param name="ConversionPattern" value="%date [%-5p] %message%n" />
			</layout>
		</appender>

		<!--ErrorLog文件日志记录器-->
		<appender name="ErrorLogger" type="log4net.Appender.RollingFileAppender">
			<!--日志存放文件夹-->
			<file value="Log\Error_Log\"/>
			<!--是否追加到文件-->
			<appendToFile value="true" />
			<!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<!--使用UTF-8编码-->
			<Encoding value="UTF-8" />
			<!--最多产生的日志文件数,超过则只保留最新的n个。设定值value="-1"为不限文件数-->
			<maxSizeRollBackups value="10"/>
			<!--是否只写到一个文件中-->
			<StaticLogFileName value="false"/>
			<!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
			<rollingStyle value="Date" />
			<!--日期的格式,每天换一个文件记录,如不设置则永远只记录一天的日志,需设置-->
			<param name="datePattern" value="yyyy-MM/yyyy-MM-dd.'log'" />
			<!--过滤设置,LevelRangeFilter为使用的过滤器。-->
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="ERROR" />
				<levelMax value="ERROR" />
			</filter>
			<!--日志格式-->
			<layout type="log4net.Layout.PatternLayout">
				<!-- 输出格式 日期,日志级别,消息,换行-->
				<param name="ConversionPattern" value="%date [%-5p] %message%n" />
			</layout>
		</appender>

		<!--FatalLog文件日志记录器-->
		<appender name="FatalLogger" type="log4net.Appender.RollingFileAppender">
			<!--日志存放文件夹-->
			<file value="Log\Fatal\"/>
			<!--是否追加到文件-->
			<appendToFile value="true" />
			<!--记录日志写入文件时,不锁定文本文件,防止多线程时不能写Log,官方说线程非安全-->
			<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
			<!--使用UTF-8编码-->
			<Encoding value="UTF-8" />
			<!--最多产生的日志文件数,超过则只保留最新的n个。设定值value="-1"为不限文件数-->
			<maxSizeRollBackups value="10"/>
			<!--是否只写到一个文件中-->
			<StaticLogFileName value="false"/>
			<!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
			<rollingStyle value="Date" />
			<!--日期的格式,每天换一个文件记录,如不设置则永远只记录一天的日志,需设置-->
			<param name="datePattern" value="yyyy-MM/yyyy-MM-dd.'log'" />
			<!--过滤设置,LevelRangeFilter为使用的过滤器。-->
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="FATAL" />
				<levelMax value="FATAL" />
			</filter>
			<!--日志格式-->
			<layout type="log4net.Layout.PatternLayout">
				<!-- 输出格式 日期,日志级别,消息,换行-->
				<param name="ConversionPattern" value="%date [%-5p] %message%n" />
			</layout>
		</appender>

	</log4net>
</configuration>

结论:
通过按照上述步骤,在您的.Net Winform项目中使用Log4net,您可以轻松和高效地实现日志记录功能。这将帮助您在项目中更好地跟踪和记录应用程序的运行情况,并提供有关错误和调试信息的有价值的参考。

引用提到,在一个WinForm项目使用log4net记录日志的过程可以分为以下几个步骤: 1. 安装log4net使用Visual Studio的NuGet程序包管理器,搜索log4net并安装。 2. 添加log4net配置文件:创建一个名为log4net.config的配置文件,并将其添加到项目。 3. 修改AssemblyInfo.cs文件:在AssemblyInfo.cs文件添加配置信息,配置log4net使用的配置文件和文件扩展名。 4. 新增一个LogHelper类:创建一个名为LogHelper的静态类,用于获取log4net的ILogger实例。 5. 初始化log4net:在应用程序的启动过程初始化log4net,通常在程序入口点的Main方法调用log4net.Config.XmlConfigurator.Configure()方法。 6. 使用log4net:通过LogHelper类的WriteLog方法记录日志。 引用提到,首先需要使用Visual Studio的NuGet程序包管理器安装log4net。可以通过项目-管理NuGet程序包的方式来搜索并安装log4net。 引用提到,具体的配置和使用log4net的步骤如下: 1. 在AssemblyInfo.cs文件添加以下配置信息: [assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", ConfigFileExtension = "config", Watch = true)] 2. 在项目根目录(可以根据需要放在其他位置)创建一个LogHelper.cs类,并在该类添加以下代码: public static readonly log4net.ILog loginfo = log4net.LogManager.GetLogger("loginfo"); public static readonly log4net.ILog logerror = log4net.LogManager.GetLogger("logerror"); public static void WriteLog(string info) { if (loginfo.IsInfoEnabled) { loginfo.Info(info); } } public static void WriteLog(string info, Exception se) { if (logerror.IsErrorEnabled) { logerror.Error(info, se); } } 3. 在需要记录日志的地方,使用LogHelper类的WriteLog方法来记录日志,例如: LogHelper.WriteLog(string.Format("当前时间为{0}.", DateTime.Now.ToString())); 以上是在WinForm项目使用log4net记录日志的步骤和方法。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [winform项目使用log4net](https://blog.csdn.net/blueday406/article/details/105009359)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [C# winformLog4Net使用](https://blog.csdn.net/biyusr/article/details/125758707)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

故事不长丨

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值