@WebMvcTestでBeanが見つからない。@Mockと@MockitoBean

設計・テスト・レビュー

Spring Bootの@WebMvcTestでBeanが見つからない|@Mockと@MockitoBeanの違い

アプリを起動すれば会議室の空き状況が返るのに、@WebMvcTest を付けたテストだけ、RoomAvailabilityService が見つからず止まりました。テストに @Mock を足しても、MockMvc でGETを送るところに届きません。

このとき確認するのは、Controllerを作るSpringのテストコンテナに、必要な型がBeanとして入っているかです。同じ GET /rooms/R-100 を使い、@Mock だけの失敗、@MockitoBean で置き換えたMVCテスト、実Serviceを使うアプリ全体のテストを順に比べます。

記事と同じコードを取得する

Java 17とMaven 3.9系を用意します。ZIPを展開し、pom.xml のある spring-webmvctest-mock-mockitobean フォルダーで実行します。

  • mvn test でMVCテスト2件と実Serviceのテスト1件。
  • mvn -Dtest=MockFieldOnlyReproduction test で起動失敗を再現。このコマンドは失敗終了します。

同じGETを送る前に、Controllerの生成で止まる

このControllerはコンストラクタで RoomAvailabilityService を受け取り、会議室IDと利用可否をJSONで返します。GETを投げる前に、SpringがこのControllerを組み立てられることが前提です。

package info.syachiku.roomslice;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RoomAvailabilityController {
    private final RoomAvailabilityService service;

    public RoomAvailabilityController(RoomAvailabilityService service) {
        this.service = service;
    }

    @GetMapping("/rooms/{roomId}")
    public Availability availability(@PathVariable("roomId") String roomId) {
        return new Availability(roomId, service.isAvailable(roomId));
    }

    public record Availability(String roomId, boolean available) {}
}

配布サンプルの失敗再現では、Mockitoの openMocks でテストのフィールドを先に初期化します。mockingDetails(service).isMock() が真だと確認した時点で、REPRO_FIELD_MOCK_CREATED を出力します。その後、Springのコンテナ生成が失敗します。リクエスト直前に置いた REPRO_MOCKMVC_REQUEST_REACHED は出力されません。

REPRO_FIELD_MOCK_CREATED
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'info.syachiku.roomslice.RoomAvailabilityService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

上のログでは、まず NoSuchBeanDefinitionException の要求型を読みます。要求は RoomAvailabilityService。続いて UnsatisfiedDependencyException の roomAvailabilityController とコンストラクタの引数を見れば、どのクラスを作れなかったかが分かります。この段階ではURLの誤りやHTTPステータスを調べても、失敗箇所には届きません。

MockFieldOnlyReproduction.java の全文
package info.syachiku.roomslice;

import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mockingDetails;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

// Opt in with mvn -Dtest=MockFieldOnlyReproduction test; it is expected to fail.
@WebMvcTest(RoomAvailabilityController.class)
class MockFieldOnlyReproduction {
    @Mock RoomAvailabilityService service;
    @Autowired MockMvc mockMvc;

    MockFieldOnlyReproduction() throws Exception {
        // Create the field mock before Spring injects the test instance.
        try (AutoCloseable mocks = MockitoAnnotations.openMocks(this)) {
            assertThat(mockingDetails(service).isMock()).isTrue();
            System.out.println("REPRO_FIELD_MOCK_CREATED");
        }
    }

    @Test
    void requestIsNeverReachedWhenTheControllerDependencyIsMissing() throws Exception {
        System.out.println("REPRO_MOCKMVC_REQUEST_REACHED");
        mockMvc.perform(get("/rooms/R-100"))
                .andExpect(status().isOk());
    }
}

MockitoのフィールドとSpringのBeanは、登録先が違う

@WebMvcTest(RoomAvailabilityController.class) は、指定したControllerとMVC用の構成を起動します。今回の通常の @Service は読み込み範囲の外です。@Mock をMockitoで初期化するとテストクラスのフィールドにモックが入ります。Springがコンストラクタを解決するときは、そのフィールドでなくテストコンテナ内のBeanを探します。

同じ型のモックでも、Springが探す場所にあるかが違う

@Mock
テストのフィールドに生成

MVCのテストコンテナ

Controller → Beanが見つからない

@MockitoBean
テストコンテナへ登録

MVCのテストコンテナ

Controller → ServiceのモックBean

@MockitoBean を使うと、テストコンテナのBeanをMockitoのモックで置き換えられます。候補が存在しない今回のスライスでは、対象型のモックBeanが作られます。Springを使わないService単体テストで自分がコンストラクタを呼ぶ場合は、Mockitoの @Mock を引数に渡せば依存を置き換えられます。誰がControllerやServiceを作るかで、使う道具を決めます。

MockitoBeanでServiceを渡し、同じGETのJSONを確認する

RoomAvailabilityWebMvcTest は、コンテナから取得した RoomAvailabilityService とテストフィールドが同じインスタンスか照合します。その上で isAvailable("R-100") を true にし、GETで 200、roomId="R-100"、available=true を検証します。2件目は同じGETでモックの戻り値だけを false にし、JSONも変わるかを確認します。

package info.syachiku.roomslice;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.context.ApplicationContext;
import org.springframework.http.MediaType;
import org.springframework.test.context.bean.override.mockito.MockitoBean;
import org.springframework.test.web.servlet.MockMvc;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(RoomAvailabilityController.class)
class RoomAvailabilityWebMvcTest {
    @Autowired MockMvc mockMvc;
    @Autowired ApplicationContext context;
    @MockitoBean RoomAvailabilityService service;

    @Test
    void suppliesTheMockAsTheControllerDependency() throws Exception {
        assertThat(context.getBean(RoomAvailabilityService.class)).isSameAs(service);
        when(service.isAvailable("R-100")).thenReturn(true);

        mockMvc.perform(get("/rooms/R-100"))
                .andExpect(status().isOk())
                .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
                .andExpect(jsonPath("$.roomId").value("R-100"))
                .andExpect(jsonPath("$.available").value(true));

        verify(service).isAvailable("R-100");
    }

    @Test
    void reportsTheMockResultForTheSameRoom() throws Exception {
        when(service.isAvailable("R-100")).thenReturn(false);

        mockMvc.perform(get("/rooms/R-100"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.roomId").value("R-100"))
                .andExpect(jsonPath("$.available").value(false));

        verify(service).isAvailable("R-100");
    }
}

このテストで保証するのは、URLから会議室IDを読み取り、指定のServiceへ渡し、返された真偽値をJSONへ反映する流れです。空き状況をどのデータで決めるかは、Serviceのテストで確かめます。HTTP 200だけにすると、Serviceを呼ばず常に true を返す変更を見逃すため、false のケースと呼び出し確認も入れています。

アプリ全体の組み立てを見たいときは実Serviceで起動する

RoomAvailabilityBootTest は、@SpringBootTest と @AutoConfigureMockMvc を使います。同じGETを実Serviceへ通して、R-100 が利用可能になるサンプルの動作を確認します。ここで取得したServiceがMockitoのモックでないことも検証しています。実際のDB、認証、ネットワークを通る試験はこの例には含めていません。

RoomAvailabilityBootTest.java の全文
package info.syachiku.roomslice;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mockingDetails;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class RoomAvailabilityBootTest {
    @Autowired MockMvc mockMvc;
    @Autowired RoomAvailabilityService service;

    @Test
    void theFullContextFindsTheRealService() throws Exception {
        assertThat(mockingDetails(service).isMock()).isFalse();

        mockMvc.perform(get("/rooms/R-100"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.roomId").value("R-100"))
                .andExpect(jsonPath("$.available").value(true));
    }
}

現場で「Controllerテストに @SpringBootTest を足せば通りました」と言われたら、変更前に狙っていた検証範囲を聞きます。「予約可否のJSON契約を早く確かめたい」ならMVCテストでServiceを用意。「起動構成から実Serviceが選ばれることも確かめたい」ならアプリ全体で起動。この例は両方の目的に対応するテストを別に置きます。

配布サンプルはSpring Boot 3.5.16とJava 17で確認しました。実案件では依存バージョンを見て、MVCテストとBean置き換えに対応するimportを選んでください。Spring Boot 3.5のMVCテストと、Spring FrameworkのMockitoBeanに設定範囲がまとまっています。

RoomAvailabilityService.java の全文
package info.syachiku.roomslice;

import org.springframework.stereotype.Service;

@Service
public class RoomAvailabilityService {
    public boolean isAvailable(String roomId) {
        return "R-100".equals(roomId);
    }
}
RoomAvailabilityApplication.java の全文
package info.syachiku.roomslice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class RoomAvailabilityApplication {
    public static void main(String[] args) {
        SpringApplication.run(RoomAvailabilityApplication.class, args);
    }
}
pom.xml の全文
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.5.16</version>
        <relativePath/>
    </parent>
    <groupId>info.syachiku</groupId>
    <artifactId>room-availability-slice</artifactId>
    <version>1.0.0</version>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

提出前に、失敗した時点とテストの目的を説明する

  • テストはHTTPを送る前に失敗したか。例外に出る要求型を見たか。
  • Springが作るControllerの依存を、テストコンテナに登録したか。
  • HTTP 200、JSONの値、Serviceへ渡した会議室IDを確認したか。
  • 実Serviceまで検証したい場合に、別の起動構成と期待値を用意したか。

Beanの登録とDIから理解を固めたいときは、『Spring徹底入門 第2版』が参考になります。本文で使うテスト用アノテーションの設定は、配布コードと上記の公式資料で確認できます。

書籍「Spring徹底入門 第2版」の表紙
商品画像:Amazon.co.jp
PR 入門後の参考書|Spring Framework 5向け

Spring徹底入門 第2版

株式会社NTTデータ (著), 株式会社NTTデータグループ (編集)

アプリを作った後に、DIやDB更新の仕組みを調べる。

DI、MVC、データアクセス、テスト、セキュリティまで幅広く確認できます。小さなWebアプリを一通り作り、Springの仕組みを詳しく学びたい人に向く参考書です。

  • Springで小さなWebアプリを作ったことがある
  • DIやトランザクションの仕組みを確認したい

Spring Framework 5向けです。Boot 3の実装に使うコード・設定は、採用している版の公式資料と照合してください。

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

関連記事Spring Bootの「No qualifying bean of type」原因|DIできないときの対処法 アプリの起動でも同じエラーが出るときに、型の実装、Bean登録、コンポーネントスキャンを順番に確認できます。 記事を読む 関連記事Spring BootのServiceをJUnit・Mockitoでテストする方法|Repositoryをモックする基本 Serviceそのものをテストする場合に、RepositoryをMockitoのmockに置き換えて、戻り値と保存処理を検証できます。 記事を読む

Springが作るControllerには、テスト側でBeanを渡す

@WebMvcTest でServiceが見つからないときは、要求された型とMVCの読み込み範囲を確かめます。ControllerのHTTP入出力を試す場合は @MockitoBean でServiceを用意し、実Serviceを使う構成を検証する場合はアプリ全体を起動します。

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