http-interface-clients

宣言的な HTTP インターフェースクライアント（Boot 3）

Spring Framework 6 は @HttpExchange インターフェースをサポートしていますが、Boot 3 には Boot 4 の @ImportHttpServices によるグループ自動登録機能はありません。クライアントアダプターを明示的に構築してください。

@HttpExchange("/orders")
interface OrderApiClient {
    @GetExchange("/{id}")
    OrderDto get(@PathVariable UUID id);
}

@Configuration
class ClientConfig {
    @Bean
    OrderApiClient orderApiClient(RestClient.Builder builder,
                                  @Value("${clients.orders.base-url}") String baseUrl) {
        RestClient client = builder.baseUrl(baseUrl).build();
        HttpServiceProxyFactory factory =
            HttpServiceProxyFactory.builderFor(RestClientAdapter.create(client)).build();
        return factory.createClient(OrderApiClient.class);
    }
}

Mono または Flux を返すリアクティブインターフェースには、WebClientAdapter を使用してください。ベース URL、 タイムアウト、認証、エラー変換は、コントローラーやドメインサービスではなく、 クライアントアダプターレイヤーで設定してください。外部サービスごとにファクトリー／コンフィギュレーターを 1 つ用意することをおすすめします。

注意点

• エージェントが @ImportHttpServices を使用しています。この Boot 4 の登録 API は Boot 3 では利用できません。
• エージェントがインターフェースに @Component または実装を追加しています。生成されたプロキシを Bean として登録してください。
• エージェントが Mono または Flux に RestClient を使用しています。リアクティブな戻り値の型には WebClientAdapter を使用してください。
• エージェントがアノテーションにリモートホストをハードコードしています。URL は設定に保持してください。
• エージェントがトランスポートエラーをドメインまで漏らしています。クライアントアダプターで変換してください。
• エージェントがリクエストごとに新しいクライアントを作成しています。シングルトンプロキシを設定して再利用してください。