1. 程式人生 > 實用技巧 >NLog 在NetCore中實現多例項注入DI, 實現多租戶模式

NLog 在NetCore中實現多例項注入DI, 實現多租戶模式

通常, 我們在使用了 Microsoft.Extensions.DependencyInjection DI框架的情況下, 我們一般通過

.ConfigureLogging((HostBuilderContext host, ILoggingBuilder logBuilder)=>{
      logBuilder.AddNLog(...)
})

或者

.ConfigureWebHostDefaults(builder=>{
      builder.UseStartup<Startup>()
             .UseNLog(...)
})

等方式將NLog配置進入DI系統.

但是, 如果我們的DI用於多租戶模式,像這樣的NLog沒法做到完全隔離.
因為在其內部都是使用的是一個預設的LogManager.LogFactory 靜態的 NLog.LogFactory 物件, 所以在多次初始化的時候會發生配置覆蓋的情況.
例如下面的這個例子:
//user1_services 的nlog配置會被user2_services的nlog配置覆蓋, 我們就沒法實現多租戶(user1, user2)的完全隔離了. 不能實現不同的使用者寫入不同的地方(provider),使用不同的format, 不同的log level等.

ServiceCollection user1_services= new ServiceCollection();
user1_services.AddLogging(logBuilder=>{
      logBuilder.AddNLog(...)
})
ServiceCollection user2_services= new ServiceCollection();
user2_services.AddLogging(logBuilder=>{
      logBuilder.AddNLog(...)
})

所以, 我們要解決這個問題則要自定義使用的的LogFactory.

var nlogFactory = new NLog.LogFactory(new NLogLoggingConfiguration(configuration.GetSection("active_user_nlog_options"))); // nlog的配置選項, targets, rules 等等.
var nlogProviderOptions = configuration.GetSection("active_user_nlog_provider_options").Get<NLogProviderOptions>();// IncludeScopes, ParseMessageTemplates, IgnoreEmptyEventId 等配置選項
var nlogLoggerProvider = new NLogLoggerProvider(nlogProviderOptions, nlogFactory );
loggerBuilder.AddProvider(nlogLoggerProvider);
//或者
loggerBuilder.AddNLog(sp => new NLog.LogFactory(...));

需要注意的是還有一個feature要注意使用方式, 文件參考:https://github.com/NLog/NLog/wiki/ConfigSetting-Layout-Renderer
因為這貨也是一個靜態變數在維護, 可以通過NLog.LayoutRenderers.LayoutRenderer.Register("configsetting","NLog.Extensions.Logging.ConfigSettingLayoutRenderer")替換掉預設實現.

//預設實現.
private static IConfiguration SetupConfiguration(IServiceProvider serviceProvider, IConfiguration configuration)
{
    configuration = (configuration ?? (serviceProvider?.GetService(typeof(IConfiguration)) as IConfiguration));
    if (configuration != null)
    {
        ConfigSettingLayoutRenderer.DefaultConfiguration = configuration;
    }

    return configuration;
}

至於是否還有其他的坑, 還得踩進去才知道, 日常記錄, 以供參考