Mockito を使用したサービスレイヤーのユニットテスト

概要

Mockito を使用して @Service クラスのユニットテストを実施するパターンを提供します。リポジトリ呼び出しをモック化し、メソッド呼び出しを検証し、例外シナリオをテストし、外部 API レスポンスをスタブ化します。Spring コンテナやデータベースなしで、高速かつ独立したテストを実現します。

使用時機

• @Service クラスのビジネスロジックをテストする場合
• リポジトリと外部クライアント依存関係をモック化する場合
• モック化されたコラボレータとのサービス相互作用を検証する場合
• サービスのエラーハンドリングとエッジケースをテストする場合
• 高速で独立したユニットテストを記述する場合（データベースなし、API 呼び出しなし）

手順

以下のワークフローに従って、Mockito を使用してサービスレイヤーをテストし、検証ポイントを含めます：

1. テストクラスのセットアップ

@ExtendWith(MockitoExtension.class) を使用して Mockito アノテーションを有効にします。

2. @Mock と @InjectMocks でモックを宣言

依存関係（リポジトリ、クライアント）には @Mock を、テスト対象のサービスには @InjectMocks を使用します。

3. 検証チェックポイント付きの Arrange-Act-Assert

Arrange: テストデータを作成し、when().thenReturn() を使用してモックの戻り値を設定します。

Act: テスト対象のサービスメソッドを実行します。

Assert:

• AssertJ アサーションで戻り値を検証します
• verify() でモック相互作用を検証します
• 検証チェックポイント: テストを実行して緑色のバーを確認します

4. 例外シナリオをテスト

when().thenThrow() を使用して、例外をスロー するようモックを設定します。

検証チェックポイント: 例外の型とメッセージを検証します

5. 完全なカバレッジを検証

• 完全なテストスイートを実行: mvn test または gradle test
• カバレッジレポートを確認: mvn test jacoco:report
• 検証チェックポイント: すべてのサービスメソッドに対応するテストがあることを確認します

例

基本的なサービステストパターン

@ExtendWith(MockitoExtension.class)
class UserServiceTest {

  @Mock
  private UserRepository userRepository;

  @InjectMocks
  private UserService userService;

  @Test
  void shouldReturnUserWhenFound() {
    // Arrange
    User expected = new User(1L, "Alice");
    when(userRepository.findById(1L)).thenReturn(Optional.of(expected));

    // Act
    User result = userService.getUser(1L);

    // Assert
    assertThat(result.getName()).isEqualTo("Alice");
    verify(userRepository).findById(1L);
  }

  @Test
  void shouldThrowWhenUserNotFound() {
    // Arrange
    when(userRepository.findById(999L)).thenReturn(Optional.empty());

    // Act & Assert
    assertThatThrownBy(() -> userService.getUser(999L))
      .isInstanceOf(UserNotFoundException.class);
  }
}

メソッド呼び出しの検証

@Test
void shouldSendEmailOnUserCreation() {
  User newUser = new User(1L, "Alice", "alice@example.com");
  when(userRepository.save(any(User.class))).thenReturn(newUser);

  enrichmentService.registerNewUser("Alice", "alice@example.com");

  verify(userRepository).save(any(User.class));
  verify(emailService).sendWelcomeEmail("alice@example.com");
}

複数の依存関係、argument captor、非同期サービス、InOrder 検証などの追加パターンについては、references/examples.md を参照してください。

ベストプラクティス

• @ExtendWith(MockitoExtension.class) を JUnit 5 統合に使用します
• テスト対象サービスの直接的な依存関係のみをモック化します
• 相互作用を検証して 正しいコラボレーションを確保します
• テストメソッドあたり 1 つの動作をテストして 、テストをフォーカスさせます
• 記述的な変数名を使用します: expectedUser、actualUser、captor
• 値オブジェクトと DTO に対しては実インスタンスを作成します （モック化しません）

制約と警告

• 値オブジェクトまたは DTO をモック化しないでください。テストデータを使用して実インスタンスを作成します。
• 依存関係が多すぎる場合はモック化を控えてください。サービスに多くのコラボレータがある場合はリファクタリングを検討してください。
• テストは独立している必要があります。実行順序に依存しないようにします。
• @Spy には注意してください。部分的なモック化は理解と保守が難しくなります。
• プライベートメソッドを直接テストしないでください。パブリックメソッドの動作を通じてテストします。
• Argument マッチャー（any()、eq()）と実際の値は同じスタブで混在させることはできません。
• 過度な検証を避けてください。テストシナリオに重要な相互作用のみを検証します。

参照

• Mockito Documentation
• JUnit 5 User Guide
• AssertJ Assertions