Spring BootのServiceをJUnitとMockitoでテストする方法を解説する記事のアイキャッチ。Java道場風の空間で若手エンジニアがRepositoryのモックを学ぶイラスト。

設計・テスト・レビュー

Spring BootのServiceをJUnit・Mockitoでテストする方法|Repositoryをモックする基本

この記事でわかること

Serviceの単体テストではSpring Boot全体を起動せず、JUnit 5とMockitoでRepositoryをモックします。mock()で依存先を作り、コンストラクタでServiceへ渡します。注文取消で状態と保存呼び出しを確認し、注文登録ではArgumentCaptorで保存に渡した顧客IDと数量まで確かめます。成功ケース、対象なし、業務ルール違反を分けてテストし、DB制約やトランザクションは結合テストへ任せます。

新人SE
新人SE
Serviceをテストするなら、毎回@SpringBootTestを付けてDBまで起動する必要がありますか?
ポンコツSE
ポンコツSE
業務ロジックの単体テストなら、Serviceを普通のJavaクラスとして生成し、RepositoryをMockitoで置き換えれば十分なことが多いです。

Spring BootのServiceは、Repositoryからデータを取得し、条件を判定し、更新結果を保存する役割を持つことが多くあります。若手が初めてテストを書くと、Springを起動すること自体が目的になり、準備が大きくて遅いテストになりがちです。

DIで依存先をコンストラクタから受け取るServiceは、Springコンテナがなくても普通のJavaクラスとしてテストできます。この記事では注文取消Serviceを例に、Repositoryをモックした単体テストの基本を説明します。配布する実行用ZIPでは、取消の4件と注文登録の保存引数を確認する例を試せます。

注文取消で保存が0回か調べるなら、Mockitoのnever()でnullの呼び出しまで確かめる例を試せます。

spyで戻り値を設定する行なのに実メソッドが動いて例外が出たら、MockitoのwhenとdoReturnの比較から確認できます。

この記事のポイント

  • Serviceの単体テストではSpringコンテナを起動しない
  • Repositoryの応答をMockitoのwhenで準備する
  • 成功、対象なし、業務ルール違反を別テストにする
  • 戻り値だけでなく、必要な保存処理が呼ばれたかを確認する

テスト対象のServiceを確認する

注文IDから注文を取得し、取消可能なら状態を変更するServiceを考えます。

package info.syachiku.learning.cancel;

public class OrderService {
    private final OrderRepository orderRepository;
    public OrderService(OrderRepository orderRepository) { this.orderRepository = orderRepository; }

    public void cancel(long orderId) {
        Order order = orderRepository.findById(orderId)
                .orElseThrow(() -> new OrderNotFoundException(orderId));
        order.cancel();
        orderRepository.save(order);
    }
}

Order#cancelは、すでに発送済みならOrderCannotBeCanceledExceptionを投げ、取消可能ならステータスをCANCELEDへ変更する想定です。取消用のクラスはinfo.syachiku.learning.cancelにあります。配布サンプルではfindByIdとsaveを持つRepositoryインターフェースをMockitoで置き換えます。

package info.syachiku.learning.cancel;

import java.util.Optional;

/** 教材で必要な契約だけを定義。実際の JPA 保存動作は検証しない。 */
public interface OrderRepository {
    Optional<Order> findById(long orderId);
    Order save(Order order);
}

JUnit 5とMockitoの基本構成

private final OrderRepository repository = mock(OrderRepository.class);
private final OrderService service = new OrderService(repository);
  • mock(OrderRepository.class)でRepositoryのモックを作る。
  • new OrderService(repository)で、本物のServiceにモックを渡す。

@SpringBootTestを付けていないため、Spring Boot全体やDBは起動しません。テスト対象と依存関係が小さく、失敗原因を追いやすい構成です。

コンストラクタで明示的に生成してもよい

配布版はmockito-coreを使い、コンストラクタへ渡す依存をテストの2行で示しています。MockitoExtensionで@Mockを初期化する方式を使うチームでは、mockito-junit-jupiterをテスト依存に加えます。この配布版のまま動かすときは、上のmock()とnewの2行を使います。

依存先が増え、テストの準備が長くなった場合は、Serviceが受け持つ処理を確認します。取消の条件と無関係な依存が必要なら、取消Serviceからその処理を分けられるか検討します。

成功ケースをテストする

Repositoryが注文を返すように準備し、取消後の状態と保存呼び出しを確認します。

@Test
void waitingOrderIsCanceledAndSaved() {
    Order order = Order.waitingForShipment(100L);
    when(repository.findById(100L)).thenReturn(Optional.of(order));
    service.cancel(100L);
    assertEquals(Order.Status.CANCELED, order.getStatus());
    verify(repository).save(order);
}

when(...).thenReturn(...)は、モックの振る舞いを準備します。verifyは、期待した依存先メソッドが呼ばれたかを確認します。

なお、JPAで取得した管理対象Entityは、トランザクション内で状態を変えるとダーティチェックにより更新されるため、明示的なsaveが不要な設計もあります。ここではRepository呼び出しのテスト例としてsaveするServiceを扱っています。実案件では既存Serviceとチーム方針に合わせ、不要なsaveをテストのためだけに追加しないでください。

Arrange、Act、Assertの順に、準備・実行・確認を分けるとテストを読みやすくできます。

対象が見つからないケースをテストする

@Test
void missingOrderIsRejectedWithoutSaving() {
    when(repository.findById(999L)).thenReturn(Optional.empty());
    var error = assertThrows(OrderNotFoundException.class, () -> service.cancel(999L));
    assertEquals(999L, error.getOrderId());
    verify(repository, never()).save(nullable(Order.class));
}

例外型だけでなく、調査やエラーレスポンスに使う注文IDも確認しています。また、対象がないのにsaveされていないことをnever()で確認します。

save(null)まで検出して「保存は0回」を確かめる

注文ID999が見つからない場合は、例外と注文IDに加えて、保存を1回も呼ばないことを確認します。Mockitoのnever()が数えるのは、指定した引数の条件に合う呼び出しです。

実習ではOrderService.javaのorElseThrowの中へ一時的にorderRepository.save(null);を1行追加し、その直後に従来どおりOrderNotFoundExceptionを作りました。同じテストを、Mockito 5.17.0で比べた結果です。

  • never().save(any(Order.class))ではテストが通る。 型を指定するany(Order.class)はnullを検証対象に含めないため、誤った1回を見逃します。
  • never().save(nullable(Order.class))ではテストが落ちる。 nullable(Order.class)はOrderとnullの両方を対象にするので、NeverWantedButInvokedで誤った呼び出しを指摘します。

掲載コードと配布ZIPには、一時的なsave(null)を取り除いた実装と、nullableで検証するテストを収録しています。配布サンプルのREADMEから、失敗する条件を再現できます。

Mockito 5.17.0の引数マッチャー仕様

業務ルール違反をテストする

発送済み注文は取り消せない、という業務ルールも独立したテストにします。

@Test
void shippedOrderIsRejectedWithoutStateChangeOrSaving() {
    Order order = Order.shipped(200L);
    when(repository.findById(200L)).thenReturn(Optional.of(order));
    assertThrows(OrderCannotBeCanceledException.class, () -> service.cancel(200L));
    assertEquals(Order.Status.SHIPPED, order.getStatus());
    verify(repository, never()).save(nullable(Order.class));
}

正常系だけでは、「条件判定を削除してもテストが通る」状態になりかねません。業務上重要な分岐は、成功と失敗の両方をテストします。

配布版には、取消済みの注文を再度取り消せないケースもあります。4件をまとめて試すにはmvn -Dtest=CancelOrderServiceTest testを実行します。

CancelOrderServiceTest.java の全文を表示する
package info.syachiku.learning.cancel;

import java.util.Optional;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

class CancelOrderServiceTest {
    private final OrderRepository repository = mock(OrderRepository.class);
    private final OrderService service = new OrderService(repository);

    @Test
    void waitingOrderIsCanceledAndSaved() {
        Order order = Order.waitingForShipment(100L);
        when(repository.findById(100L)).thenReturn(Optional.of(order));
        service.cancel(100L);
        assertEquals(Order.Status.CANCELED, order.getStatus());
        verify(repository).save(order);
    }

    @Test
    void missingOrderIsRejectedWithoutSaving() {
        when(repository.findById(999L)).thenReturn(Optional.empty());
        var error = assertThrows(OrderNotFoundException.class, () -> service.cancel(999L));
        assertEquals(999L, error.getOrderId());
        verify(repository, never()).save(nullable(Order.class));
    }

    @Test
    void shippedOrderIsRejectedWithoutStateChangeOrSaving() {
        Order order = Order.shipped(200L);
        when(repository.findById(200L)).thenReturn(Optional.of(order));
        assertThrows(OrderCannotBeCanceledException.class, () -> service.cancel(200L));
        assertEquals(Order.Status.SHIPPED, order.getStatus());
        verify(repository, never()).save(nullable(Order.class));
    }

    @Test
    void alreadyCanceledOrderIsRejectedWithoutSavingAgain() {
        Order order = Order.waitingForShipment(300L);
        order.cancel();
        when(repository.findById(300L)).thenReturn(Optional.of(order));
        assertThrows(OrderCannotBeCanceledException.class, () -> service.cancel(300L));
        assertEquals(Order.Status.CANCELED, order.getStatus());
        verify(repository, never()).save(nullable(Order.class));
    }
}

ArgumentCaptorで保存内容を確認する

顧客10の注文で数量2を入力したのに、保存引数が数量1なら不具合です。 ここでは登録用のinfo.syachiku.learning.OrderServiceでcreate(10L, 2)を呼びます。save(any(OrderDraft.class))は、null以外のOrderDraftなら内容にかかわらずID 501を返す設定なので、戻り値だけの検証では数量の誤りを見逃します。

Serviceはsaveに渡すOrderDraftを内部で作ります。verify(orders).save(captor.capture())で実際の引数を取り出し、customerId()が10、quantity()が2であることを確認します。

package info.syachiku.learning;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;

class OrderServiceCaptorTest {
    @Test
    void capturesCustomerIdAndQuantityPassedToSave() {
        CustomerDirectory customers = mock(CustomerDirectory.class);
        OrderRepository orders = mock(OrderRepository.class);
        OrderService service = new OrderService(customers, orders);
        when(customers.require(10L)).thenReturn(new Customer(10L, true));
        when(orders.save(any(OrderDraft.class))).thenReturn(501L);

        long orderId = service.create(10L, 2);

        ArgumentCaptor<OrderDraft> captor = ArgumentCaptor.forClass(OrderDraft.class);
        verify(orders).save(captor.capture());
        OrderDraft saved = captor.getValue();
        assertEquals(10L, saved.customerId());
        assertEquals(2, saved.quantity());
        assertEquals(501L, orderId);
        System.out.printf("CAPTOR customerId=%d quantity=%d returnedOrderId=%d%n",
                saved.customerId(), saved.quantity(), orderId);
    }
}

ZIPを展開した場所でmvn -Dtest=OrderServiceCaptorTest testを実行すると、顧客ID 10・数量2・戻り値501を確認できます。テストが数量の設定ミスを検出するか試すには、作業用コピーの登録用OrderService.javaでnew OrderDraft(customer.id(), quantity)の第2引数だけを1に変えます。数量の期待値2で失敗し、元に戻すと成功します。

verifyを使いすぎない

取消例では、状態の更新結果をorder.getStatus()で確認し、外部へ出る保存をverify(repository).save(order)で確認します。getterの回数まで固定すると、同じ仕様を満たすリファクタリングでテストが壊れやすくなります。

privateメソッドをモックしないとテストできない場合は、その処理が別クラスの責務ではないかを考えます。テスト都合だけでprivateをpublicへ変えるのも避けます。

モックするもの・しないもの

対象単体テストでの扱い理由
RepositoryモックするDBアクセスを切り離す
外部API Clientモックする通信と相手環境を切り離す
時刻取得Clockなどを注入するテスト結果を固定する
Entity・値オブジェクト実物を使う業務ルールを含むテスト対象だから
Form・DTO実物を使う単純な入力データだから

何でもモックにすると、実際の業務ロジックが動かず、Mockitoの設定だけを確認するテストになります。遅い、外部状態に依存する、今回のテスト対象ではない境界をモックします。

単体テストで確認できないこと

Mockitoを使った単体テストでは、Repositoryをモックしているため、次の動作は確認できません。

  • JPAのマッピングやSQLが正しいか
  • DBのNOT NULL、UNIQUE、外部キー制約が動くか
  • @Transactionalで実際にロールバックされるか
  • SpringのBean設定やAOPが正しいか
  • ControllerからJSONやFormが正しく渡るか

これらはRepositoryテストやSpringを起動する結合テストで確認します。単体テストと結合テストは優劣ではなく、見つけられる不具合が違います。

@SpringBootTestとの使い分け

観点JUnit + Mockito@SpringBootTest
主な目的Serviceの分岐・計算・依存呼び出しBean連携や実設定を含む動作
Spring起動しないする
速度速い比較的遅い
DB確認できない構成次第でできる
失敗原因絞りやすい複数層にまたがることがある

Serviceの条件分岐ごとに@SpringBootTestを使うのではなく、多数の単体テストで業務ロジックを確認し、主要な連携経路を少数の結合テストで確認すると役割が明確になります。

読みやすいテスト名と構造

テスト名は、メソッド名だけでなく条件と期待結果が分かる形にします。日本語名を許可するかはプロジェクト規約へ揃えます。

配布版のmissingOrderIsRejectedWithoutSavingという名前には、入力条件(注文なし)と守る結果(保存しない)が入っています。Optional.empty()を準備し、呼び出し時の例外とsaveが0回であることを確かめます。

1つのテストに成功、失敗、通知、DB保存をすべて詰め込まず、原則として1つの条件を確認します。失敗したときに、どの仕様が壊れたか分かる粒度を目指します。

よくあるMockitoのつまずき

  • whenへ指定したIDと、Serviceが実際に渡すIDが違う
  • 対象なしのstubを省略し、テストの前提がコードから読み取れない
  • any()を使いすぎて、誤った引数でもテストが通る
  • モック対象をnewしてしまい、Mockitoのモックと別インスタンスになる
  • 不要なstubが大量にあり、テスト条件が読み取れない
  • staticやprivateを無理にモックし、設計上の依存が隠れる

エラーが出たらアノテーションを増やすのではなく、テスト対象Serviceがどのインスタンスを持ち、どの引数でモックを呼んでいるかをデバッガーで確認します。

Mockitoのspyで実メソッドが動くときは、whenとdoReturnを比べる

この記事のRepositoryは、外部の依存を置き換えるmockです。実オブジェクトの一部を置き換えるspyでは、whenに渡す呼出しを評価する際に実メソッドが動く場合があります。設定時にその実行を避ける必要がある場合は、doReturnを使う書き方を検討します。mockかspyかを確認せず、すべてのwhenを置き換える必要はありません。

spyが必要になった場合は、まず置き換えたいのがRepository、通信先などの外部依存なのか、テスト対象そのものの内部処理なのかを確かめてください。通信の失敗を試したい場合の依存の分け方は、通信の失敗をテストするために置き換える場所を変える例で説明しています。mockとspyの設定時の違いは、Mockito公式ドキュメントのSpying on real objectsでも確認できます。

動かせるサンプルで、mockとspyの違いを確かめる

顧客ID 10 を登録していない CustomerDirectory を使います。when(directory.require(10L)).thenReturn(new Customer(10L, true)) は when の引数を評価する時点で実検索を行うため、thenReturn に到達する前に IllegalArgumentException が出ます。この時点で lookupCalls() は1です。

doReturn(new Customer(10L, true)).when(directory).require(10L) なら、設定直後も、設定した require(10L) の呼び出し後も、実検索は0回です。登録済みの顧客で when が成功した場合も、設定時に実検索は1回走ります。例外の有無と、準備中に検索や通信が走ったかを分けて確かめます。

依存先を普通の mock にできるときは、戻り値の型をコンパイル時に確認できる when(...).thenReturn(...) が基本です。このサンプルでは doReturn に誤って文字列を渡すと、実行時に WrongTypeOfReturnValue が出る例も確認できます。

この記事のサンプルコード

注文取消・保存引数・mock/spyを手元で確かめる

注文取消4ケース、注文登録13ケース(保存引数のCaptorを含む)、mock/spy比較6ケースでServiceのテストを試せます。テスト範囲・ケースの空欄CSVと記入例、レビュー説明例も同梱しています。

  • コード+テスト資料
  • 23ケース検証済み
  • MITライセンス

用意するものJava 17・Maven 3.9系(JUnit Jupiter 5.12.2・Mockito 5.17.0で検証)

解凍後、pom.xmlのあるmockito-order-null-check-1744フォルダーでmvn clean testを実行すると23件を確認できます。Captorだけならmvn -Dtest=OrderServiceCaptorTest test、mock/spy比較はmvn -Dtest=MockitoBehaviorTest testで6件実行します。初回は依存ライブラリの取得にインターネット接続が必要です。

架空の注文システムです。取消済み注文の再取消を拒否するのはサンプル用の仕様です。Spring・DBは起動せず、JPA・DB保存・トランザクションは検証対象外です。

現場レビューでよくある指摘

// レビューコメント例
Serviceの単体テストですが@SpringBootTestで全Beanを起動しています。
RepositoryをMockitoで置き換え、Springなしで確認できないか検討してください。

// レビューコメント例
正常系しかなく、対象なしでもsaveされないことを確認できません。
Optional.empty()と業務ルール違反のケースを追加してください。

// レビューコメント例
any()だけでverifyしているため、別の注文を保存しても通ります。
保存対象の状態または具体的なIDを確認してください。

提出前のセルフチェック

  • ServiceをSpringなしで生成できているか
  • Repositoryや外部Clientだけをモックしているか
  • 成功、対象なし、業務ルール違反を分けているか
  • 重要な保存や通知が正しい引数で呼ばれたか確認したか
  • 失敗時に不要な副作用が起きないことを確認したか
  • DB制約やトランザクションの確認を単体テストへ求めていないか

単体テスト設計を深める参考書

この本が向くのは、JUnitとMockitoでテストを書けるようになり、「何をモックするか」「実装を変えても壊れにくいテストにするには」と迷っている人です。『単体テストの考え方/使い方』はC#のコード例でテスト設計を説明する本で、JUnitのアノテーションやMockitoの書き方を覚えるための入門書ではありません。まずこの記事の成功・対象なし・業務ルール違反の3ケースを動かし、次にテストの判断を深めたい場合に検討してください。

書籍「単体テストの考え方/使い方」の表紙
商品画像:Amazon.co.jp
PR テストを学ぶ若手向け

単体テストの考え方/使い方

Vladimir Khorikov (著), 須田智之 (翻訳)

単体テストで「何を検証するか」の判断基準を学ぶ。

モックの使いどころや壊れにくいテストの考え方を整理できます。コード例はC#です。JUnitの操作入門ではなく、テストの設計と価値を深める本です。

  • テスト対象の切り分けに迷っている
  • 保守しやすい単体テストを書きたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

この記事とあわせて読みたい

関連記事SpringのServiceに業務ロジックを書く理由ControllerやRepositoryと責務を分け、テストしやすいServiceを作る基本を解説します。記事を読む 関連記事Repositoryの戻り値とOptionalの扱い方findByIdの対象なしをServiceでどう扱うか、実装例で確認できます。記事を読む 過去記事privateメソッドをモックしたい?置き換える場所を変える通信の失敗を再現するために、内部処理のモックではなく外部依存を切り離す考え方を確認できます。記事を読む

まとめ

Spring BootのServiceは、JUnit 5とMockitoを使えばSpringコンテナを起動せずに単体テストできます。Repositoryをmock()で置き換え、成功、対象なし、業務ルール違反の条件ごとに、状態と重要な依存呼び出しを確認します。

単体テストではDB制約、JPAマッピング、トランザクションまでは確認できません。それらは結合テストへ任せ、Serviceの単体テストは業務上の判断を速く、具体的に検証する役割へ絞りましょう。

-設計・テスト・レビュー
-,