在 .NET Azure Functions 中使用依赖项注入

Azure Functions 支持依赖项注入 (DI) 软件设计模式,这是一种在类与其依赖项之间实现控制反转 (IoC) 的方法。

  • Azure Functions 中的依赖项注入基于 .NET Core 依赖项注入功能构建。 建议熟悉 .NET Core 依赖项注入。 两者在如何替代依赖项以及如何使用 Azure Functions 对消耗计划读取配置值方面存在差异。

  • 从 Azure Functions 2.x 支持依赖项注入。

  • 依赖项注入模式的不同之处取决于 C# 函数是在进程内运行还是在进程外运行。

重要

本文的指导仅适用于 C# 类库函数,该函数在进程内与运行时配合运行。 该自定义依赖项注入模型不适用于 .NET 隔离函数,故可以在进程外运行 .Net 5.0 函数。 .NET 隔离进程模型依赖于常规 ASP.NET Core 依赖项注入模式。 若要了解更多信息,请参阅 .NET 隔离进程指南中的依赖项注入

先决条件

必须先安装以下 NuGet 包,然后才能使用依赖项注入:

注册服务

若要注册服务,请创建一个方法来配置组件并将组件添加到 IFunctionsHostBuilder 实例。 Azure Functions 主机会创建 IFunctionsHostBuilder 的实例,并将其直接传递到方法中。

若要注册方法,请添加 FunctionsStartup 程序集属性来指定在启动期间使用的类型名称。

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection;

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

namespace MyNamespace
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            builder.Services.AddHttpClient();

            builder.Services.AddSingleton<IMyService>((s) => {
                return new MyService();
            });

            builder.Services.AddSingleton<ILoggerProvider, MyLoggerProvider>();
        }
    }
}

此示例使用在启动时注册 HttpClient 所需的 Microsoft.Extensions.Http 包。

注意事项

在运行时处理启动类之前和之后会运行一系列注册步骤。 因此,请注意以下事项:

  • 启动类仅用于设置和注册。 避免使用在启动时注册的服务。 例如,请勿尝试在记录器中记录在启动过程中注册的消息。 此注册过程点对你的服务来说太早,因此无法使用。 在运行 Configure 方法以后,Functions 运行时会继续注册其他依赖项,这可能影响服务的运行。

  • 依赖项注入容器仅存储显式注册的类型。 能够用作可注入类型的服务仅限在 Configure 方法中设置的服务。 因此,特定于 Functions 的类型(例如 BindingContextExecutionContext)在设置中不可用,也不能用作可注入类型。

使用注入的依赖项

使用构造函数注入以后,依赖项即可在函数中使用。 使用构造函数注入要求你不要对已注入服务或对函数类使用静态类。

以下示例演示了 IMyServiceHttpClient 依赖项是如何注入到 HTTP 触发的函数中的。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;
using System.Net.Http;
using System.Threading.Tasks;

namespace MyNamespace
{
    public class MyHttpTrigger
    {
        private readonly HttpClient _client;
        private readonly IMyService _service;

        public MyHttpTrigger(IHttpClientFactory httpClientFactory, IMyService service)
        {
            this._client = httpClientFactory.CreateClient();
            this._service = service;
        }

        [FunctionName("MyHttpTrigger")]
        public async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            var response = await _client.GetAsync("https://microsoft.com");
            var message = _service.GetMessage();

            return new OkObjectResult("Response from function with injected dependencies.");
        }
    }
}

此示例使用在启动时注册 HttpClient 所需的 Microsoft.Extensions.Http 包。

服务生存期

Azure Functions 应用提供与 ASP.NET 依赖项注入相同的服务生存期。 就 Functions 应用来说,不同的服务生存期表现如下:

  • 暂时性:每次解析此服务时,都会创建暂时性服务。
  • 限定范围:限定范围的服务的生存期与函数执行生存期相匹配。 每次执行函数后,都会创建设有范围的服务。 在执行期间对该服务的后续请求会重复使用现有服务实例。
  • 单一实例:单一实例服务生存期与主机生存期相匹配,并且在该实例上的各个函数执行之间重用。 对于连接和客户端(例如 DocumentClientHttpClient 实例),建议使用单一实例生存期服务。

在 GitHub 上查看或下载不同服务生存期的示例

日志记录服务

如果需要自己的日志记录提供程序,请将自定义类型注册为 ILoggerProvider(可通过 Microsoft.Extensions.Logging.Abstractions NuGet 包获取)的实例。

Azure Functions 会自动添加 Application Insights。

警告

  • 请勿将 AddApplicationInsightsTelemetry() 添加到服务集合,因为它注册的服务与环境提供的服务发生冲突。
  • 如果使用内置 Application Insights 功能,请勿注册自己的 TelemetryConfigurationTelemetryClient。 如果需要配置自己的 TelemetryClient 实例,请通过插入的 TelemetryConfiguration 创建一个实例,如在 C# 函数中记录自定义遥测中所示。

ILogger<T> 和 ILoggerFactory

主机会将 ILogger<T>ILoggerFactory 服务注入构造函数中。 但是在默认情况下,会从函数日志中筛选出新日志记录筛选器。 需要修改 host.json 文件,以选择加入其他筛选器和类别。

下面的示例演示如何添加包含向主机公开的日志的 ILogger<HttpTrigger>

namespace MyNamespace
{
    public class HttpTrigger
    {
        private readonly ILogger<HttpTrigger> _log;

        public HttpTrigger(ILogger<HttpTrigger> log)
        {
            _log = log;
        }

        [FunctionName("HttpTrigger")]
        public async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req)
        {
            _log.LogInformation("C# HTTP trigger function processed a request.");

            // ...
    }
}

下面的示例 host.json 文件添加日志筛选器。

{
    "version": "2.0",
    "logging": {
        "applicationInsights": {
            "samplingSettings": {
                "isEnabled": true,
                "excludedTypes": "Request"
            }
        },
        "logLevel": {
            "MyNamespace.HttpTrigger": "Information"
        }
    }
}

若要详细了解日志级别,请参阅配置日志级别

函数应用提供的服务

函数主机注册许多服务。 以下服务可以安全地用作应用程序中的依赖项:

服务类型 生存期 说明
Microsoft.Extensions.Configuration.IConfiguration 单一实例 运行时配置
Microsoft.Azure.WebJobs.Host.Executors.IHostIdProvider 单一实例 负责提供主机实例的 ID

如果存在你要依赖的其他服务,请在 GitHub 上创建一个问题并提出它们

替代主机服务

目前不支持替代由主机提供的服务。 如果有要替代的服务,请在 GitHub上创建并提出问题

使用选项和设置

应用设置中定义的值可以在 IConfiguration 实例中使用,这使得你可以读取启动类中的应用设置值。

可以将 IConfiguration 实例中的值提取为自定义类型。 如果将应用设置值复制到自定义类型,则通过使这些值可注入,可以轻松地测试服务。 读入到配置实例中的设置必须是简单的键/值对。 请注意,在弹性高级 SKU 上运行的函数具有以下约束:“应用设置名称只能包含字母、数字 (0-9)、句点(‘.’)、冒号(‘:’)和下划线(‘_’)”

请考虑以下类,其中包含一个命名与应用设置一致的属性:

public class MyOptions
{
    public string MyCustomSetting { get; set; }
}

还有一个 local.settings.json 文件,该文件可能按如下所示组织自定义设置:

{
  "IsEncrypted": false,
  "Values": {
    "MyOptions:MyCustomSetting": "Foobar"
  }
}

Startup.Configure 方法内,可以使用以下代码从 IConfiguration 实例将值提取到自定义类型中:

builder.Services.AddOptions<MyOptions>()
    .Configure<IConfiguration>((settings, configuration) =>
    {
        configuration.GetSection("MyOptions").Bind(settings);
    });

调用 Bind 可以将那些与属性名匹配的值从配置复制到自定义实例中。 IoC 容器中现在提供可以注入到函数中的选项实例。

选项对象作为泛型 IOptions 接口的实例注入函数中。 使用 Value 属性访问在配置中发现的值。

using System;
using Microsoft.Extensions.Options;

public class HttpTrigger
{
    private readonly MyOptions _settings;

    public HttpTrigger(IOptions<MyOptions> options)
    {
        _settings = options.Value;
    }
}

有关使用选项的更多详细信息,请参阅 ASP.NET Core 中的选项模式

使用 ASP.NET Core 用户机密

在本地开发时,ASP.NET Core 提供了一个机密管理器工具,可用于将机密信息存储在项目根目录之外。 这使得机密意外提交到源代码管理的可能性更小。 Azure Functions Core Tools(版本 3.0.3233 或更高版本)会自动读取 ASP.NET Core 机密管理器创建的机密。

若要将 .NET Azure Functions 项目配置为使用用户机密,请在项目根目录中运行以下命令。

dotnet user-secrets init

然后,使用 dotnet user-secrets set 命令创建或更新机密。

dotnet user-secrets set MySecret "my secret value"

若要在函数应用代码中访问用户机密值,请使用 IConfigurationIOptions

自定义配置源

注意

从 Azure Functions 主机版本 2.0.14192.0 和 3.0.14191.0 开始,可以使用配置源自定义。

若要指定其他配置源,请替代函数应用的 StartUp 类中的 ConfigureAppConfiguration 方法。

以下示例从基础映像和可选的特定于环境的应用设置文件中添加配置值。

using System.IO;
using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

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

namespace MyNamespace
{
    public class Startup : FunctionsStartup
    {
        public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
        {
            FunctionsHostBuilderContext context = builder.GetContext();

            builder.ConfigurationBuilder
                .AddJsonFile(Path.Combine(context.ApplicationRootPath, "appsettings.json"), optional: true, reloadOnChange: false)
                .AddJsonFile(Path.Combine(context.ApplicationRootPath, $"appsettings.{context.EnvironmentName}.json"), optional: true, reloadOnChange: false)
                .AddEnvironmentVariables();
        }
    }
}

将配置提供程序添加到 IFunctionsConfigurationBuilderConfigurationBuilder 属性。 有关使用配置提供程序的详细信息,请参阅 ASP.NET Core 中的配置

FunctionsHostBuilderContext 是从 IFunctionsConfigurationBuilder.GetContext() 中获取的。 使用此上下文检索当前环境名称,并解析函数应用文件夹中配置文件的位置。

默认情况下,不会自动将配置文件(如 appsettings.json)复制到函数应用的输出文件夹。 更新 .csproj 文件以匹配以下示例,从而确保文件已复制。

<None Update="appsettings.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>      
</None>
<None Update="appsettings.Development.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    <CopyToPublishDirectory>Never</CopyToPublishDirectory>
</None>

重要

对于在消耗计划或高级计划中运行的函数应用,对在触发器中使用的配置值所做的修改可能导致缩放错误。 由 FunctionsStartup 类对这些属性所做的任何更改都会导致函数应用启动错误。

后续步骤

有关详细信息,请参阅以下资源: