テストクラス外で @LocalServerPort を使用して Spring Boot の自動配線の問題を修正する方法

解決策 1: @DynamicPropertySource を使用してポート インジェクションを解決する

このアプローチでは、Spring Boot の @DynamicPropertySource を使用して、テスト中にローカル サーバー ポートを動的に設定します。

@Component
public class BaseControllerWrapper {
    protected int port;
}

@Component
public class SpecificControllerWrapper extends BaseControllerWrapper {
    public void callEndpoint() {
        System.out.println("Calling endpoint on port: " + port);
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @DynamicPropertySource
    static void dynamicProperties(DynamicPropertyRegistry registry) {
        registry.add("server.port", () -> 8080);
    }

    @Test
    public void testSomething() {
        specificControllerWrapper.port = 8080; // Dynamically set
        specificControllerWrapper.callEndpoint();
    }
}

解決策 2: ApplicationContextAware を使用してポート インジェクションを行う

このソリューションは、ApplicationContext を利用して環境プロパティを動的に取得します。

@Component
public class BaseControllerWrapper {
    protected int port;
}

@Component
public class SpecificControllerWrapper extends BaseControllerWrapper {
    public void callEndpoint() {
        System.out.println("Calling endpoint on port: " + port);
    }
}

@Component
public class PortInjector implements ApplicationContextAware {
    @Autowired
    private SpecificControllerWrapper wrapper;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Environment env = applicationContext.getEnvironment();
        wrapper.port = Integer.parseInt(env.getProperty("local.server.port", "8080"));
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @Test
    public void testSomething() {
        specificControllerWrapper.callEndpoint();
    }
}

解決策 3: ポート管理用のカスタム Bean の構成

このメソッドは、ポート挿入と解決を処理するカスタム Bean をセットアップします。

@Configuration
public class PortConfig {
    @Bean
    public BaseControllerWrapper baseControllerWrapper(@Value("${local.server.port}") int port) {
        BaseControllerWrapper wrapper = new BaseControllerWrapper();
        wrapper.port = port;
        return wrapper;
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @Test
    public void testSomething() {
        specificControllerWrapper.callEndpoint();
    }
}

Spring Boot テストの @LocalServerPort に関するよくある質問

1. どのようにして @LocalServerPort 仕事？
2. Spring Boot テスト中に組み込みサーバーに割り当てられたランダムなポートを挿入します。
3. 使ってもいいですか @LocalServerPort テストクラスの外で？
4. 直接ではありませんが、次のようなソリューションを使用できます @DynamicPropertySource または ApplicationContext。
5. とは何ですか @DynamicPropertySource?
6. これは、テスト中にプロパティを動的に登録できる Spring Boot 機能です。
7. Spring がプレースホルダー解決エラーをスローするのはなぜですか?
8. これは、プレースホルダーが原因で発生します ${local.server.port} テストコンテキストの外では解決されません。
9. 共有ラッパーを使用して複数のコントローラーをテストできますか?
10. はい、動的ポート解決方法を使用すると、複数のコントローラーに対して単一のラッパーを効率的に再利用できます。 😊

ポートインジェクションの課題をまとめる

使用する @ローカルサーバーポート Spring Boot テストで効果的にするには、テスト コンテキストの動作を深く理解する必要があります。動的なプロパティ構成や環境ベースのインジェクションなどのソリューションにより、これらの問題の処理が簡素化されます。これにより、テストの安定性を損なうことなく、コントローラー ラッパーなどのコンポーネントを再利用できるようになります。

動的ポート登録などのベスト プラクティスを採用すると、エラーが解決されるだけでなく、テストのモジュール性も強化されます。これらの方法を使用すると、開発者は複雑な REST API テスト用の堅牢で再利用可能なテスト セットアップを作成できます。クリーンでエラーのないセットアップは、信頼性が高く効率的なテスト実行への道を開きます。 😊