如何使用新的 DI 将 ILogger 注入使用 IWebJobsStartup 的 Azure 函数？

Question

我正在使用Azure Function v2。这是我使用构造函数注入的函数：

public sealed class FindAccountFunction
{
    private readonly IAccountWorkflow m_accountWorkflow;

    private readonly IMapper m_mapper;

    private readonly ILogger m_logger;

    public FindAccountFunction(ILogger logger, IMapper mapper, IAccountWorkflow accountWorkflow)
    {
        m_logger = logger;
        m_mapper = mapper;
        m_accountWorkflow = accountWorkflow;
    }

    [FunctionName("FindAccount")]
    public async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, Verbs.Get, Route = "v1/accounts/")] HttpRequest httpRequest, ILogger logger)
    {
        // Do stuff.
    }
}

我在派生自 IWebJobsStartup 的 Startup 类中声明了我想要注入到 Azure 函数中的所有依赖项：

    public sealed class Startup : IWebJobsStartup
    {
        public void Configure(IWebJobsBuilder webJobsBuilder)
        {
            //  Registers the application settings' class.
            webJobsBuilder.Services.AddSingleton<IApplicationSettings, ApplicationSettings>();

            //  ** Registers the ILogger instance **
            //  ** ?? **

            //  Registers the IMapper instance for the contracts.
            var mapperConfiguration = new MapperConfiguration(cfg => cfg.AddProfile(new MyProfile()));

     webJobsBuilder.Services.AddSingleton(mapperConfiguration.CreateMapper());

            // Registers custom services.
            webJobsBuilder.Services.AddTransient<IStorageService, StorageService>();

            webJobsBuilder.Services.AddTransient<IAccountWorkflow, AccountWorkflow>();
        }
   }

Azure 函数调用其他也依赖 ILogger 的注入服务，例如 IAccountWorkflow：

public sealed class AccountWorkflow : IAccountWorkflow
{  
    public AccountWorkflow(ILogger logger, IStorageService storageService)
    {
        if(logger is null)
            throw new ArgumentNullException();
    }
}

问题在于 DI 无法找到任何 ILogger 实现并且无法解析服务，因为注入了一个空的 ILogger。

问题

如何在IWebJobsStartup 中设置ILogger 的注入？

Answer 1

更新

参考Use dependency injection in .NET Azure Functions

注册服务

要注册服务，您可以创建一个配置方法并将组件添加到IFunctionsHostBuilder 实例。 Azure Functions 主机创建一个IFunctionsHostBuilder 并将其直接传递到您配置的方法中。

要注册你的配置方法，你必须添加一个程序集属性 指定您的配置方法的类型，使用 FunctionsStartup 属性。

所以在这种情况下

[assembly: FunctionsStartup(typeof(MyNamespace.Startup))]    
namespace MyNamespace {
    public class Startup : FunctionsStartup {
        public override void Configure(IFunctionsHostBuilder builder) {
            //  ** Registers the ILogger instance **
            builder.Services.AddLogging();

            //  Registers the application settings' class.
            //...

            //...omitted for brevity    
        }
    }
}

原创

我相信既然您可以访问服务集合，您应该可以向它添加日志记录

public void Configure(IWebJobsBuilder webJobsBuilder) {       

    //  ** Registers the ILogger instance **
    webJobsBuilder.Services.AddLogging();

    //OR
    //webJobsBuilder.Services.AddLogging(builder => {
    //    //...
    //});

    //  Registers the application settings' class.
    //...

    //...removed for brevity
}

并且在函数的构造函数中有一个ILoggerFactory。

//...

//Ctor
public FindAccountFunction(ILoggerFactory loggerFactory, IMapper mapper, IAccountWorkflow accountWorkflow) {
    m_logger = loggerFactory.CreateLogger<FindAccountFunction>();
    m_mapper = mapper;
    m_accountWorkflow = accountWorkflow;
}

//...

Answer 2

我设法解决了这个问题：

如下注入我的班级：

MyClass.cs：

public class MyClass
{
    private readonly ILogger<MyClass> _logger;

    public MyClass(ILogger<MyClass> logger)
    {
        _logger = logger;
    }
}

Startup.cs：

[assembly: FunctionsStartup(typeof(Namespace.Startup))]   

namespace Namespace {    
public class Startup : FunctionsStartup 
{
    public override void Configure(IFunctionsHostBuilder builder) 
    {
        builder.Services.AddLogging(); 
    }
  }
}

Answer 3

您应该从您的启动类中删除对AddLogging 方法的调用。默认记录器已由 azure 函数主机设置。

[assembly: WebJobsStartup(typeof(StartUp))]
public class StartUp : IWebJobsStartup
{
    public void Configure(IWebJobsBuilder builder)
    {
        builder.Services.AddSingleton<AppSettings>();

        builder.Services.AddTransient<IMyService, MyService>();
    }
}

public MyFunction(IMyService service, ILogger<IMyService> logger)
{
    this.service = service;
    this.logger = logger;
}

自 Azure Functions Runtime 2.0.12265 起，Azure 函数现在支持实例方法

Answer 4

除了在函数 Startup 类中注册类之外，我们还需要在 host.json 文件中添加命名空间，以便将消息记录到 App 洞察力。如果我们不添加它，它只会将消息记录到本地控制台，但在 azure 上部署时，它不会记录任何内容，也不会给出任何错误。

{
  "version": "2.0",
  "logging": {
    "logLevel": {
      "FunctionProjectNameSpace.RegisteredClass": "Information"
    }
  }
}

此处的示例代码供参考 - https://gist.github.com/nareshnagpal06/82c6b4df2a987087425c32adb58312c2

Answer 5

你可以添加

  "logging": {
    "fileLoggingMode": "debugOnly",
    "logLevel": {
      "default": "Information"
    }
  }

如果要使用IloggerFactory，无需添加DI