依存関係の挿入のガイドライン

[アーティクル]
02/28/2024

この記事では、.NET アプリケーションで依存関係の挿入を実装するための一般的なガイドラインとベストプラクティスについて説明します。

依存関係の挿入のためのサービスの設計

依存関係の挿入のためのサービスの設計時には:

ステートフル、静的クラス、およびメンバーは避けてください。代わりにシングルトンサービスを使用するようにアプリを設計し、グローバルな状態を作成しないようにします。
サービス内部で依存関係のあるクラスを直接インスタンス化することを回避します。直接のインスタンス化は、コードの固有の実装につながります。
サービスを、小さく、十分に要素に分割された、テストしやすいものにします。

クラスに多数の挿入される依存関係がある場合、それは、クラスの責任が多すぎて、単一責任の原則 (SRP) に違反することを示している可能性があります。責任の一部を新しいクラスに移動することにより、クラスのリファクタリングを試みます。

サービスの破棄

コンテナーで作成された型のクリーンアップはコンテナーによって行われ、IDisposable インスタンスで Dispose が呼び出されます。コンテナーから解決されたサービスが、開発者によって破棄されることはありません。型またはファクトリがシングルトンとして登録されている場合、コンテナーによってシングルトンが自動的に破棄されます。

次の例では、サービスがサービスコンテナーによって作成され、自動的に破棄されます。

namespace ConsoleDisposable.Example;

public sealed class TransientDisposable : IDisposable
{
    public void Dispose() => Console.WriteLine($"{nameof(TransientDisposable)}.Dispose()");
}

上の破棄は、一時的な有効期間を使用するためのものです。

namespace ConsoleDisposable.Example;

public sealed class ScopedDisposable : IDisposable
{
    public void Dispose() => Console.WriteLine($"{nameof(ScopedDisposable)}.Dispose()");
}

上の破棄は、スコープ付きの有効期間を使用するためのものです。

namespace ConsoleDisposable.Example;

public sealed class SingletonDisposable : IDisposable
{
    public void Dispose() => Console.WriteLine($"{nameof(SingletonDisposable)}.Dispose()");
}

上の破棄は、シングルトン有効期間を使用するためのものです。

using ConsoleDisposable.Example;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddTransient<TransientDisposable>();
builder.Services.AddScoped<ScopedDisposable>();
builder.Services.AddSingleton<SingletonDisposable>();

using IHost host = builder.Build();

ExemplifyDisposableScoping(host.Services, "Scope 1");
Console.WriteLine();

ExemplifyDisposableScoping(host.Services, "Scope 2");
Console.WriteLine();

await host.RunAsync();

static void ExemplifyDisposableScoping(IServiceProvider services, string scope)
{
    Console.WriteLine($"{scope}...");

    using IServiceScope serviceScope = services.CreateScope();
    IServiceProvider provider = serviceScope.ServiceProvider;

    _ = provider.GetRequiredService<TransientDisposable>();
    _ = provider.GetRequiredService<ScopedDisposable>();
    _ = provider.GetRequiredService<SingletonDisposable>();
}

デバッグコンソールには、実行後に次のサンプル出力が表示されます。

Scope 1...
ScopedDisposable.Dispose()
TransientDisposable.Dispose()

Scope 2...
ScopedDisposable.Dispose()
TransientDisposable.Dispose()

info: Microsoft.Hosting.Lifetime[0]
      Application started.Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
     Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
     Content root path: .\configuration\console-di-disposable\bin\Debug\net5.0
info: Microsoft.Hosting.Lifetime[0]
     Application is shutting down...
SingletonDisposable.Dispose()

サービスコンテナーによって作成されていないサービス

次のコードがあるとします。

// Register example service in IServiceCollection
builder.Services.AddSingleton(new ExampleService());

上のコードでは以下の操作が行われます。

サービスコンテナーにより、ExampleService インスタンスが作成されることはありません。
フレームワークにより、サービスが自動的に破棄されることはありません。
サービスを破棄する責任は開発者にあります。

一時的なインスタンスと共有インスタンスのための IDisposable ガイダンス

一時的で限定的な有効期間

シナリオ

アプリには、次のいずれかのシナリオに対して一時的な有効期間を持つ IDisposable インスタンスが必要です。

インスタンスは、ルートスコープ (ルートコンテナー) で解決されます。
インスタンスは、スコープが終了する前に破棄する必要があります。

解決方法

ファクトリパターンを使用して、親スコープの外部にインスタンスを作成します。このような状況では、通常、アプリケーションには、最終的な型のコンストラクターを直接呼び出す Create メソッドがあります。最終的な型に他の依存関係がある場合、ファクトリは次のことができます。

そのコンストラクターで IServiceProvider を受け取る。
ActivatorUtilities.CreateInstance を使用してコンテナー外部でインスタンスをインスタンス化し、同時にコンテナーを依存関係のために使用する。

共有インスタンス、限定的な有効期間

シナリオ

アプリでは、複数のサービスにわたって共有 IDisposable インスタンスが必要ですが、IDisposable インスタンスの有効期間は限られています。

解決方法

インスタンスをスコープ付きの有効期間で登録します。 IServiceScopeFactory.CreateScope を使用して新しい IServiceScopeを作成します。スコープの IServiceProvider を使用して必要なサービスを取得します。不要になったスコープを破棄します。

`IDisposable` の一般的なガイドライン

IDisposable インスタンスは、一時的な有効期間で登録しないでください。代わりに、ファクトリパターンを使用します。
一時的またはスコープ付きの有効期間の IDisposable インスタンスをルートスコープ内で解決しないでください。唯一の例外は、アプリが IServiceProvider を作成/再作成し、破棄する場合ですが、これは理想的なパターンではありません。
DI を使用して IDisposable 依存関係を受け取る場合、受信側が IDisposable 自体を実装する必要はありません。 IDisposable 依存関係の受信側は、その依存関係で Dispose を呼び出してはなりません。
サービスの有効期間を制御するには、スコープを使用します。スコープは階層構造ではなく、スコープ間に特別な接続はありません。

リソースのクリーンアップの詳細については、「Dispose メソッドの実装」または「DisposeAsync メソッドの実装」を参照してください。また、リソースのクリーンアップに関係があるので、「コンテナーによってキャプチャされた破棄可能な一時サービス」のシナリオについても検討してください。

既定のサービスコンテナーの置換

組み込みのサービスコンテナーは、フレームワークと、ほとんどのコンシューマーアプリのニーズに対応することを目的としたものです。次のようなサポートされない特定の機能が必要な場合でなければ、組み込みのコンテナーを使用することをお勧めします。

プロパティの挿入
名前に基づく挿入 (.NET 7 以前のバージョンのみ。詳しくは、「キー付きサービス」をご覧ください。)
子コンテナー
有効期間のカスタム管理
遅延初期化に対する Func<T> のサポート
規則に基づく登録

次のサードパーティコンテナーは ASP.NET Core アプリで使用できます。

スレッドセーフ

スレッドセーフのシングルトンサービスを作成します。シングルトンサービスに一時的なサービスへの依存関係がある場合、シングルトンによる使い方によっては、一時的なサービスもスレッドセーフであることが必要な場合があります。

シングルトンサービスのファクトリメソッド (例: AddSingleton<TService>(IServiceCollection, Func<IServiceProvider,TService>) に対する 2 番目の引数) をスレッドセーフにする必要はありません。型 (static) のコンストラクターのように、1 つのスレッドによって 1 回のみ呼び出されることが保証されます。

Recommendations

async/await および Task ベースのサービスの解決はサポートされていません。 C# では非同期コンストラクターがサポートされていないため、非同期メソッドはサービスを同期的に解決した後に使用してください。
データと構成をサービスコンテナーに直接格納しないようにします。たとえば、通常、ユーザーのショッピングカートはサービスコンテナーに追加しません。構成では、オプションパターンを使う必要があります。同様に、他のオブジェクトへのアクセスを許可するためだけに存在する "データホルダー" オブジェクトは避ける必要があります。実際のアイテムを DI 経由で要求することをお勧めします。
サービスへの静的なアクセスを行わないようにします。たとえば、他の場所で使用するために IApplicationBuilder.ApplicationServices を静的フィールドまたはプロパティとしてキャプチャしないようにしてください。
DI ファクトリの高速性と同期性を維持します。
サービスロケーターパターンは使用しないようにします。たとえば、サービスインスタンスを取得する場合、DI を使用できるときに、GetService を呼び出さないでください。
回避すべき別のサービスロケーターのバリエーションは、実行時に依存関係を解決するファクトリを挿入することです。この両方のプラクティスによって、複数の制御の反転方式が組み合わせられます。
サービスを構成するときは、BuildServiceProvider の呼び出しを避けてください。 BuildServiceProvider の呼び出しは、通常、開発者が他のサービスの登録する際、サービスを解決したい場合に発生します。代わりに、この理由から IServiceProvider を含むオーバーロードを使用してください。
破棄可能な一時サービスは、破棄のためにコンテナーによってキャプチャされます。これにより、最上位のコンテナーから解決された場合、メモリリークが発生する可能性があります。
スコープの検証を有効にすることで、アプリにスコープ付きサービスをキャプチャするシングルトンがないようにします。詳しくは、「スコープの検証」をご覧ください。

どのような推奨事項であっても、それを無視する必要がある状況が発生する可能性があります。例外はまれです。ほとんどがフレームワーク自体の内の特殊なケースです。

DI は静的/グローバルオブジェクトアクセスパターンの代替機能です。静的オブジェクトアクセスと併用した場合、DI のメリットを実現することはできません。

アンチパターンの例

この記事のガイドラインに加えて、"回避する必要がある" アンチパターンがいくつかあります。このようなアンチパターンの一部は、ランタイム自体の開発によってわかることです。

警告

これらはアンチパターンの例です。そのコードをコピー "しないでください"。これらのパターンを使用 "しないでください"。そして、これらのパターンは絶対に避けてください。

コンテナーによってキャプチャされる破棄可能な一時サービス

IDisposable が実装されている "一時" サービスを登録すると、既定では、アプリケーションが停止してコンテナーが破棄されるまで (コンテナーから解決された場合) またはスコープが破棄されるまで (スコープから解決された場合)、これらの Dispose() ではなく、これらの参照が DI コンテナーに保持されます。これにより、コンテナーレベルから解決された場合、メモリリークが発生する可能性があります。

前のアンチパターンでは、1,000 の ExampleDisposable オブジェクトがインスタンス化されてルート化されます。それらは、serviceProvider のインスタンスが破棄されるまで破棄されません。

メモリリークのデバッグの詳細については、.NET でのメモリリークのデバッグに関する記事を参照してください。

非同期 DI ファクトリでデッドロックが発生する可能性がある

"DI ファクトリ" とは、Add{LIFETIME} を呼び出すと存在するようになるオーバーロードメソッドのことです。 Func<IServiceProvider, T> を受け入れるオーバーロードがあります。T は登録されているサービスであり、パラメーターの名前は implementationFactory です。 implementationFactory は、ラムダ式、ローカル関数、またはメソッドとして提供できます。ファクトリが非同期であり、Task<TResult>.Result を使用している場合、デッドロックが発生します。

前のコードでは、implementationFactory にラムダ式が提供され、その本体で Task<Bar> の Task<TResult>.Result が呼び出されてメソッドが返されます。これにより、"デッドロックが発生します"。 GetBarAsync メソッドは Task.Delay で非同期操作を単にエミュレートしてから、GetRequiredService<T>(IServiceProvider) を呼び出します。

非同期ガイダンスの詳細については、「非同期プログラミング: 重要な情報とアドバイス」を参照してください。デッドロックのデバッグの詳細については、.NET でのデッドロックのデバッグに関する記事を参照してください。

このアンチパターンを実行していてデッドロックが発生した場合は、Visual Studio の [並列スタック] ウィンドウで待機している 2 つのスレッドを確認できます。詳細については、「[並列スタック] ウィンドウでスレッドを表示する」を参照してください。

キャプティブ依存関係

Mark Seemann によって作成された "キャプティブ依存関係" という用語は、サービスの有効期間の誤った構成により、有効期間が長いサービスによって有効期間の短いサービスが捕獲されることを意味します。

上のコードで、Foo はシングルトンとして登録され、Bar はスコープ指定されています。これは表面上は有効であるように見えます。しかし、Foo の実装を考えてみてください。

namespace DependencyInjection.AntiPatterns;

public class Foo(Bar bar)
{
}

Foo オブジェクトには Bar オブジェクトが必要であり、Foo はシングルトンであるため、Bar はスコープ指定されます。これは不適切な構成です。そのように、Foo は 1 回だけインスタンス化され、その有効期間にわたって Bar を保持します。これは、Bar の意図されるスコープ指定された有効期間より長くなります。 validateScopes: true を BuildServiceProvider(IServiceCollection, Boolean) に渡すことによって、スコープを検証することを検討する必要があります。スコープを検証すると、InvalidOperationException と "シングルトン 'Foo' からスコープ指定されたサービス 'bar' を使用することはできません" のようなメッセージを受け取ります。

詳しくは、「スコープの検証」をご覧ください。

シングルトンとしてのスコープ指定されたサービス

スコープ指定されたサービスを使用するとき、スコープを作成しない場合、または既存のスコープ内にいない場合は、サービスはシングルトンになります。

上のコードで、Bar は IServiceScope 内で取得されており、これは正しいことです。アンチパターンの場合は、Bar はスコープの外側で取得されており、どの例の取得が正しくないかを示すため、変数には avoid という名前が付けられています。

依存関係の挿入のガイドライン

依存関係の挿入のためのサービスの設計

サービスの破棄

サービスコンテナーによって作成されていないサービス

一時的なインスタンスと共有インスタンスのための IDisposable ガイダンス

一時的で限定的な有効期間

共有インスタンス、限定的な有効期間

`IDisposable` の一般的なガイドライン

既定のサービスコンテナーの置換

スレッドセーフ

Recommendations

アンチパターンの例

コンテナーによってキャプチャされる破棄可能な一時サービス

非同期 DI ファクトリでデッドロックが発生する可能性がある

キャプティブ依存関係

シングルトンとしてのスコープ指定されたサービス

関連項目

フィードバック

その他のリソース

依存関係の挿入のガイドライン

依存関係の挿入のためのサービスの設計

サービスの破棄

サービス コンテナーによって作成されていないサービス

一時的なインスタンスと共有インスタンスのための IDisposable ガイダンス

一時的で限定的な有効期間

共有インスタンス、限定的な有効期間

IDisposable の一般的なガイドライン

既定のサービス コンテナーの置換

スレッド セーフ

Recommendations

アンチパターンの例

コンテナーによってキャプチャされる破棄可能な一時サービス

非同期 DI ファクトリでデッドロックが発生する可能性がある

キャプティブ依存関係

シングルトンとしてのスコープ指定されたサービス

関連項目

フィードバック

その他のリソース

サービスコンテナーによって作成されていないサービス

`IDisposable` の一般的なガイドライン

既定のサービスコンテナーの置換

スレッドセーフ