Что делает "Использование" в конфигурации Serilog JSON?
Что на самом деле делает Using в конфигурации Serilog JSON (например, в файле AppSettings.json в среде .Net Core)?
Возьмем для примера эту конфигурацию:
"Serilog": {
"Using": [ "Serilog.Sinks.Console" ], <=======***HERE***=========
"MinimumLevel": "Debug",
"WriteTo": [
{ "Name": "Console" },
{
"Name": "RollingFile",
"Args": {
"pathFormat": "logs\\log-{Date}.txt",
"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}"
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
"Properties": {
"Application": "My Application"
}
}
В приведенном выше примере мы использовали приемник FileБЕЗ, добавив его к атрибуту Using. Однако вроде все работает нормально.
Поэтому я не могу точно понять, зачем нам вообще нужен этот Using. Может кто-нибудь объяснить мне это, пожалуйста?
Ответы 1
Это описано в документации для Serilog.Settings.Configuration:
(This package implements a convention using
DependencyContextto find any package withSeriloganywhere in the name and pulls configuration methods from it, so theUsingexample above is redundant.)
Это означает, что он используется для определения того, какие пакеты используются для поиска приемников Serilog, но он избыточен при использовании пакета Serilog.Settings.Configuration.
Дополнительная информация
Я просмотрел исходный код Serilog, чтобы получить больше информации о том, что именно делает Using и зачем он вообще может понадобиться. Надеюсь, следующее объяснение будет полезным.
Рассмотрим следующую настройку на основе кода:
Log.Logger = new LoggerConfiguration()
.WriteTo.Console()
.CreateLogger();
В этом примере Console является методом расширения для LoggerSinkConfiguration (и поэтому он принимает в качестве первого параметра экземпляр LoggerSinkConfiguration). При использовании этого подхода, основанного на коде, код будет компилироваться только в том случае, если этот метод расширения можно найти в указанной сборке.
Затем рассмотрим следующий подход, в котором используется подход на основе IConfiguration:
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(someConfiguration)
.CreateLogger();
{
"Serilog": {
"Using": ["Serilog.Sinks.Console"], // Redundant.
"WriteTo": ["Console"]
}
}
В этом примере процесс компиляции не знает, на что ссылается строковое значение JSON "Console", и поэтому существует потребность в процессе, который может перейти от строки "Console" к методу расширения Console(), упомянутому выше. Для этого Serilog необходимо сначала найти расширить метод во время выполнения (который в этом примере находится в сборке Serilog.Sinks.Console).
Этот процесс поиска выполняется с использованием отражения, которое выполняет небольшое сканирование сборки до найти методы public static, которые принимают в качестве первого параметра LoggerSinkConfiguration. Директива Using, о которой вы спрашивали в своем вопросе, - это механизм, помогающий точно определить, какие сборки следует сканировать при поиске этих методов расширения.
Как указано в документации, подход на основе IConfiguration использует DependencyContext для автоматически сканировать сборки, в названии которых есть Serilog. Поскольку Serilog.Sinks.Consoleделает имеет в своем имени Serilog, нет необходимости добавлять это в директиву Using. У вас также есть опция предоставьте свой собственный экземпляр DependencyContext при использовании этого подхода, поэтому вам может потребоваться явное указание, какие сборки сканировать при поиске приемников.
В эквивалентном пакете app.config Serilog.Settings.AppSettings, похоже, он предназначен для использования приемников из других сборок. Вот документация. Возможно, он служит той же цели для Serilog.Settings.Configuration? Хотя я не понимаю, как можно без него использовать приемник файлов ...