# JUnit5の拡張機能とアノテーションの使い方完全ガイド

## 目次
1. はじめに
2. JUnit5とは？
3. JUnit5の拡張モデル
4. 主な拡張機能
   1. `@ExtendWith`
   2. `TestTemplate`とリピータ
   3. 条件付き実行のための拡張
   4. `Lifecycle`コールバックの拡張
5. JUnit5の基本アノテーション
   1. `@Test`
   2. `@BeforeEach` / `@AfterEach`
   3. `@BeforeAll` / `@AfterAll`
   4. `@Tag`
   5. `@Disabled`
6. JUnit5の特殊なアノテーション
   1. `@Nested`
   2. `@ParameterizedTest`
   3. `@CsvSource`や`@ValueSource`
   4. `@DisplayName`
   5. `@TestInstance`
7. 拡張機能の実装例
8. まとめ

## 1. はじめに
JUnit5は、Javaでのユニットテストを行うための最新のフレームワークです。従来のJUnit4から大きく進化し、柔軟性や強力な機能を提供しています。この記事では、JUnit5の拡張機能とアノテーションの使い方に焦点を当て、具体例とともに紹介します。

## 2. JUnit5とは？
JUnit5は、JUnitプラットフォーム、JUnit Jupiter、およびJUnit Vintageから構成されるトリプルパッケージです。JUnit5では、モジュール設計が導入され、柔軟な拡張性と最新のJavaバージョンの特長を活かせるように設計されています。

## 3. JUnit5の拡張モデル
JUnit5では、拡張モデルとして、`Extension` APIを使用しています。`Extension`は、テストのライフサイクルの様々な段階で介入できる仕組みを提供し、テスト実行の制御やカスタマイズを可能にします。

## 4. 主な拡張機能

### 4.1 `@ExtendWith`
`@ExtendWith`アノテーションを使用すると、特定のエクステンションをテストクラスに適用できます。このアノテーションをクラスやメソッドに付加することで、エクステンションを指定します。

```java
@ExtendWith(MyExtension.class)
public class MyTestClass {
    ...
}
```

### 4.2 `TestTemplate`とリピータ
`TestTemplate`アノテーションは、テストテンプレートメソッドのスケルトンを提供し、異なるデータや条件での実行を可能にします。これに関連するエクステンションで、繰り返し実行する処理を制御できます。

### 4.3 条件付き実行のための拡張
拡張機能により、特定の条件下でのテスト実行を制御できます。たとえば、`@EnabledOnOs`や`@DisabledOnJre`を使って、特定のOSやJREバージョンでテストを実行可能です。

### 4.4 `Lifecycle`コールバックの拡張
`Lifecycle`コールバックを使用すると、テストメソッドの前後でカスタム操作をスケジュールできます。テスト前準備や後片付けに利用されます。

## 5. JUnit5の基本アノテーション

### 5.1 `@Test`
`@Test`アノテーションは、JUnitテストメソッドを示すために使用され、例外がスローされない限り、すべてのテストが成功とみなされます。

### 5.2 `@BeforeEach` / `@AfterEach`
これらのアノテーションは、それぞれのテストメソッドの前後に実行されるセットアップやクリーンアップコードを記述するために使われます。

### 5.3 `@BeforeAll` / `@AfterAll`
クラス全体に対して一度だけ実行される前後のメソッドを定義するために使用されます。これらのメソッドはstaticでなければなりません。

### 5.4 `@Tag`
テストの分類やフィルタリングのために使用されます。`@Tag`は、ビルドシステムやIDEのフィルタリング機能と組み合わせて利用します。

### 5.5 `@Disabled`
一時的にテストを無効にするために使用します。無効にされたテストは実行されず、スキップされます。

## 6. JUnit5の特殊なアノテーション

### 6.1 `@Nested`
`@Nested`アノテーションを使用すると、内部クラスを介してテストケースを論理的にグループ化できます。これにより、より明確なテスト構造を維持できます。

### 6.2 `@ParameterizedTest`
パラメータ化されたテストを定義するために使用し、同一のテストケースを異なるデータで複数回実行できます。

### 6.3 `@CsvSource`や`@ValueSource`
これらは、`@ParameterizedTest`と組み合わせて使用され、異なるパラメータソースを設定するのに役立ちます。

### 6.4 `@DisplayName`
テストやテストクラスに表示名を付けることができ、テスト結果の鮮明な表示やレポートの向上が可能です。

### 6.5 `@TestInstance`
テストインスタンスのライフサイクルを指定し、`PER_CLASS`などの設定でテストクラスのインスタンス化を制御します。

## 7. 拡張機能の実装例

以下に、独自のJUnit拡張機能を実装する例を示します。たとえば、すべてのテスト前にログを出力する拡張機能を作成できます。

```java
public class LoggingExtension implements BeforeEachCallback {

    @Override
    public void beforeEach(ExtensionContext context) {
        System.out.println("About to execute test: " + context.getDisplayName());
    }
}
```

この拡張を使うには、テストクラスに`@ExtendWith`を付与します。

```java
@ExtendWith(LoggingExtension.class)
public class MyTest {
    @Test
    public void exampleTest() {
        assertTrue(true);
    }
}
```

## 8. まとめ

JUnit5は強力で柔軟なテストフレームワークであり、多様なアノテーションと拡張機能が組み合わさることで、テストの構造と管理が大幅に向上しました。特に拡張機能を活用することで、テストコードの再利用性と保守性が向上します。これにより、プロジェクト全般の品質を高めることができます。 [cv:issue_marketplace_engineer]

JUnit5の拡張機能とアノテーションの使い方完全ガイド

目次

続きを読むには単価診断を受けてください（30秒）