Skip to content
Server Plugin

依存性の注入

必要な依存関係: io.ktor:ktor-server-di

コード例: server-di

依存性の注入(DI: Dependency injection)は、コンポーネントに必要な依存関係を提供するのに役立つデザインパターンです。モジュールが具体的な実装を直接生成するのではなく抽象に依存し、実行時にDIコンテナが適切なインスタンスを構築して提供します。この分離により結合度が下がり、テスト容易性が向上し、既存のコードを変更することなく実装の置き換えや再設定が容易になります。

Ktorには組み込みのDIプラグインが用意されており、サービスや設定オブジェクトを一度登録すればアプリケーション全体からアクセスできるようになります。一貫した型安全な方法で、これらの依存関係をモジュール、プラグイン、ルート、その他のKtorコンポーネントに注入できます。このプラグインはKtorアプリケーションのライフサイクルと統合されており、スコープ設定、構造化された設定、リソースの自動管理をサポートしているため、アプリケーションレベルのサービスの整理や保守が容易になります。

依存関係の追加 ​

DIを使用するには、ビルドスクリプトに ktor-server-di アーティファクトを含めます。

kotlin
implementation(ktorLibs.server.di)
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
groovy
implementation ktorLibs.server.di
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-di-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

Ktorにおける依存性の注入の仕組み ​

Ktorにおいて、依存性の注入は密接に関連する2つのステップからなる、単一の統合されたプロセスです。

これらのステップは、単一のDIコンテナによって処理されます。

アプリケーションで依存性の注入の使用を開始するには、まず依存関係の登録から始めます。依存関係を宣言したら、続けて依存関係の解決に進んでください。

サポートされている機能 ​

DIプラグインは、一般的なアプリケーションのニーズをカバーするためのさまざまな機能をサポートしています。

設定とライフサイクルの動作 ​

DIコンテナの動作は、設定オプションを使用してカスタマイズできます。これらのオプションにより、依存関係キーの照合方法、競合の処理方法、および高度なシナリオにおける解決の動作を制御します。

設定の詳細については、DIプラグインの設定を参照してください。

リソースのクリーンアップとシャットダウンの動作については、リソースライフサイクル管理を参照してください。

依存性の注入を使用したテスト ​

DIプラグインはKtorのテストユーティリティと統合されており、テスト環境での依存関係のオーバーライド、設定の読み込み、競合動作の制御をサポートしています。

詳細および例については、依存性の注入を使用したテストを参照してください。