首页
/ Serilog中基于基类过滤日志源的实现方案

Serilog中基于基类过滤日志源的实现方案

2025-05-29 04:52:19作者:韦蓉瑛

背景介绍

在日志记录系统中,Serilog是一个功能强大的.NET日志框架。在实际开发中,我们经常需要根据日志来源(SourceContext)对日志进行过滤处理。标准的Serilog提供了Matching.FromSource<T>()方法,可以方便地过滤特定类型的日志。然而,当我们需要基于类型的继承关系进行过滤时(例如过滤某个基类的所有派生类日志),Serilog原生功能就显得有些不足。

问题分析

假设我们有一个动物类继承体系:

public abstract class Animal { }

public class Dog : Animal { }
public class Cat : Animal { }

在日志配置中,我们可能希望:

  1. 过滤掉所有Animal派生类的日志
  2. 或者只允许特定基类派生类型的日志

Serilog原生的Matching.FromSource<T>()只能处理具体类型,无法处理继承关系。例如,我们无法直接实现类似Matching.FromAssignableSource<Animal>()这样的功能。

解决方案

我们可以利用反射技术,在应用程序启动时预先收集所有相关类型,然后构建相应的过滤条件。这种方法虽然使用了反射,但由于只在应用启动时执行一次,性能影响可以接受。

实现步骤

  1. 收集相关类型:通过反射获取程序集中所有继承自目标基类的类型
  2. 构建过滤条件:为每个类型创建对应的SourceContext匹配器
  3. 组合过滤逻辑:将这些匹配器组合成一个综合的过滤条件

具体实现代码

// 一次性反射操作
var names = Assembly.GetExecutingAssembly()
    .GetTypes()
    .Where(x => x.IsAssignableTo(typeof(Animal)))
    .Where(x => x != typeof(Animal)) // 排除基类本身
    .Select(x => x.FullName!);

// 构建过滤条件
Func<LogEvent, bool> matcher = logEvent => 
    names.Select(name => Matching.FromSource(name))
         .Any(predicate => predicate(logEvent));

// 在Serilog配置中使用
.WriteTo.Logger(x => x
    .Filter.ByExcluding(matcher) // 或者使用.ByIncludingOnly(matcher)
    .WriteTo.Console()
)

方案优势

  1. 灵活性:可以处理任意复杂的继承体系
  2. 可维护性:当新增派生类时,无需修改过滤配置
  3. 性能优化:反射操作仅在应用启动时执行一次

注意事项

  1. 如果程序集很大或类型很多,反射操作可能会有一定的性能开销
  2. 需要考虑动态加载类型的情况,可能需要扩展反射的范围
  3. 在多程序集项目中,可能需要扫描多个程序集

扩展思考

这种基于反射的方案不仅适用于日志过滤,还可以应用于其他需要基于类型体系进行操作的场景,如:

  1. 自动化注册依赖注入
  2. 批量应用AOP拦截
  3. 实现插件系统等

通过合理利用.NET的反射能力,我们可以在很多场景下实现更灵活、更自动化的解决方案。

登录后查看全文
热门项目推荐
相关项目推荐