在.NET 6平台下,添加Log4Net到Web API的步骤如下:
1 添加Log4Net
首先,通过NuGet包管理器安装Log4Net。在Visual Studio中,打开“NuGet包管理器”并搜索“log4net”,然后选择与您的项目匹配的版本进行安装。
<ItemGroup>
<PackageReference Include="log4net" Version="2.0.15" />
<PackageReference Include="Microsoft.Extensions.Logging.Log4Net.AspNetCore" Version="6.1.0" />
</ItemGroup>
2 配置log4net.config
在项目的根目录下创建一个名为log4net.config的配置文件,然后按照您的需求进行配置。以下是一个示例配置文件:
<?xml version="1.0" encoding="utf-8" ?>
<log4net>
<!-- Define some output appenders -->
<appender name="rollingAppender" type="log4net.Appender.RollingFileAppender">
<file value="logs\log4net.log" />
<!--追加日志内容-->
<appendToFile value="true" />
<!--防止多线程时不能写Log,官方说线程非安全-->
<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
<!--可以为:Once|Size|Date|Composite-->
<!--Composite为Size和Date的组合-->
<rollingStyle value="Composite" />
<!--当备份文件时,为文件名加的后缀,这里可以作为每一天的日志分别存储不同的文件-->
<datePattern value="yyyyMMdd".txt"" />
<StaticLogFileName value="false"/>
<!--日志最大个数,都是最新的-->
<!--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="DEBUG" />
<param name="LevelMax" value="FATAL" />
</filter>
<layout type="log4net.Layout.PatternLayout">
<!--日志输出格式:时间 日志类型 日志内容-->
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline"/>
</layout>
</appender>
<!-- levels: OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL -->
<root>
<priority value="ALL"/>
<level value="ALL"/>
<appender-ref ref="rollingAppender" />
</root>
</log4net>
# 以下是简单的
<?xml version="1.0" encoding="utf-8"?>
<log4net>
<appender name="FileAppender" type="log4net.Appender.FileAppender">
<file value="logs\log.txt" />
<appendToFile value="true" />
<layout type="log4net.Layout.PatternLayout">
<pattern value="%date [%thread] %-5level %logger - %msg%newline" />
</layout>
</appender>
<root>
<level value="DEBUG" />
<appender-ref ref="FileAppender" />
</root>
</log4net>
在Program.cs文件中添加以下代码
builder.Logging.AddLog4Net("CfgFiles/log4net.config");
或者
3 使用日志并输出日志
构造依赖注入
using Microsoft.AspNetCore.Mvc;
namespace WorldSystem.Api.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class UsersController : ControllerBase
{
private readonly ILogger<UsersController> _logger;
public UsersController(ILogger<UsersController> logger)
{
this._logger = logger;
}
[HttpGet]
public IEnumerable<string> Get()
{
this._logger.LogDebug("LogDebug");
this._logger.LogCritical("LogCritical");
this._logger.LogInformation("LogInformation");
this._logger.LogError("LogError");
this._logger.LogWarning("LogWarning");
return new string[] { "value1", "value2" };
}
[HttpGet("{id}")]
public string Get(int id)
{
return "value";
}
// POST api/<UsersController>
[HttpPost]
public void Post([FromBody] string value)
{
}
// PUT api/<UsersController>/5
[HttpPut("{id}")]
public void Put(int id, [FromBody] string value)
{
}
// DELETE api/<UsersController>/5
[HttpDelete("{id}")]
public void Delete(int id)
{
}
}
}
最后,在需要记录日志的地方使用Log4Net的API。例如,在控制器或服务中注入ILogger接口,并使用ILogger对象记录日志。
以上步骤可以帮助您在.NET 6平台下的Web API项目中添加Log4Net日志记录功能。请确保按照您的项目需求进行适当的配置和调整。