.Net6 WebAPI使用log4net记录日志

---

一、log4net是什么？

log4net是一个可以帮助程序员把日志信息输出到各种 不同目标的.net类库。它可以容易的加载到开发项目中,实现程序调试和运行的时候的日志信息输出,提供了比.net自己提供的debug类和trace 类的功能更多。log4net是从java下有卓越表现的log4j移植过来的。它是apache基金资助的项目的一部分。

二、使用步骤

1.添加配置文件

根目录下创建log4net.config配置文件

配置内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
	<!-- This section contains the log4net configuration settings -->
	<log4net>
		<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
			<layout type="log4net.Layout.PatternLayout" value="%date [%thread] %-5level %logger - %message%newline" />
		</appender>

		<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
			<file value="logs/Error/" />
			<appendToFile value="true" />
			<rollingStyle value="Composite" />
			<staticLogFileName value="false" />
			<datePattern value="yyyyMMdd'.log'" />
			<maxSizeRollBackups value="10" />
			<maximumFileSize value="1MB" />
			<layout type="log4net.Layout.PatternLayout">
				<conversionPattern value="%date [%thread] %-5level - %message%newline" />
			</layout>
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="ERROR" />
				<!--配置该节点会监听的日志错误级别-->
				<levelMax value="FATAL" />
			</filter>
		</appender>

		<appender name="WarnRollingFileAppender" type="log4net.Appender.RollingFileAppender">
			<file value="logs/Warn/" />
			<appendToFile value="true" />
			<rollingStyle value="Date"/>
			<datePattern value="yyyy-MM-dd'.log'"/>
			<maxSizeRollBackups value="100" />
			<staticLogFileName value="false" />
			<encoding value="utf-8" />
			<layout type="log4net.Layout.PatternLayout">
				<conversionPattern value="%date [%thread] %-5level - %message%newline" />
			</layout>
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="WARN" />
				<levelMax value="WARN" />
			</filter>
		</appender>

		<appender name="InfoRollingFileAppender" type="log4net.Appender.RollingFileAppender">
			<file value="logs/Info/" />
			<appendToFile value="true" />
			<rollingStyle value="Date"/>
			<datePattern value="yyyy-MM-dd'.log'"/>
			<maxSizeRollBackups value="100" />
			<staticLogFileName value="false" />
			<encoding value="utf-8" />
			<layout type="log4net.Layout.PatternLayout">
				<!--<conversionPattern value="%newline%date [%thread %-5level] %n %m%n" />-->
				<conversionPattern value="%date [%thread] %-5level - %message%newline" />
			</layout>
			<filter type="log4net.Filter.LevelRangeFilter">
				<levelMin value="TRACE " />
				<levelMax value="INFO" />
			</filter>
		</appender>

		<!-- Setup the root category, add the appenders and set the default level -->
		<root>
			<level value="ALL" />
			<appender-ref ref="ConsoleAppender" />
			<appender-ref ref="FileAppender" />
			<appender-ref ref="RollingLogFileAppender" />
			<appender-ref ref="WarnRollingFileAppender" />
			<appender-ref ref="InfoRollingFileAppender" />
		</root>

	</log4net>
</configuration>

2.Program使用配置文件

在Program.cs类中添加代码

暂可先不引用nuget包，使用下方封装类库中间接引用即可

ILoggerRepository repository = LogManager.CreateRepository("LogRepository");
XmlConfigurator.Configure(repository, new FileInfo("Config/log4net.config"));

3.封装log4net操作

3.1新建一个类库，添加nuget包。

3.2工具类

创建工具类

内容如下：
输出时添加了日志的调用类和调用方法名，如不需要可自行删除。

public class LogUtil
{
    
    
    private static readonly ILog log = LogManager.GetLogger("LogRepository", typeof(LogUtil));

    /// <summary>
    /// 组织调用方法-日志信息
    /// </summary>
    /// <returns></returns>
    private static string GetCallerNameAndMsg(string msg)
    {
    
    
        var callerMethod = new StackFrame(2, true)?.GetMethod();
        if (callerMethod == null)
        {
    
    
            return msg;
        }

        return $"{
      
      callerMethod.DeclaringType.FullName }.{
      
      callerMethod.Name}-{
      
      msg}";
    }

    /// <summary>
    /// 日常日志
    /// </summary>
    /// <param name="msg"></param>
    /// <param name="obj"></param>
    public static void Info(string msg)
    {
    
    
        if (log.IsInfoEnabled && !string.IsNullOrEmpty(msg))
        {
    
    
            log.Info(GetCallerNameAndMsg(msg));
        }
    }
    /// <summary>
    /// 警告日志
    /// </summary>
    /// <param name="msg"></param>
    /// <param name="obj"></param>
    public static void Warn(string msg)
    {
    
    
        if (log.IsWarnEnabled && !string.IsNullOrEmpty(msg))
        {
    
    
            log.Warn(GetCallerNameAndMsg(msg));
        }
    }

    /// <summary>
    /// 错误日志
    /// </summary>
    /// <param name="msg"></param>
    /// <param name="obj"></param>
    public static void Error(string msg)
    {
    
    
        if (log.IsErrorEnabled && !string.IsNullOrEmpty(msg))
        {
    
    
            log.Error(GetCallerNameAndMsg(msg));
        }
    }
}

4.使用方法

需要使用的项目引用Common类库，方法直接调用即可。

Common.Helper.LogUtil.Info("测试日志");