依存性注入(DI)の必要性と実装パターン完全解説

依存性注入(DI)とは?その基本概念と重要性
依存性注入(Dependency Injection、DI)とは、あるコンポーネントが依存する他のコンポーネントやオブジェクトを、外部から提供(注入)する設計パターンです。これにより、コンポーネント間の結合度を下げ、テストや保守がしやすいコードを実現できます。
依存性注入の基本的な考え方は、「必要なものを自分で作るのではなく、外から受け取る」というシンプルなものです。例えば以下のコードを見てみましょう:
// 依存性注入を使わない場合
class UserService {
constructor() {
this.database = new Database(); // 自分で依存オブジェクトを作成
}
getUser(id) {
return this.database.find('users', id);
}
}
上記のコードでは、UserService
クラスが自身でDatabase
オブジェクトを生成しています。これによりUserService
とDatabase
の間に強い結合が生まれます。これを依存性注入を使って書き直すと:
// 依存性注入を使う場合
class UserService {
constructor(database) {
this.database = database; // 外部から依存オブジェクトを受け取る
}
getUser(id) {
return this.database.find('users', id);
}
}
// 使用例
const db = new Database();
const userService = new UserService(db);
依存性注入の重要性は以下の点にあります:
- テスタビリティの向上: 実際のデータベースの代わりにモックオブジェクトを注入できるため、ユニットテストが容易になります
- 疎結合の実現: コンポーネント間の依存関係が明示的になり、変更の影響範囲を限定できます
- コードの再利用性の向上: 異なる依存オブジェクトを注入することで、同じコンポーネントを様々なコンテキストで再利用できます
- 関心の分離: 各コンポーネントが自身の責務に集中できるようになります
実際のプロジェクトでは、依存性注入を効果的に活用することで、アプリケーションの柔軟性と保守性を大幅に向上させることができます。
依存性注入が必要な理由:テスト容易性と疎結合の実現
依存性注入を採用する最も重要な理由は、テスト容易性と疎結合の実現です。具体的に見ていきましょう。
テスト容易性の向上
依存性注入を使用しないコードは、テストが困難です。例えば以下のケースを考えてみましょう:
// 依存性注入なしの場合
class PaymentProcessor {
constructor() {
this.paymentGateway = new ExpensivePaymentGateway();
}
processPayment(amount) {
return this.paymentGateway.charge(amount);
}
}
このコードをテストするには、実際にExpensivePaymentGateway
クラスの実装が必要で、外部APIへの接続が発生する可能性があります。これは以下の問題を引き起こします:
- テストが遅くなる
- テストが不安定になる(外部サービスの状態に依存)
- テスト環境のセットアップが複雑になる
依存性注入を使用すると、これらの問題を解決できます:
// 依存性注入を使ったテスト可能なコード
class PaymentProcessor {
constructor(paymentGateway) {
this.paymentGateway = paymentGateway;
}
processPayment(amount) {
return this.paymentGateway.charge(amount);
}
}
// テストコード
test('支払い処理が正常に行われること', () => {
// 本物のゲートウェイの代わりにモックを使用
const mockGateway = {
charge: jest.fn().mockReturnValue(true)
};
const processor = new PaymentProcessor(mockGateway);
const result = processor.processPayment(100);
expect(result).toBe(true);
expect(mockGateway.charge).toHaveBeenCalledWith(100);
});
疎結合の実現
疎結合(低結合)とは、コンポーネント間の依存関係を最小限に抑えた状態を指します。依存性注入は疎結合を実現する効果的な手段です。
// 強結合の例
class OrderService {
private database = new MySQLDatabase();
saveOrder(order) {
this.database.save('orders', order);
}
}
上記のコードでは、OrderService
がMySQLDatabase
に強く結合しています。もしデータベースをMongoDBに変更したい場合、OrderService
自体を修正する必要があります。
// 依存性注入を使った疎結合の例
interface Database {
save(collection: string, data: any): void;
}
class OrderService {
constructor(private database: Database) {}
saveOrder(order) {
this.database.save('orders', order);
}
}
// MySQL実装
class MySQLDatabase implements Database {
save(collection, data) {
// MySQLへの保存処理
}
}
// MongoDB実装
class MongoDatabase implements Database {
save(collection, data) {
// MongoDBへの保存処理
}
}
// 使用例
const orderService = new OrderService(new MySQLDatabase());
// または
const orderService = new OrderService(new MongoDatabase());
この実装では、OrderService
はデータベースの具体的な実装に依存せず、抽象的なインターフェースのみに依存しています。これにより:
- データベースの実装を変更しても
OrderService
を修正する必要がない - 新しいデータベース実装の追加が容易
OrderService
はデータベースの詳細を知らなくて良い(関心の分離)
依存性注入を活用することで、アプリケーションのコンポーネントは単一責任の原則に従い、より柔軟で保守しやすいものになります。
DIの実装パターン:コンストラクタ注入、セッター注入、インターフェース注入
依存性注入には主に3つの実装パターンがあります。それぞれの特徴と適切な使用シーンを見ていきましょう。
1. コンストラクタ注入
コンストラクタ注入は、依存オブジェクトをクラスのコンストラクタを通じて注入する方法です。
class ProductService {
private repository: ProductRepository;
private logger: Logger;
// コンストラクタを通じて依存オブジェクトを注入
constructor(repository: ProductRepository, logger: Logger) {
this.repository = repository;
this.logger = logger;
}
getProduct(id: string) {
this.logger.log(`Getting product: ${id}`);
return this.repository.findById(id);
}
}
// 使用例
const productService = new ProductService(
new MySQLProductRepository(),
new ConsoleLogger()
);
メリット:
- 依存関係が明示的で分かりやすい
- インスタンス作成時に必要な依存がすべて揃っていることを保証できる
- 依存オブジェクトを不変(イミュータブル)に保てる
- テストしやすい
デメリット:
- コンストラクタの引数が多くなると扱いにくくなる
- オプショナルな依存の扱いが難しい
2. セッター注入(プロパティ注入)
セッター注入は、依存オブジェクトをセッターメソッドまたはプロパティを通じて注入する方法です。
class NotificationService {
private emailSender;
private smsSender;
// セッターメソッドを通じて依存を注入
setEmailSender(emailSender) {
this.emailSender = emailSender;
}
setSmsSender(smsSender) {
this.smsSender = smsSender;
}
notify(user, message) {
if (this.emailSender) {
this.emailSender.send(user.email, message);
}
if (this.smsSender) {
this.smsSender.send(user.phone, message);
}
}
}
// 使用例
const notificationService = new NotificationService();
notificationService.setEmailSender(new EmailService());
// SMSは必要な場合のみ設定
if (config.smsEnabled) {
notificationService.setSmsSender(new SMSService());
}
メリット:
- オプショナルな依存を扱いやすい
- インスタンス作成後に依存を変更できる
- コンストラクタがシンプルになる
デメリット:
- 依存関係が暗黙的になりがち
- 必須の依存が注入されているか保証できない
- イミュータブルなオブジェクトを作れない
3. インターフェース注入
インターフェース注入は、注入される側のクラスが特定のインターフェースを実装し、そのインターフェースが依存オブジェクトを受け取るためのメソッドを定義する方法です。
// 依存注入用のインターフェース
interface LoggerInjector {
injectLogger(logger: Logger): void;
}
interface RepositoryInjector {
injectRepository(repository: Repository): void;
}
// 両方のインターフェースを実装したクラス
class UserManager implements LoggerInjector, RepositoryInjector {
private logger: Logger;
private repository: Repository;
injectLogger(logger: Logger): void {
this.logger = logger;
}
injectRepository(repository: Repository): void {
this.repository = repository;
}
createUser(userData) {
this.logger.log('Creating new user');
return this.repository.save('users', userData);
}
}
// 使用例
const userManager = new UserManager();
userManager.injectLogger(new FileLogger());
userManager.injectRepository(new MongoRepository());
メリット:
- クラスが必要とする依存関係が明示的に定義される
- 複数のフレームワークで使用される可能性のあるクラスに適している
- 特定のインターフェースに準拠しているため型安全性が高い
デメリット:
- 実装が複雑になりがち
- ボイラープレートコードが増える
- コンストラクタ注入やセッター注入に比べて一般的でない
実装パターンの選択基準
実際のプロジェクトでは、これらのパターンを状況に応じて組み合わせて使用することが多いです。選択の指針としては:
- コンストラクタ注入:必須の依存関係がある場合に最適。特にイミュータブルなオブジェクトを作りたい場合に適している
- セッター注入:オプショナルな依存がある場合や、依存関係が多い場合に便利
- インターフェース注入:フレームワークとの統合や、特定のインターフェースに準拠する必要がある場合に使用
多くの現代的なDIフレームワークでは、コンストラクタ注入がデフォルトの方法として推奨されています。シンプルで明示的なため、コードの可読性と保守性が高まるためです。
実践的な依存性注入の実装例:JavaScriptとTypeScriptによるアプローチ
ここでは、JavaScriptとTypeScriptを使って依存性注入を実装する実践的な例を紹介します。実際のコードで見ていくことで、より理解が深まるでしょう。
JavaScriptでのDI実装例
JavaScriptでは型情報がないため、慣例やドキュメントを通じて依存関係を明示的にする必要があります。簡単なブログアプリケーションを例に見てみましょう。
// 依存オブジェクト
class PostRepository {
constructor(db) {
this.db = db;
}
findAll() {
return this.db.query('SELECT * FROM posts');
}
findById(id) {
return this.db.query('SELECT * FROM posts WHERE id = ?', [id]);
}
create(post) {
return this.db.query('INSERT INTO posts (title, content) VALUES (?, ?)',
[post.title, post.content]);
}
}
class Logger {
log(message) {
console.log(`[${new Date().toISOString()}] ${message}`);
}
error(message, error) {
console.error(`[${new Date().toISOString()}] ERROR: ${message}`, error);
}
}
// DI実装のサービスクラス
class PostService {
/**
* @param {PostRepository} repository - 投稿リポジトリ
* @param {Logger} logger - ロガー
*/
constructor(repository, logger) {
this.repository = repository;
this.logger = logger;
}
async getAllPosts() {
try {
this.logger.log('Getting all posts');
return await this.repository.findAll();
} catch (error) {
this.logger.error('Failed to get posts', error);
throw error;
}
}
async getPost(id) {
try {
this.logger.log(`Getting post with id: ${id}`);
return await this.repository.findById(id);
} catch (error) {
this.logger.error(`Failed to get post with id: ${id}`, error);
throw error;
}
}
async createPost(postData) {
try {
this.logger.log('Creating new post');
return await this.repository.create(postData);
} catch (error) {
this.logger.error('Failed to create post', error);
throw error;
}
}
}
// 使用例
const db = new Database('mysql://localhost:3306/blog');
const postRepository = new PostRepository(db);
const logger = new Logger();
const postService = new PostService(postRepository, logger);
// サービスの利用
async function displayPosts() {
const posts = await postService.getAllPosts();
posts.forEach(post => {
console.log(`${post.title} - ${post.content.substring(0, 50)}...`);
});
}
TypeScriptでのDI実装例
TypeScriptでは、インターフェースを活用して型安全なDIを実現できます。
// インターフェース定義
interface Database {
query(sql: string, params?: any[]): Promise<any[]>;
}
interface IPostRepository {
findAll(): Promise<Post[]>;
findById(id: string): Promise<Post | null>;
create(post: PostCreateDto): Promise<Post>;
}
interface ILogger {
log(message: string): void;
error(message: string, error?: Error): void;
}
// モデル
interface Post {
id: string;
title: string;
content: string;
createdAt: Date;
}
interface PostCreateDto {
title: string;
content: string;
}
// 実装クラス
class MySQLDatabase implements Database {
private connection: any;
constructor(connectionString: string) {
// 接続処理(簡略化)
this.connection = { /* ... */ };
}
async query(sql: string, params?: any[]): Promise<any[]> {
// 実際のクエリ処理(簡略化)
return [];
}
}
class PostRepository implements IPostRepository {
constructor(private db: Database) {}
async findAll(): Promise<Post[]> {
return this.db.query('SELECT * FROM posts');
}
async findById(id: string): Promise<Post | null> {
const results = await this.db.query('SELECT * FROM posts WHERE id = ?', [id]);
return results.length > 0 ? results[0] : null;
}
async create(post: PostCreateDto): Promise<Post> {
const result = await this.db.query(
'INSERT INTO posts (title, content) VALUES (?, ?)',
[post.title, post.content]
);
return {
id: result.insertId,
...post,
createdAt: new Date()
};
}
}
class ConsoleLogger implements ILogger {
log(message: string): void {
console.log(`[${new Date().toISOString()}] ${message}`);
}
error(message: string, error?: Error): void {
console.error(`[${new Date().toISOString()}] ERROR: ${message}`, error);
}
}
// サービスクラス(DIの受け手)
class PostService {
constructor(
private repository: IPostRepository,
private logger: ILogger
) {}
async getAllPosts(): Promise<Post[]> {
try {
this.logger.log('Getting all posts');
return await this.repository.findAll();
} catch (error) {
this.logger.error('Failed to get posts', error as Error);
throw error;
}
}
async getPost(id: string): Promise<Post | null> {
try {
this.logger.log(`Getting post with id: ${id}`);
return await this.repository.findById(id);
} catch (error) {
this.logger.error(`Failed to get post with id: ${id}`, error as Error);
throw error;
}
}
async createPost(postData: PostCreateDto): Promise<Post> {
try {
this.logger.log('Creating new post');
return await this.repository.create(postData);
} catch (error) {
this.logger.error('Failed to create post', error as Error);
throw error;
}
}
}
// 利用例
const db = new MySQLDatabase('mysql://localhost:3306/blog');
const postRepository = new PostRepository(db);
const logger = new ConsoleLogger();
const postService = new PostService(postRepository, logger);
// テスト用のモックを使用する例
class MockPostRepository implements IPostRepository {
private posts: Post[] = [{
id: '1',
title: 'テスト投稿',
content: 'これはテスト投稿です',
createdAt: new Date()
}];
async findAll(): Promise<Post[]> {
return this.posts;
}
async findById(id: string): Promise<Post | null> {
return this.posts.find(post => post.id === id) || null;
}
async create(post: PostCreateDto): Promise<Post> {
const newPost: Post = {
id: (this.posts.length + 1).toString(),
...post,
createdAt: new Date()
};
this.posts.push(newPost);
return newPost;
}
}
// テスト用のサービスインスタンス
const testPostService = new PostService(
new MockPostRepository(),
new ConsoleLogger()
);
シンプルなDIコンテナの実装
小〜中規模のプロジェクトでは、シンプルなDIコンテナを自作することもできます。次に例を示します:
class DIContainer {
private dependencies: Map<string, any> = new Map();
// 依存関係を登録
register<T>(key: string, dependency: T): void {
this.dependencies.set(key, dependency);
}
// 依存関係を取得
resolve<T>(key: string): T {
const dependency = this.dependencies.get(key);
if (!dependency) {
throw new Error(`Dependency not found: ${key}`);
}
return dependency as T;
}
// クラスのインスタンスを作成(コンストラクタ注入)
createInstance<T>(Constructor: new (...args: any[]) => T, ...args: any[]): T {
return new Constructor(...args);
}
}
// 使用例
const container = new DIContainer();
// 依存関係の登録
const db = new MySQLDatabase('mysql://localhost:3306/blog');
container.register('Database', db);
container.register('Logger', new ConsoleLogger());
container.register('PostRepository', new PostRepository(db));
// 依存関係の取得と利用
const logger = container.resolve<ILogger>('Logger');
const postRepo = container.resolve<IPostRepository>('PostRepository');
const postService = container.createInstance(PostService, postRepo, logger);
// 使用
postService.getAllPosts().then(posts => {
// 投稿を処理
});
依存性注入を効果的に活用するには、特にTypeScriptでは抽象インターフェースを定義し、具体的な実装はそれに準拠させることがベストプラクティスです。これにより、コードの再利用性と保守性が向上します。
依存性注入フレームワークの比較と選択基準
依存性注入を効率的に実装するために、様々なフレームワークが開発されています。ここでは主要なDIフレームワークを比較し、プロジェクトに適したものを選ぶための基準を紹介します。
JavaScript/TypeScript向けDIフレームワーク
1. InversifyJS
InversifyJSは、TypeScript向けの軽量DIコンテナです。
特徴:
- TypeScriptに最適化された設計
- デコレータを活用した簡潔な構文
- インターフェースと実装の結合を容易に管理
// InversifyJSの使用例
import { Container, injectable, inject } from "inversify";
import "reflect-metadata";
// シンボルの定義
const TYPES = {
Database: Symbol.for("Database"),
UserRepository: Symbol.for("UserRepository"),
UserService: Symbol.for("UserService")
};
// インターフェース
interface Database {
connect(): Promise<void>;
query(sql: string): Promise<any[]>;
}
interface UserRepository {
findAll(): Promise<User[]>;
}
// 実装クラス
@injectable()
class MySQLDatabase implements Database {
async connect(): Promise<void> {
// 接続処理
}
async query(sql: string): Promise<any[]> {
// クエリ実行
return [];
}
}
@injectable()
class UserRepositoryImpl implements UserRepository {
constructor(@inject(TYPES.Database) private db: Database) {}
async findAll(): Promise<User[]> {
await this.db.connect();
return this.db.query("SELECT * FROM users");
}
}
@injectable()
class UserService {
constructor(@inject(TYPES.UserRepository) private repo: UserRepository) {}
async getUsers() {
return this.repo.findAll();
}
}
// DIコンテナのセットアップ
const container = new Container();
container.bind<Database>(TYPES.Database).to(MySQLDatabase);
container.bind<UserRepository>(TYPES.UserRepository).to(UserRepositoryImpl);
container.bind<UserService>(TYPES.UserService).to(UserService);
// 解決
const userService = container.get<UserService>(TYPES.UserService);
2. NestJS
NestJSは、Angular風の構造を持つNode.jsフレームワークで、強力なDI機能を備えています。
特徴:
- フルスタックフレームワークとしての機能
- モジュール単位での依存関係管理
- デコレータを使った直感的なAPI
// NestJSの依存性注入の例
import { Injectable, Module } from '@nestjs/common';
@Injectable()
class LoggerService {
log(message: string) {
console.log(`[LOG]: ${message}`);
}
}
@Injectable()
class UserService {
constructor(private logger: LoggerService) {}
getUsers() {
this.logger.log('Getting users');
return ['User1', 'User2'];
}
}
@Module({
providers: [LoggerService, UserService],
exports: [UserService],
})
class UserModule {}
3. TSyringe
TSyringeはMicrosoftが開発した軽量のDIコンテナです。
特徴:
- シンプルで簡単に使える
- デコレータベースのAPI
- プロジェクトサイズが小さい
// TSyringeの使用例
import { injectable, inject, container } from "tsyringe";
@injectable()
class Logger {
log(message: string) {
console.log(`[${new Date().toISOString()}] ${message}`);
}
}
@injectable()
class UserRepository {
getUsers() {
return ['User1', 'User2'];
}
}
@injectable()
class UserService {
constructor(
private repository: UserRepository,
private logger: Logger
) {}
getUsers() {
this.logger.log('Fetching users');
return this.repository.getUsers();
}
}
// 依存関係の解決
const userService = container.resolve(UserService);
フレームワーク選択の基準
プロジェクトに適したDIフレームワークを選ぶには、以下の基準を考慮すると良いでしょう:
プロジェクトの規模と複雑性
- 小規模プロジェクト → 自作のDIコンテナやTSyringe
- 中〜大規模プロジェクト → InversifyJSやNestJS
既存のフレームワークとの統合
- Angular → 内蔵のDIシステム
- NestJS → 内蔵のDIシステム
- React/Vue → InversifyJSやTSyringeが適切
開発チームの経験と学習曲線
- DIの経験が少ないチーム → シンプルなTSyringe
- より高度な機能を必要とするチーム → InversifyJSやNestJS
パフォーマンス要件
- メモリ使用量の制約がある場合 → 軽量なTSyringe
- 複雑な依存グラフを持つ場合 → スコープ管理が優れたInversifyJS
型の安全性と開発体験
- 強い型付けを求める場合 → TypeScriptに最適化されたInversifyJS
- 開発の容易さを重視する場合 → 簡潔な構文のTSyringe
フレームワークなしで自前のDI実装を使うことも有効な選択肢です。特に小規模プロジェクトや、依存関係が複雑でない場合は、シンプルな自前の実装で十分かもしれません。
最終的には、具体的なユースケースとチームの好みに基づいて選択することが重要です。どのフレームワークも一長一短があるため、プロジェクトの要件に最も適したものを選びましょう。
DIの落とし穴と対策:複雑性の管理と実装のベストプラクティス
依存性注入は強力な設計パターンですが、適切に使用しないと複雑性が増してしまう可能性があります。ここでは、DIを実装する際の落とし穴と、それらを回避するためのベストプラクティスを紹介します。
依存性注入の主な落とし穴
1. コンストラクタの肥大化
多数の依存関係を持つクラスでは、コンストラクタの引数が増えすぎて管理が難しくなることがあります。
// 肥大化したコンストラクタの例
class UserController {
constructor(
private userService: UserService,
private authService: AuthService,
private loggerService: LoggerService,
private emailService: EmailService,
private notificationService: NotificationService,
private analyticsService: AnalyticsService,
private cacheService: CacheService,
private configService: ConfigService
// さらに追加される可能性がある...
) {}
// メソッド実装...
}
2. 循環依存の発生
AクラスがBクラスに依存し、BクラスがAクラスに依存するという循環依存が発生することがあります。
// 循環依存の例
class ServiceA {
constructor(private serviceB: ServiceB) {}
doSomething() {
this.serviceB.methodFromB();
}
}
class ServiceB {
constructor(private serviceA: ServiceA) {} // 循環依存!
methodFromB() {
this.serviceA.doSomething(); // 無限ループの可能性
}
}
3. サービスロケーターへの依存
DIコンテナを直接コードから参照すると、サービスロケーターパターンになってしまい、結合度が高まります。
// サービスロケーターへの依存の例(アンチパターン)
class UserService {
private loggerService;
constructor(private container: DIContainer) {
// 必要になったらコンテナから取得
this.loggerService = container.resolve('LoggerService');
}
}
4. モックのメンテナンスコスト
依存オブジェクトが複雑な場合、モックの作成と維持が困難になることがあります。
// 複雑なモックの例
const complexMock = {
methodA: jest.fn(() => ({ data: { nested: { value: 42 } } })),
methodB: jest.fn().mockImplementation((arg) => {
if (arg.type === 'special') {
return Promise.resolve({ special: true });
}
return Promise.resolve({ regular: true });
}),
// 多数のメソッドとプロパティ...
};
ベストプラクティスと対策
1. 責任の分離を徹底する
単一責任の原則(SRP)に従って、クラスの責任を明確に分離します。これにより、各クラスの依存関係が減少します。
// 責任分離の例
// 修正前: 1つのサービスが認証とユーザー管理の両方を担当
class UserAuthService {
// 認証とユーザー管理の両方のメソッド...
}
// 修正後: 責任を分離
class AuthService {
// 認証のみのメソッド
}
class UserService {
// ユーザー管理のみのメソッド
}
2. ファサードパターンを活用する
複数の依存をまとめるファサードクラスを作成することで、コンストラクタの肥大化を防ぎます。
// ファサードパターンの例
class NotificationFacade {
constructor(
private emailService: EmailService,
private smsService: SMSService,
private pushService: PushNotificationService
) {}
sendNotification(user, message) {
// 各種通知サービスを適切に使用
}
}
// 使用側のクラス
class UserController {
constructor(
private userService: UserService,
private notificationFacade: NotificationFacade // 複数のサービスをまとめて注入
) {}
// メソッド実装...
}
3. ファクトリパターンを使用する
特に条件付きで依存関係を作成する必要がある場合、ファクトリパターンが役立ちます。
// ファクトリパターンの例
interface DatabaseFactory {
createDatabase(): Database;
}
class MySQLDatabaseFactory implements DatabaseFactory {
createDatabase() {
return new MySQLDatabase();
}
}
class MongoDBDatabaseFactory implements DatabaseFactory {
createDatabase() {
return new MongoDatabase();
}
}
// 使用例
class UserRepository {
private db: Database;
constructor(private dbFactory: DatabaseFactory) {
this.db = dbFactory.createDatabase();
}
}
4. 循環依存を解決する方法
循環依存を解決するには、以下のアプローチがあります:
- イベントベースの通信: 直接の依存をイベントエミッターに置き換える
- インターフェースの抽出: 共通のインターフェースを抽出し、両方のクラスがそれに依存するようにする
- リファクタリング: クラスの責任を見直し、適切に分割する
// イベントベースのアプローチ
class EventBus {
private listeners = new Map();
subscribe(event, callback) {
if (!this.listeners.has(event)) {
this.listeners.set(event, []);
}
this.listeners.get(event).push(callback);
}
publish(event, data) {
const eventListeners = this.listeners.get(event) || [];
eventListeners.forEach(callback => callback(data));
}
}
class ServiceA {
constructor(private eventBus: EventBus) {
this.eventBus.subscribe('B_EVENT', this.handleBEvent.bind(this));
}
doSomething() {
// 処理...
this.eventBus.publish('A_EVENT', { data: 'from A' });
}
handleBEvent(data) {
// B からのイベントを処理
}
}
class ServiceB {
constructor(private eventBus: EventBus) {
this.eventBus.subscribe('A_EVENT', this.handleAEvent.bind(this));
}
handleAEvent(data) {
// A からのイベントを処理
this.eventBus.publish('B_EVENT', { data: 'from B' });
}
}
5. テストをしやすくする
単体テストを容易にするためのベストプラクティス:
- インターフェースを使用: 具体的な実装ではなくインターフェースに依存する
- シンプルなモック: 複雑すぎないモックを作成する
- テスト用のファクトリ: テスト用のモックファクトリを作成する
// テストしやすい設計の例
// テスト用のモックファクトリ
class MockFactory {
static createLoggerMock() {
return {
log: jest.fn(),
error: jest.fn()
};
}
static createRepositoryMock() {
return {
findAll: jest.fn().mockResolvedValue([]),
findById: jest.fn().mockResolvedValue(null),
save: jest.fn().mockResolvedValue({ id: 'new-id' })
};
}
}
// テストコード
test('should fetch and log users', async () => {
// モックの作成
const loggerMock = MockFactory.createLoggerMock();
const repoMock = MockFactory.createRepositoryMock();
// テスト用データの設定
repoMock.findAll.mockResolvedValue([{ id: '1', name: 'Test User' }]);
// テスト対象のインスタンス作成
const service = new UserService(repoMock, loggerMock);
// メソッド実行
const result = await service.getAllUsers();
// 検証
expect(repoMock.findAll).toHaveBeenCalled();
expect(loggerMock.log).toHaveBeenCalledWith('Getting all users');
expect(result).toHaveLength(1);
expect(result[0].name).toBe('Test User');
});
実装における一般的なベストプラクティス
- 必要最小限の依存関係: クラスが本当に必要とする依存関係のみを注入する
- インターフェースへの依存: 具体的な実装ではなく抽象に依存する
- コンストラクタ注入を優先: 特別な理由がない限り、コンストラクタ注入を使用する
- 自動ワイヤリングの活用: DIフレームワークの自動ワイヤリング機能を利用する
- 可読性の確保: DIの実装が複雑になりすぎないよう注意する
- コードの自己文書化: 依存関係の目的を明確にするために、適切な変数名やコメントを使用する
依存性注入は、適切に実装すればコードの品質を大幅に向上させることができますが、過剰な複雑性を避けるためには、シンプルさと明確さを常に意識することが重要です。小さく始めて、必要に応じて徐々に洗練させていくアプローチが効果的です。