HttpClient Spring 7: náhrada Feign

Deklarativní HttpClient ve Spring 7: alternativa k FeignClient

Spring 7 přináší nativní deklarativní HttpClient postavený na RestClientu a WebClientu. Využívá známé anotace @GetExchange, @PostExchange, podobné @GetMapping v kontrolerech. To umožňuje popisovat odchozí HTTP požadavky přes rozhraní bez ruční implementace.

Klíčové rozhraní vypadá takto:

public interface UserClient {

    @GetExchange("/api/users/{id}")
    UserResponse getUser(
        @PathVariable("id") Long id,
        @RequestParam(name = "includeDetails", defaultValue = "false") boolean includeDetails,
        @RequestHeader("Authorization") String authToken,
        @RequestHeader("X-Request-Id") String requestId
    );

    @PostExchange("/api/users")
    UserResponse createUser(
        @RequestBody @Valid CreateUserRequest request,
        @RequestHeader("Authorization") String authToken
    );

    @PatchExchange("/api/users/{id}")
    void updateUserEmail(
        @PathVariable("id") Long id,
        @RequestParam("email") String email,
        @RequestHeader("Authorization") String authToken
    );
}

HttpClient se integruje s observabilitou přímo z krabice a nevyžaduje Spring Cloud, na rozdíl od FeignClientu, který je od roku 2022 v maintenance módu.

Integrace s OpenAPI Generator

Pro automatizaci generování klientů se používá openapi-generator s knihovnou spring-http-interface.

Konfigurace Maven pluginu:

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>${openapi-generator.version}</version>
    <executions>
       <execution>
    <id>generate-weather-client</id>
    <goals>
       <goal>generate</goal>
    </goals>
    <configuration>
       <inputSpec>${project.basedir}/src/main/resources/openapi/external/weather-api.yaml</inputSpec>
       <generatorName>spring</generatorName>
       <library>spring-http-interface</library>
       <output>${project.build.directory}/generated-sources/openapi-client</output>
       <apiPackage>ulllie.exchange.openapi.gen.client.api</apiPackage>
       <modelPackage>ulllie.exchange.openapi.gen.client.model</modelPackage>
       <generateApis>true</generateApis>
       <generateModels>true</generateModels>
       <generateSupportingFiles>false</generateSupportingFiles>
       <configOptions>
          <useSpringBoot4>true</useSpringBoot4>
          <useJackson3>true</useJackson3>
          <interfaceOnly>true</interfaceOnly>
          <skipDefaultInterface>true</skipDefaultInterface>
          <useBeanValidation>true</useBeanValidation>
          <annotationLibrary>none</annotationLibrary>
          <serializationLibrary>jackson</serializationLibrary>
          <useTags>true</useTags>
       </configOptions>
    </configuration>
</execution>
    </executions>
</plugin>

Generuje se rozhraní:

public interface OpenMeteoApi { 
  @HttpExchange(method = "GET", value = "/v1/forecast")   
  ResponseEntity<ForecastResponse> getForecast( 
    @RequestParam("latitude") Double latitude, 
    @RequestParam("longitude") Double longitude 
  );
}

Připojení a konfigurace služeb

Konfigurace přes import:

@Configuration  @ImportHttpServices(group = "weather", types = OpenMeteoApi.class)  
public class WeatherRestClientConfig implements RestClientHttpServiceGroupConfigurer {    
  @Override      
  public void configureGroups(Groups<RestClient.Builder> groups) { 
    groups.filterByName("weather").forEachClient(
      ($, builder) -> builder.baseUrl("https://api.weather.com") 
    );    
  }  
}

Zpracování chyb se nastavuje přes defaultStatusHandler:

builder.baseUrl(properties.baseUrl())
  .defaultStatusHandler(
  status -> status.is4xxClientError() || status.is5xxServerError(),               
  errorHandler         
);

Implementace HttpErrorHandler umožňuje přizpůsobit logiku pro 4xx/5xx stavy, integrovat s Resilience4j nebo @ControllerAdvice.

Možnosti:

• Nastavení interceptorů
• Integrace s Resilience4j
• Zpracování chyb na úrovni ResponseSpec

RestClient vs WebClient s Project Loom

S virtual threads (spring.threads.virtual.enabled=true) blokující RestClient zajišťuje škálovatelnost I/O bez reaktivního stylu.

Výhody:

• Imperativní kód, snadno debugovatelný
• Žádné reaktivní pipeline
• Srovnatelný výkon s WebClientem pro I/O-bound úlohy

Pro reaktivní scénáře se generují Mono/Flux signatury při výběru WebClient.Builder.

Problémy validace a řešení

Bean Validation neprojde do hloubky vnořených objektů, protože generátor nepřidává @Valid.

Varianty řešení:

• x-field-extra-annotation v OpenAPI: @jakarta.validation.Valid — vyžaduje změnu specifikace.
• AlwaysTraversableResolver — globálně prochází strom, rizika cyklů a výkonu.
• Vlastní mustache šablony — automatické přidání @Valid při generování.

Dále: generování Kotlin data classů pro null-safety.

data class ForecastResponse(
  val temperature: Double,
  val windSpeed: Double?
)

Závislosti: kotlin-stdlib + jackson-module-kotlin. Fail-fast při deserializaci při porušení nullability.

Co je důležité

• HttpClient — nativní Spring Framework, bez závislostí na Spring Cloud.
• OpenAPI generator s spring-http-interface generuje připravená rozhraní.
• Virtual threads zjednodušují I/O bez reaktivity.
• Kotlin data classy zajišťují brzkou kontrolu null.
• Nastavení chyb a validace je plně přizpůsobitelné.

— Editorial Team