.NET Azure Functions で依存関係の挿入を使用する

Azure Functions では、依存関係の挿入 (DI) ソフトウェア デザイン パターンがサポートされています。これは、クラスと依存関係の間で制御の反転 (IoC) を実現するための技術です。

  • Azure Functions の依存関係挿入は、.NET Core の依存関係挿入機能を基盤としています。 .NET Core 依存関係挿入について理解しておくことをお勧めします。 依存関係のオーバーライド方法と、従量課金プランで Azure Functions により構成値を読み取る方法に違いがあります。

  • 依存関係の挿入のサポートは、Azure Functions 2.x から開始されます。

  • 依存関係の挿入パターンは、C# 関数がインプロセスで実行されるか、アウトプロセスで実行されるかによって異なります。

重要

この記事のガイダンスは、ランタイムでインプロセスで実行される C# クラス ライブラリ関数にのみ適用されます。 このカスタム依存関係挿入モデルは .NET 分離関数には適用されないため、.NET 関数はアウトプロセスで実行できます。 .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 メソッド内で設定されるサービスです。 結果的に、BindingContextExecutionContext のような Functions 固有の型は設定中に利用できず、また、挿入可能な型として利用できません。

挿入された依存関係を使用する

コンストラクターの挿入は、依存関係を関数で利用できるようにする目的で使用されます。 コンストラクターの挿入を使用するには、挿入されたサービスまたは関数クラスに対して静的クラスを使用しないようにする必要があります。

次のサンプルでは、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 アプリの場合、各種サービス有効期間が次のように動作します。

  • 一時的:一時的なサービスは、サービスが解決されるたびに作成されます。
  • スコープ付き:スコープ付きサービスの有効期間は、関数実行の有効期間に一致します。 スコープ付きサービスは、関数の実行ごとに 1 回作成されます。 実行時のそのサービスに対する後続の要求では、既存のサービス インスタンスが再利用されます。
  • シングルトン:シングルトン サービスの有効期間はホストの有効期間に一致し、そのインスタンスでの関数実行間で再利用されます。 シングルトン サービスの有効期間は、DocumentClient インスタンスや HttpClient インスタンスなど、接続やクライアントに推奨されます。

GitHub のさまざまなサービスの有効期間のサンプルを表示するか、ダウンロードします。

ログ記録サービス

独自のログ記録プロバイダーが必要な場合は、カスタム型を ILoggerProvider のインスタンスとして登録します。これは、Microsoft.Extensions.Logging.Abstractions NuGet パッケージを通じて使用できます。

Azure Functions によって Application Insights が自動的に追加されます。

警告

  • 環境によって提供されるサービスと競合するサービスが登録されるため、サービス コレクションに AddApplicationInsightsTelemetry() を追加しないでください。
  • 組み込みの Application Insights 機能を使用している場合、独自の TelemetryConfiguration または TelemetryClient を登録しないでください。 独自の TelemetryClient インスタンスを構成する必要がある場合は、C# 関数でカスタム テレメトリをログに記録する方法に関するセクションに示されているように、挿入された TelemetryConfiguration を使用して作成します。

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 インスタンスからカスタムの型に値を抽出できます。 アプリ設定値をカスタムの型にコピーすると、その値が挿入可能になり、サービスのテストが簡単になります。 構成インスタンスに読み込まれる設定は、単純なキーと値のペアである必要があります。 エラスティック Premium 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 コンテナーで options インスタンスを関数に挿入できるようになりました。

options オブジェクトは、汎用 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 にはプロジェクトのルートの外部にシークレット情報を格納できるシークレット マネージャー ツールが用意されています。 これにより、シークレットが誤ってソース管理にコミットされる可能性が低くなります。 ASP.NET Core シークレット マネージャーによって作成されたシークレットは、Azure Functions Core Tools (バージョン 3.0.3233 以降) によって自動的に読み取られます。

ユーザー シークレットを使用するように .NET Azure Functions プロジェクトを構成するには、プロジェクトのルートで次のコマンドを実行します。

dotnet user-secrets init

次に、dotnet user-secrets set コマンドを使用して、シークレットを作成または更新します。

dotnet user-secrets set MySecret "my secret value"

関数アプリ コードでユーザー シークレット値にアクセスするには、IConfiguration または IOptions を使用します。

構成ソースのカスタマイズ

Note

構成ソースのカスタマイズは、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 での構成」を参照してください。

FunctionsHostBuilderContextIFunctionsConfigurationBuilder.GetContext() から取得されます。 このコンテキストを使用して現在の環境名を取得し、関数アプリ フォルダー内の構成ファイルの場所を解決します。

既定では、appsettings.json などの構成ファイルは、関数アプリの出力フォルダーに自動的にコピーされません。 ファイルがコピーされるようにするため、次のサンプルと一致するように .csproj ファイルを更新します。

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

重要

従量課金プランまたは Premium プランで実行されている関数アプリの場合、トリガーで使用される構成値を変更すると、スケーリング エラーが発生する可能性があります。 FunctionsStartup クラスによってこれらのプロパティに変更が加えられると、関数アプリのスタートアップ エラーが発生します。

次のステップ

詳細については、次のリソースを参照してください。