NETCore入门系列（Log4NET组件的使用）

文章目录

分析

1、官方自带的Log中间件可在命令行中输出日志（通过在构当前控制器的构造函数中注入），如下图：
在这里插入图片描述
2、此时如果想要将日志输出到项目的某个文件中，则可以通过整合Log4net组件。
3、一般建议日志记录直接入库，然后再做一个后台界面，可用来查询记录的日志信息。

整合Log4net

1、安装log4Net和Microsoft.Extensions.Logging.Log4Net.AspNetCoreNuget包，如下图：
在这里插入图片描述
2、在项目根目录创建一个名为Config的目录，并创建一个名为log4net.config的文件。

3、log4net.config的文件配置代码如下所示：

<?xml version="1.0" encoding="utf-8"?>
<log4net>
	<!-- Define some output appenders -->
	<appender name="rollingAppender" type="log4net.Appender.RollingFileAppender">
		<file value="Log\log.txt" />
		<!--追加日志内容-->
		<appendToFile value="true" />

		<!--防止多线程时不能写Log,官方说线程非安全-->
		<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

		<!--可以为:Once|Size|Date|Composite-->
		<!--Composite为Size和Date的组合-->
		<rollingStyle value="Composite" />

		<!--当备份文件时,为文件名加的后缀-->
		<datePattern value="yyyyMMdd.TXT" />

		<!--日志最大个数,都是最新的-->
		<!--rollingStyle节点为Size时,只能有value个日志-->
		<!--rollingStyle节点为Composite时,每天有value个日志-->
		<maxSizeRollBackups value="20" />

		<!--可用的单位:KB|MB|GB-->
		<maximumFileSize value="3MB" />

		<!--置为true,当前最新日志文件名永远为file节中的名字-->
		<staticLogFileName value="true" />

		<!--输出级别在INFO和ERROR之间的日志-->
		<filter type="log4net.Filter.LevelRangeFilter">
			<param name="LevelMin" value="ALL" />
			<param name="LevelMax" value="FATAL" />
		</filter>
		<layout type="log4net.Layout.PatternLayout">
			<conversionPattern value="%date [%thread] %-5level %logger - %message%newline"/>
		</layout>
	</appender>
	<root>
		<priority value="ALL"/>
		<level value="ALL"/>
		<appender-ref ref="rollingAppender" />
	</root>
</log4net>

4、配置Log4net组件的方式有两种（选择其中一种进行配置即可）：
（1）在startup.cs中进行配置：

public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureLogging(loggingBuilder =>
                {  //配置log4Net配置文件的读取
                    loggingBuilder.AddLog4Net("Config/log4net.Config");
                    loggingBuilder.AddConsole();
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });

（2）在startup.cs中配置：

 public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
//配置log4net
        loggerFactory.AddLog4Net("Config/log4net.Config");
}

5、WeatherForecastController中的代码如下，将日志中间件注入到控制器中并使用：

 private readonly ILogger<WeatherForecastController> _logger;
        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
           
            _logger.LogInformation("执行WeatherForecastController构造函数");
        }

        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            var rng = new Random();
            _logger.LogInformation("执行WeatherForecastController  Get");
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

6、运行项目，可看到在控制台与\bin\Debug\net5.0\Log目录中生成了名为log.txt的文件，并正确输出了在控制器中预想输出的日志信息，如下图：
在这里插入图片描述

源码

https://gitee.com/wusuoweixgy/NET5Code/tree/master/ConfigReadWebApp