NetCore 之 log4net 实战

最新推荐文章于 2024-04-12 18:53:33 发布
最新推荐文章于 2024-04-12 18:53:33 发布
阅读量232 收藏
点赞数
文章标签： log4net NetCore 实战
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/scand123/article/details/132852393
版权

上一篇主要详细介绍log4net相关的一些配置项，本章意在从实战角度详解log4net在NetCore中使用。

1、创建Netcore consol application 通过Nuget package安装log4net(Microsoft.Extensions.Logging.Log4Net.AspNetCore), Hosting(Microsoft.Extensions.Hosting)及DI(Microsoft.Extensions.DependencyInjection),除了log4net 安装DI及Hosting旨在通过DI方式使用ILog。

2、创建log4net.config 文件，设置Copy to Output Directory：Copy Always

<log4net debug="false" update="Merge" threshold="ALL">
    <appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <file value="log4netdemo.log"/>
        <appendToFile value = "true"/>
        <rollingStyle value="Size"/>
        <maximumFileSize value = "10KB" />
        <maxSizeRollbackups value = "2"/>
        <staticLogFileName value = "true"/>
        <!--<layout type ="Log4netDemo.ELKWebLayout, Log4netDemo"/>-->
        <layout type="Log4netDemo.DemoPatterLayout,Log4netDemo">
            <param name="ConversionPattern" value="%d [%t] %5level %clientIP %userName %logger.%method [%line] -MESSAGE: %message %newline %exception"/>
        </layout>
    </appender>
    <root>
        <level value="All" />
        <appender-ref ref="RollingFile"/>
    </root>
</log4net>

log4net basic

  • 配置详解：file 指定日志输出文件地址；appendToFile指定以追加的方式写入日志；rollingStyle指定为size；maximumFileSize最大文件大小10kb；maxSizeRollbackups保留日志文件个数2个；staticLogFileName日志文件为静态命名，rollback的文件会添加后缀.1,.2
  • ConverionPattern value中formart即日志输出到文件中的格式，其中  %clientIP %userName 为自定义PatternConvert.用于将自定义信息以patternLayout的方式输出到日志，具体设置稍后介绍。

创建一个LogService 用于测试Logger

public class LogService
    {
        private static ILog _logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
        private static ILog _loggerInfo = LogManager.GetLogger(Assembly.GetEntryAssembly(), "SpecifyLogger");

        //private readonly ILogger _logger;
        //public LogService(ILogger<LogService> logger)
        //{
        //    _logger = logger;
        //}   

        public void Run()
        {
            _logger.Info($"The application start: {DateTime.Now}.");

        }

        public void RunV2()
        {
            for (int i = 0; i < 200; i++)
            {
                _loggerInfo.Info($"The application start: {DateTime.Now}.");
                _logger.Error($"The application start: {DateTime.Now}.");
            }
        }

        public void RunV3()
        {
            LogicalThreadContext.Properties[LoggerProperty.Ip] = "127.0.0.1";
            LogicalThreadContext.Properties[LoggerProperty.UserName] = "panda";
            LogicalThreadContext.Properties[LoggerProperty.Company] = "zoo";
            LogicalThreadContext.Properties[LoggerProperty.Department] = "suckler";
            _logger.Info($"Test for the customize elk layout.");
        }

        public void RunV4()
        {
            for (int i = 0; i < 200; i++)
            {
                _logger.Info($"This is root logger - {i}.");
            }
            _logger.Fatal($"This is FATAL level error.");
            _loggerInfo.Info($"This is sub logger");
        }
    }

LogService

  • 可以通过构造函数的方式依赖注入ILogger
  • 另一种方式是通过LogManager同样构建ILog
  • 如果配置文件中配置了多个Logger，可以通过指定logger的方式获取到指定Logger，比如LogManager.GetLogger(Assembly.GetEntryAssembly(), "SpecifyLogger");获取SpecifyLogger对象。

将LogService注入到容器中及配置log4net

using Log4netDemo;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

var builder = new HostBuilder()
    .ConfigureServices((hostContext, services) =>
    {
        services.AddTransient<LogService>();
    })
    .ConfigureLogging(logBuilder =>
    {
        logBuilder.AddLog4Net("log4net.config", true);
    }).UseConsoleLifetime();
var host = builder.Build();


var logService = host.Services.GetRequiredService<LogService>();
logService.RunV4();
host.Run();

Program.cs

启动程序可以看到生成了一个log4netdemo.log文件，并且日志成功写入

 以上只是log4net的基本使用，下面介绍log4net的进阶操作

1、如果log4net build-in PatternLayout format不能满足开发需求，比如想要将Ip，userName，Company，department等信息通过PatternLayout format记录到日志怎么做，这里就需要自定义PatternConvert，下面示例自定义了ClientIPPatternConvert及UserNamePatternConvert

public class ClientIPPatternConvert : PatternLayoutConverter
{
    protected override void Convert(TextWriter writer, LoggingEvent loggingEvent)
    {
        var props = loggingEvent.GetProperties();
        if (props?[LoggerProperty.Ip] != null)
            writer.Write($"IP:{props?[LoggerProperty.Ip].ToString()}");
    }
}

ClientIPPatternConvert 

public class UserNamePatternConvert : PatternLayoutConverter
{
    protected override void Convert(TextWriter writer, LoggingEvent loggingEvent)
    {
        var props = loggingEvent.GetProperties();
        if (props?[LoggerProperty.UserName] != null)
            writer.Write($"user name:{props?[LoggerProperty.UserName]}");
    }
}

UserNamePatternConvert

 接下来需要将自定义的PatternConverter加到log4net的PatternLayout中，创建一个DemoPatternLayout继承自 log4net.Layout.PatternLayout

public class DemoPatterLayout: log4net.Layout.PatternLayout
{
    public DemoPatterLayout()
    {
        this.AddConverter("clientIP", typeof(ClientIPPatternConvert));
        this.AddConverter("userName", typeof(UserNamePatternConvert));
    }
}

DemoPatterLayout

修改log4net.config中layout配置，指定type="Log4netDemo.DemoPatterLayout,Log4netDemo"，使用自定义的PatternConvert格式化字符串%clientIP, %userName

<layout type="Log4netDemo.DemoPatterLayout,Log4netDemo">
            <param name="ConversionPattern" value="%d [%t] %5level %clientIP %userName %logger.%method [%line] -MESSAGE: %message %newline %exception"/>
        </layout>

Customize layout conversation

在LogService中向log4net添加IP及UserName属性值

LogicalThreadContext.Properties[LoggerProperty.Ip] = "127.0.0.1";
LogicalThreadContext.Properties[LoggerProperty.UserName] = "panda";

log4net property value

运行结果

2、自定义layout，某些情况下不想用PatternConverter format或者想对接ElasticSearch，基于以上case可以定义Layout

创建AbstractLayout基类继承自LayoutSkeleton

public abstract class AbstractLayout : LayoutSkeleton
{
    protected static JsonSerializerOptions _defaultJsonOptions => new() { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull };

    protected abstract string _role { get;}

    public AbstractLayout()
    {
        IgnoresException = false;
    }

    public override void ActivateOptions()
    {

    }

    public override void Format(TextWriter writer, LoggingEvent loggingEvent)
    {
        if (!(loggingEvent.Level == Level.Trace))
            DoFormat(writer, loggingEvent);
    }

    public abstract void DoFormat(TextWriter writer, LoggingEvent loggingEvent);
}

AbstractLayout

BaseLogger的实体类

public class LoggerMessage
{
    private string _defaultDateFormat => "yyyy-MM-ddTHH:mm:ss.fffZ";
    public LoggerMessage(LoggingEvent loggingEvent, string role)
    {
        Time = loggingEvent.TimeStampUtc.ToString(_defaultDateFormat);
        Level = loggingEvent.Level.Name;
        Thread = loggingEvent.ThreadName;
        Logger = loggingEvent.LoggerName;
        Message = loggingEvent.RenderedMessage;
        Role = role;
    }
    public String? Time { get; set; }
    public String? Level { get; set; }
    public String? Thread { get; set; }
    public String? Logger { get; set; }
    public String? Message { get; set; }
    public String? Role { get; set; }
}

Base Logger

定义web模块Layout(可以基于不同的模块或不同的image根据需要创建多个Layout)

public class ELKWebLayout : AbstractLayout
{
    protected override string _role { get => "demo-web"; }

    public override void DoFormat(TextWriter writer, LoggingEvent loggingEvent)
    {
        var props = loggingEvent.GetProperties();
        var webLogger = new WebLoggerMessage(loggingEvent, _role);
        webLogger.Ip = props?[LoggerProperty.Ip]?.ToString() ?? "";
        webLogger.Company = props?[LoggerProperty.Company]?.ToString() ?? "";
        webLogger.Department = props?[LoggerProperty.Department]?.ToString() ?? "";
        writer.WriteLine(JsonSerializer.Serialize(webLogger, _defaultJsonOptions));
    }
}

ELKWebLayout

WebLogger实体类

public class WebLoggerMessage : LoggerMessage
{
    public WebLoggerMessage(LoggingEvent loggingEvent, string role) 
        : base(loggingEvent, role)
    {
    }

    public String? Ip { get; set; }
    public String? Company { get; set; }
    public String? Department { get; set; }
}

Web Logger

在log4net.config中指定自定义的layout

<layout type ="Log4netDemo.ELKWebLayout, Log4netDemo"/>

给log4net自定义属性赋值

LogicalThreadContext.Properties[LoggerProperty.Ip] = "127.0.0.1";
LogicalThreadContext.Properties[LoggerProperty.UserName] = "panda";

log4net property value

运行结果

 3、某些时候想将一些重要的日志信息单独输出到一个文件，而不包含在公共的日志文件中，基于以上需求需要创建多个Appender及Logger，通过Logger中additivity属性决定是否将sub logger信息包含到root logger中，如下配置

<log4net debug="false" update="Merge" threshold="ALL">
    <appender name="RootRoolingFileAppender" type="log4net.Appender.RollingFileAppender">
        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <file value="log4netdemo.log"/>
        <appendToFile value = "true"/>
        <rollingStyle value="Size"/>
        <maximumFileSize value = "10KB" />
        <maxSizeRollbackups value = "2"/>
        <staticLogFileName value = "true"/>
        <layout type="log4net.Layout.PatternLayout">
            <param name="ConversionPattern" value="%d [%t] %5level %logger.%method [%line] -MESSAGE: %message%newline %exception"/>
        </layout>
    </appender>
    <appender name="SubRoolingFileAppender" type="log4net.Appender.RollingFileAppender">
        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <file value="log4netdemo.sub.log"/>
        <appendToFile value = "true"/>
        <rollingStyle value="Size"/>
        <maximumFileSize value = "10KB" />
        <maxSizeRollbackups value = "2"/>
        <staticLogFileName value = "true"/>
        <layout type="log4net.Layout.PatternLayout">
            <param name="ConversionPattern" value="%d [%t] %5level %logger.%method [%line] -MESSAGE: %message%newline %exception"/>
        </layout>
    </appender>
    <root>
        <level value="All" />
        <appender-ref ref="RootRoolingFileAppender"/>
    </root>
    <logger name="SpecifyLogger" additivity="false">
        <level value="All" />
        <appender-ref ref="SubRoolingFileAppender"/>
    </logger>
</log4net>

Multiple Logger Appender

在LogService中通过Logger name指定使用哪个Logger

private static ILog _logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private static ILog _loggerV2 = LogManager.GetLogger(Assembly.GetEntryAssembly(), "SpecifyLogger");

启动程序生成两个log文件

 查看log信息发现log4netdemo.log中不会记录SpecifyLogger 记录的日志信息，因为在创建SpecifyLogger 时设置additivity="false"

 4、有时可能还有需求，不同Appender需要记录不同level 日志信息，比如FATAL level的信息需要单独一个文件记录，或者INFO-ERROR level range的日志信息需要记录到某个文件中，基于以上需求可以在Appender中添加filter实现

a.只会记录FATAL level的日志信息

<filter type="log4net.Filter.LevelMatchFilter">
  <levelToMatch value ="FATAL"/>
</filter>
<filter type="log4net.Filter.DenyAllFilter"/>

FATAL Filter

b.记录Level范围在INFO和ERROR之间的日志信息

<filter type="log4net.Filter.LevelMatchFilter">
     <levelMax value ="ERROR"/>
     <levelMin value ="INFO"/>
</filter>
<filter type="log4net.Filter.DenyAllFilter"/>

Level Range

 Filter执行原理是顺序执行，如果满足上一个Filter则日志会被记录；如果不满足上一个Filter会继续匹配下一个Filter。

最后附上完整的代码结构

 如有任何问题，请留言，谢谢！！!

 

From： https://www.ips99.com/show/4/452898.html

scand123
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
.Net Core6.0 WebAPI项目框架搭建十：log4net完美实现全局异常日志记录
yigu4011的博客
06-02 1689
在在Web.Core.API下新建 Log4Net 文件夹内，新建 ILoggerHelper.cs。
.NET Core引入Log4Net日志
01-16
比较通用的日志Demo，如果想要自己创建，可以参考文档https://www.cnblogs.com/andyemm/p/14286975.html
.net core整合log4net的解决方案
01-02
概述 log4net是.Net下一个非常优秀的开源日志记录组件。log4net记录日志的功能非常强大。它可以将日志分不同的等级，以不同的格式，输出到不同的媒介。 背景 前两天，曾经的一个同事咨询我，怎样将log4net以中间件的形式整合到core里边去。我不假思索的回答，这种问题应该有人做过吧，他说没有。于是，我去博客园搜了下，发现还真没有，全部都是传统.NET那一套，直接LogManager.GetLogger，于是趁着周末有时间，决定调研下这个问题。去巨硬官网快速浏览了下，扩展第三方日志的核心就在于两个接口：ILogger和ILoggerProvider。于是建好解决方案，刷刷刷实现这两
.Net Core使用log4net
yhj198927的博客
12-30 2707
一、首先在项目中添加log4net的引用，这里不再展示 二、log4net.config配置代码如下： <?xml version="1.0" encoding="utf-8"?> <configuration> <log4net debug="true"> <logger name="Logger"> <!--<priority value="ALL"/>--> <level value="ALL"/> <!-
.NET Core使用log4Net日志框架
最新发布
xll的博客
04-12 522
在项目中,一般为了方便维护,简单的日志是难以达到要求的,此时我们就需要更加具体的日志来完成项目的监护.我这里选择将日志信息保存到数据库。这里有个问题是Request.Body默认是不允许重复读取的,因此我们要在program.cs中允许body重复读取.方法过滤器主要用于在方法执行前和方法执行后保存相关日志记录。1. 写一个方法用于获取需要保存的日志信息。此时我们运行项目,简单的日志文件就生成了。最后,这个日志功能就成功实现了。这个步骤就不展示了,比较简单。1. 首先添加服务接口。3. 创建方法过滤器。
.net core 使用log4net（.net 6.0/.net 8.0）
吾辈萝莉控的博客
12-10 1479
.net 6.0/.net 8.0 使用log4net
.NetCore之log4net的使用
csdn2990的博客
08-24 1054
2.添加配置文件log4net.config。4.在服务中采用单例生命周期注入。5.添加全局异常过滤器。
NetCore下的log4
weixin_30328063的博客
07-26 138
.NET常用的日志组件有NLog、Log4net等，.NET CORE下微软也自带了日志组件，到目前为止还没用过，而我本人常用的是log4net，下面简单讲讲.NET CORE下怎么使用log4net记录日志。 新建一个ASP.NET CORE项目，为项目添加log4net程序包， log4net.config文件配置如下： 1 <?xml version="1.0" en...
.netcore使用Log4Net
码农的专栏
04-27 1024
一、新建项目：Log4netDemo 二、配置文件 log4net.config <log4net> <appender name="Console" type="log4net.Appender.ConsoleAppender"> <layout type="log4net.Layout.PatternLayout"> <!-- Pattern to output the caller's file name and line number -
NetCore 使用Log4Net（两种方式）
kevin860的博客
06-20 8449
首先去Nuget中安装Log4Net包 安装：log4net 安装：Microsoft.Extensions.Logging.Console 安装：Microsoft.Extensions.Logging.Log4Net.AspNetCore 方式一 Program.cs文件 using Microsoft.AspNetCore; using Microsoft.AspNetCore....
.NET Core下使用Log4Net记录日志的方法步骤
12-16
Log4Net 相信大家都很熟悉了，算是比较主流和著名的日志组件了。 官网： logging.apache.org 开源地址： https://github.com/apache/logging-log4net 最佳实践 在项目中添加组件包 Install-Package log4net 添加 log4net.config 文件 <?xml version="1.0" encoding="utf-8" ?> <section name="log4net" type="log4net.Config.Log4NetConfi
net Core 5.0 Log4Net 全局注册
01-10
net core5 Log4Net 全局注册，日志使用
log4net配置文件
06-02
log4net配置文件，放到项目根目录可直接使用，无需做任何修改 asp.net core web类项目
net6 控制台+ log4net+写数据库+自定义字段
03-10
net6 控制台+ log4net+写数据库+自定义字段
log4net配置详细图解+Demo
11-13
资源包含log4net配置过程详细图解文档、Demo、插件，其中log4net配置过程详细图解文档包含插件简介、下载、引入VS2010、配置、使用、总结
NETCore入门系列（Log4NET组件的使用）
qq_40600379的博客
05-06 609
文章目录一、 一、 Nuget安装log4Net和Microsoft.Extensions.Logging.Log4Net.AspNetCore
NetCore采用Log4Net记录日志
qq_41809137的博客
12-01 237
需要安装的包 log4net 版本2.0.8 Microsoft.Extensions.Logging.Log4Net.AspNetCore 版本2.2.6 在Program中添加配置 public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost.CreateDefaultB...
.netcore 6.0 中ef dbfirst 配置连接 实战
09-01
在.NET Core 6.0中使用Entity Framework（EF）的Database First方式配置连接并进行实战是很简单的。 首先，确保你的项目中已经安装了相应的NuGet包，包括`Microsoft.EntityFrameworkCore.Tools`和`Microsoft.EntityFrameworkCore.SqlServer`（如果你使用SQL Server作为数据库）。 接下来，打开终端或命令提示符窗口，进入你的项目文件夹，并执行以下命令来生成EF的模型类： ``` dotnet ef dbcontext scaffold "YourConnectionString" Microsoft.EntityFrameworkCore.SqlServer -o Models ``` 在这个命令中，你需要将"YourConnectionString"替换为你的数据库连接字符串。该命令将自动生成EF的模型类，并将其放在`Models`文件夹中。 完成上述步骤后，你就可以在代码中使用这些生成的模型类来与数据库进行交互了。例如，你可以编写以下代码来获取数据库中的数据： ```csharp using System; using System.Linq; using Microsoft.EntityFrameworkCore; using YourProject.Models; // 替换为你生成的模型类所在的命名空间 namespace YourProject { class Program { static void Main(string[] args) { using (var context = new YourDbContext()) // 替换为你生成的DbContext类的名称 { var data = context.YourTableName.ToList(); // 替换为你数据库中的表名称 foreach (var item in data) { Console.WriteLine(item.PropertyName); // 替换为你表中的属性名称 } } } } } ``` 以上代码演示了如何通过使用生成的模型类和DbContext类来查询数据库中的数据。 这就是在.NET Core 6.0中使用EF的Database First方式配置连接并进行实战的简单过程。希望能对你有所帮助！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值