Spring Boot テストパターン

概要

JUnit 5、Mockito、Testcontainers、およびパフォーマンス最適化されたスライステストパターンを使用して、Spring Boot アプリケーション向けの堅牢なテストスイートを作成するための包括的なガイダンス。

使用時機

• サービスまたはリポジトリのユニットテストをモック化された依存関係で記述する場合
• Testcontainers を使用した実際のデータベースによる統合テストを実装する場合
• @WebMvcTest または MockMvc での REST API テスト
• Spring Boot 3.5+ でのコンテナ管理用 @ServiceConnection を設定する場合

クイックリファレンス

テスト種別	アノテーション	目標時間	ユースケース
ユニットテスト	@ExtendWith(MockitoExtension.class)	< 50ms	Spring コンテキストなしのビジネスロジック
リポジトリテスト	@DataJpaTest	< 100ms	最小限のコンテキストでのデータベース操作
コントローラテスト	@WebMvcTest / @WebFluxTest	< 100ms	REST API レイヤーテスト
統合テスト	@SpringBootTest	< 500ms	コンテナを使用した完全なアプリケーションコンテキスト
Testcontainers	@ServiceConnection / @Testcontainers	可変	実際のデータベース/メッセージブローカーコンテナ

コアコンセプト

テストアーキテクチャの哲学

1. ユニットテスト — Spring コンテキストなしの高速で分離されたテスト (< 50ms)
2. スライステスト — 特定のレイヤー向けの最小限の Spring コンテキスト (< 100ms)
3. 統合テスト — 実際の依存関係を持つ完全な Spring コンテキスト (< 500ms)

主要なアノテーション

Spring Boot テスト:

• @SpringBootTest — 完全なアプリケーションコンテキスト (控えめに使用)
• @DataJpaTest — JPA コンポーネントのみ (リポジトリ、エンティティ)
• @WebMvcTest — MVC レイヤーのみ (コントローラ、@ControllerAdvice)
• @WebFluxTest — WebFlux レイヤーのみ (リアクティブコントローラ)
• @JsonTest — JSON シリアライゼーションコンポーネントのみ

Testcontainers:

• @ServiceConnection — Testcontainer を Spring Boot に接続 (3.5+)
• @DynamicPropertySource — 実行時に動的プロパティを登録
• @Testcontainers — Testcontainers ライフサイクル管理を有効化

説明

1. ユニットテストパターン

モック化された依存関係を使用してビジネスロジックをテストします:

@ExtendWith(MockitoExtension.class)
class UserServiceTest {
    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    void shouldFindUserByIdWhenExists() {
        when(userRepository.findById(1L)).thenReturn(Optional.of(user));
        Optional<User> result = userService.findById(1L);
        assertThat(result).isPresent();
        verify(userRepository).findById(1L);
    }
}

詳細なパターンについては unit-testing.md を参照してください。

2. スライステストパターン

特定のレイヤー向けの焦点化されたテストスライスを使用:

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@TestContainerConfig
class UserRepositoryIntegrationTest {
    @Autowired
    private UserRepository userRepository;

    @Test
    void shouldSaveAndRetrieveUser() {
        User saved = userRepository.save(user);
        assertThat(userRepository.findByEmail("test@example.com")).isPresent();
    }
}

すべてのスライスパターンについては slice-testing.md を参照してください。

3. REST API テストパターン

MockMvc でコントローラをテスト:

@WebMvcTest(UserController.class)
class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    @Test
    void shouldGetUserById() throws Exception {
        mockMvc.perform(get("/api/users/1"))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.email").value("test@example.com"));
    }
}

4. @ServiceConnection を使用した Testcontainers

Spring Boot 3.5+ でコンテナを設定:

@TestConfiguration
public class TestContainerConfig {
    @Bean
    @ServiceConnection
    public PostgreSQLContainer<?> postgresContainer() {
        return new PostgreSQLContainer<>("postgres:16-alpine");
    }
}

テストクラスで @Import(TestContainerConfig.class) を適用してください。 詳細な設定については testcontainers-setup.md を参照してください。

5. 依存関係を追加

必要なテスト用依存関係を含めます:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>1.19.0</version>
    <scope>test</scope>
</dependency>

完全な依存関係リストについては test-dependencies.md を参照してください。

6. CI/CD を設定

自動テスト用 GitHub Actions を設定:

name: Tests
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    services:
      docker:
        image: docker:20-dind
    steps:
    - uses: actions/checkout@v4
    - name: Set up JDK 17
      uses: actions/setup-java@v4
      with:
        distribution: 'temurin'
    - name: Run tests
      run: ./mvnw test

完全な CI/CD パターンについては ci-cd-configuration.md を参照してください。

検証チェックポイント

テストを実装した後、以下を確認してください:

• コンテナが実行中: docker ps (testcontainer イメージを探す)
• コンテキスト読み込み: スタートアップログで「Started Application in X.XX seconds」を確認
• テスト分離: テストを個別に実行して交差汚染がないことを確認

例

@ServiceConnection を使用した完全な統合テスト

@SpringBootTest
@Import(TestContainerConfig.class)
class OrderServiceIntegrationTest {

    @Autowired
    private OrderService orderService;

    @Autowired
    private UserRepository userRepository;

    @Test
    void shouldCreateOrderForExistingUser() {
        User user = userRepository.save(User.builder()
            .email("order-test@example.com")
            .build());

        Order order = orderService.createOrder(user.getId(), List.of(
            new OrderItem("SKU-001", 2)
        ));

        assertThat(order.getId()).isNotNull();
        assertThat(order.getStatus()).isEqualTo(OrderStatus.PENDING);
    }
}

実際のデータベースを使用した @DataJpaTest

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@TestContainerConfig
class UserRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    void shouldFindByEmail() {
        userRepository.save(User.builder()
            .email("jpa-test@example.com")
            .build());
        assertThat(userRepository.findByEmail("jpa-test@example.com"))
            .isPresent();
    }
}

完全なエンドツーエンド例については workflow-patterns.md を参照してください。

ベストプラクティス

• 適切なテスト種別を使用する: リポジトリには @DataJpaTest、コントローラには @WebMvcTest、完全な統合にのみ @SpringBootTest
• Spring Boot 3.5+ で @ServiceConnection を優先: @DynamicPropertySource よりクリーンなコンテナ管理
• テストを確定的に保つ: @BeforeEach ですべてのテストデータを明示的に初期化
• レイヤー別に整理: レイヤー別にテストをグループ化してコンテキストキャッシュを最大化
• Testcontainers を JVM レベルで再利用: withReuse(true) + TESTCONTAINERS_REUSE_ENABLE=true
• @DirtiesContext を回避: コンテキストの再構築を強制し、パフォーマンスを大きく低下させる
• 外部サービスはモック化: 実際のデータベースは必要な場合のみ使用
• パフォーマンス目標: ユニット < 50ms、スライス < 100ms、統合 < 500ms

制約と警告

• 絶対必要でない限り @DirtiesContext を使用しないでください (コンテキスト再構築を強制)
• @MockBean を異なる設定と混在させないでください (別のコンテキストが生成される)
• Testcontainers には Docker が必要です; CI/CD パイプラインが Docker をサポートしていることを確認してください
• テスト実行順序に依存しないでください; 各テストは独立している必要があります
• @TestPropertySource に注意してください (別のコンテキストが生成される)
• ユニットテストに @SpringBootTest を使用しないでください; 代わりにプレーンな Mockito を使用してください
• コンテキストキャッシュは異なる @MockBean 設定で無効化される可能性があります
• テスト内で静的可変状態を避けてください (テスト失敗の原因となる)

リファレンス

• test-dependencies.md — Maven/Gradle テスト依存関係
• unit-testing.md — Mockito パターンを使用したユニットテスト
• slice-testing.md — リポジトリ、コントローラ、JSON スライステスト
• testcontainers-setup.md — Testcontainers 設定パターン
• ci-cd-configuration.md — GitHub Actions、GitLab CI、Docker Compose
• api-reference.md — 完全なテストアノテーションとユーティリティ
• best-practices.md — テストパターンと最適化
• workflow-patterns.md — 完全な統合テスト例