【PHP】僕がInterfaceを使う理由

2024-07-27 2024-07-27 4分44秒

コテツ

PHPでの開発を進める中で、Interfaceを使うことが多くなりました。

Interfaceは、コードの可読性や保守性を向上させる強力なツールです。

この記事では、僕がInterfaceを使う理由とその利点について、具体例を交えながら説明します。

Contents

コードの一貫性を保つ
依存関係の注入を容易にする
テストの容易化
拡張性の向上
まとめ

コードの一貫性を保つ

Interfaceを使うことで、プロジェクト全体で一貫したメソッドシグネチャを保つことができます。例えば、複数のクラスが同じ操作を実行する場合、それぞれのクラスに同じメソッドを実装させることが可能です。これにより、コードを読む際にメソッドの名前や引数の形式に迷うことがなくなります。

interface LoggerInterface {
  public function log(string $message): void;
}

class FileLogger implements LoggerInterface {
  public function log(string $message): void {
    // ファイルにログを記録する処理
  }
}

class DatabaseLogger implements LoggerInterface {
  public function log(string $message): void {
    // データベースにログを記録する処理
  }
}

依存関係の注入を容易にする

Interfaceを使うことで、依存関係の注入が容易になります。

特定のクラスに依存するのではなく、Interfaceに依存することで、将来的にクラスを変更する場合でも、コード全体に大きな影響を与えずに済みます。

class UserController {
  private $logger;

  public function __construct(LoggerInterface $logger) {
    $this->logger = $logger;
  }

  public function createUser(string $name): void {
    // ユーザー作成の処理
    $this->logger->log("User created: $name");
  }
}

テストの容易化

Interfaceを使用することで、テストが容易になります。
モックオブジェクトやスタブを使って、依存関係を簡単に置き換えることができるため、ユニットテストの実行が簡単になります。

モックができないとUTが書きづらい場面が多々出てくるので、そのためだけに Interface を使っていると言っても過言ではないです。

class MockLogger implements LoggerInterface {
  public function log(string $message): void {
    // テスト用のモック処理
  }
}

$logger = new MockLogger();
$controller = new UserController($logger);
$controller->createUser('John Doe');
// ここでログが正しく動作するかをテスト

拡張性の向上

Interfaceを使うことで、新しい機能の追加が容易になります。

例えば、新しいタイプのLoggerを追加する場合、既存のコードを変更することなく、新しいクラスを追加するだけで済みます。

class EmailLogger implements LoggerInterface {
  public function log(string $message): void {
    // メールにログを送信する処理
  }
}

まとめ

Interfaceを使うことで、コードの一貫性、依存関係の管理、テストの容易化、拡張性の向上といった多くの利点があります。PHPでの開発において、Interfaceを効果的に活用することで、より健全で保守性の高いコードを実現することができます。ぜひ、皆さんもInterfaceの利点を活用してみてください。

この記事を書いた人