# MockitoのArgumentCaptorで引数を検証する方法

## 目次

1. 1-1. ArgumentCaptorとは？

2. 1-2. 使用するシーンの概要

3. 1-3. ArgumentCaptorの基本的な使用法

4. 1-4. 例：引数の検証

5. 1-5. よくある問題と解決方法

6. 1-6. ArgumentCaptorの高度な使用法

7. 1-7. Mockito ArgumentCaptor vs. Verify

8. 1-8. ArgumentCaptorのベストプラクティス

9. 1-9. まとめ

## 1-1. ArgumentCaptorとは？

ArgumentCaptorは、Mockitoフレームワークの一部であり、モックオブジェクトのメソッドが呼び出された際に渡された引数をキャプチャし、検証するために使用されます。これは、テスト対象のオブジェクトが外部に依存している場合に、渡されたパラメータを確実にテストできる強力なツールです。

## 1-2. 使用するシーンの概要

一例として、メールを送信するメソッドを持つサービスクラスを考えてみましょう。このメソッドは、引数として送信先のメールアドレスとメッセージを受け取ります。この際、実際にメールが送信されるのではなく、指定したメッセージと宛先が正しいかどうかを確認したいという場面があります。このような場面でArgumentCaptorが活躍します。

## 1-3. ArgumentCaptorの基本的な使用法

まず、ArgumentCaptorを使うには、以下の方法でインスタンスを作成します。

```java

ArgumentCaptor<String> argumentCaptor = ArgumentCaptor.forClass(String.class);

```

次に、モックされたオブジェクトのメソッドを呼び出す際に、`verify`メソッドと組み合わせて使用します。

```java

Mockito.verify(mockObject).someMethod(argumentCaptor.capture());

```

このコードは、`someMethod`が呼び出されたときの引数をキャプチャします。

## 1-4. 例：引数の検証

具体的な例として、ユーザーに通知を送信するサービスを考え、ArgumentCaptorを利用してメッセージの内容を検証します。

```java

public class NotificationServiceTest {

    @Mock

    private EmailSender emailSender;

    @InjectMocks

    private NotificationService notificationService;

    @Test

    public void testSendNotification() {

        String email = "test@example.com";

        String message = "Hello, World!";

        notificationService.sendNotification(email, message);

        ArgumentCaptor<String> emailCaptor = ArgumentCaptor.forClass(String.class);

        ArgumentCaptor<String> messageCaptor = ArgumentCaptor.forClass(String.class);

        Mockito.verify(emailSender).sendEmail(emailCaptor.capture(), messageCaptor.capture());

        assertEquals(email, emailCaptor.getValue());

        assertEquals(message, messageCaptor.getValue());

    }

}

```

### グラフ／図示化

ここでは、ArgumentCaptorの動作を視覚的に示しています。

```

[notificationService] --sendNotification--> [emailSender]

                                 ^                          |

                                 |                           \

                                 ---- ArgumentCaptor captures

```

## 1-5. よくある問題と解決方法

- **キャプチャできない引数**: 引数がプリミティブ型の場合、ボクシングを行ってキャプチャします。

- **検証の失敗**: キャプチャした値と期待される値が異なるかを確認し、テストケースの前提を再確認します。

## 1-6. ArgumentCaptorの高度な使用法

ArgumentCaptorは複数の引数が渡された場合や、引数のリストをキャプチャしたい場合にも対応しています。

```java

ArgumentCaptor<List<String>> listCaptor = ArgumentCaptor.forClass(List.class);

Mockito.verify(mockObject).methodWithList(listCaptor.capture());

List<String> capturedList = listCaptor.getValue();

```

## 1-7. Mockito ArgumentCaptor vs. Verify

ArgumentCaptorを使うことで、`verify`メソッドを用いてメソッドが呼び出されたことの確認に加え、引数の詳細なチェックも行えます。`verify`は通常、メソッド呼び出し回数などを確認するのに用いられますが、引数の内容が重要な場合には、ArgumentCaptorを併用します。

## 1-8. ArgumentCaptorのベストプラクティス

- **シンプルで明確なキャプチャ**: 単一のテストケースでのキャプチャする引数はなるべく少なくし、テストの焦点を明確にします。

- **メソッドの粒度を制御**: モックのメソッドについて細かな検証が不要な場合は、大胆にスキップして可読性を優先します。

## 1-9. まとめ

ArgumentCaptorは、Mockitoを用いたテストで効果的に引数を検証できる強力なツールです。特に、複雑な引数を渡すメソッドのテストにおいて、引数の内容が期待どおりであることを確認するために有用です。引数のキャプチャ、引数の検証、そしてテストケース全体の一貫性を保つことにより、テストの信頼性を確保できます。また、他のMockito機能と組み合わせることで、より多様なユースケースに対応することができます。

MockitoのArgumentCaptorで引数を検証する方法

目次

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