.NET Core自定义文件日志依赖options验证器触发循环依赖问题求解
自研文件日志的实现背景
- 基于.NET Core Worker应用场景,官方
Microsoft.Extensions.Logging未提供内置文件日志能力 - 不愿引入Serilog等第三方日志包,计划自研轻量文件日志能力,核心设计包括:
- 将日志存储目录、日志文件命名规则等配置封装为
MyOptions选项类 - 为
MyOptions实现IValidateOptions<MyOptions>接口的专属校验器MyOptionsValidator,用于启动阶段校验配置合法性 - 自定义
FileLoggerProvider作为日志输出提供方,通过注入IOptionsMonitor<MyOptions>实时获取日志相关配置
- 将日志存储目录、日志文件命名规则等配置封装为
启动阶段异常详情
- 应用启动时抛出
System.AggregateException,提示部分服务无法完成构造 - 异常根因为针对
ILoggerFactory的循环依赖,完整依赖解析链路如下:IHostApplicationLifetime构造时需要依赖ILogger<Microsoft.Extensions.Hosting.Internal.ApplicationLifetime>ILogger<T>实例需要从ILoggerFactory获取ILoggerFactory构造时需要解析所有已注册的ILoggerProvider实现,完成FileLoggerProvider的注入FileLoggerProvider构造时需要注入IOptionsMonitor<MyOptions>IOptionsMonitor依赖IOptionsFactory<MyOptions>完成选项实例创建IOptionsFactory构造时需要解析所有已注册的IValidateOptions<MyOptions>实现,完成MyOptionsValidator的构造MyOptionsValidator构造时需要注入ILogger<IValidateOptions<MyOptions>>- 对
ILogger的获取最终又依赖ILoggerFactory,形成无限闭环
问题复现步骤
- 创建新的.NET Core Worker项目,在.csproj文件中添加
<FrameworkReference Include="Microsoft.AspNetCore.App" />引用,获取Kestrel等Web相关能力 - 创建类库项目MyLib并添加到主项目引用中,在MyLib内定义包含
DirectoryPath、FileName属性的MyOptions类 - 实现
MyOptionsValidator类,继承IValidateOptions<MyOptions>接口,构造函数注入ILogger<IValidateOptions<MyOptions>>实例,在Validate方法中校验配置有效性,校验不通过时通过注入的ILogger记录警告 - 在项目根目录的appsettings.json中添加MyOptions配置节,配置日志存储目录、日志文件命名规则
- 编写
IServiceCollection扩展方法AddMyLib,将MyOptionsValidator注册为IValidateOptions<MyOptions>接口的单例服务 - 实现自定义
FileLogger和FileLoggerProvider,其中FileLoggerProvider构造函数注入IOptionsMonitor<MyOptions>,通过ILoggingBuilder扩展方法AddFileLogger将FileLoggerProvider注册为ILoggerProvider接口的单例服务 - 调整启动类配置,注册
MyOptions的配置绑定逻辑,修改Program类的主机构建流程,添加自定义文件日志配置后启动应用,即可触发上述循环依赖异常
核心解决需求
- 保证
FileLoggerProvider可以正常读取MyOptions中的日志目录、文件命名配置 - 保证
MyOptionsValidator可以正常记录配置校验环节的错误信息 - 彻底打破上述循环依赖链路,保障应用正常启动
内容的提问来源于stack exchange,提问作者user13755987
相关产品推荐
相关产品推荐

