Apologies, It's Time to Replace HttpClient!

Source: juejin.cn/post/

Feature Characteristics
Quick Usage
HTTP Request Annotations
Configuration Item Description
Advanced Features
Global Interceptors
Call Adapters and Data Converters
Summary

Using SpringBoot to directly initiate HTTP requests with okhttp, httpClient, or RestTemplate is cumbersome and inconvenient for unified management. Therefore, I recommend a lightweight HTTP client framework suitable for SpringBoot projects: retrofit-spring-boot-starter, which is very simple and convenient to use while providing many functional enhancements. The project has been updated to version 2.2.2 and will continue to be iteratively optimized.

Introduction

Retrofit is a type-safe HTTP client for Android and Java, with its biggest feature being its support for initiating HTTP requests via interfaces. Meanwhile, spring-boot is the most widely used Java development framework, but the official Retrofit does not support quick integration with the spring-boot framework, which is why we developed retrofit-spring-boot-starter.

retrofit-spring-boot-starter implements quick integration of Retrofit with the spring-boot framework and supports many functional enhancements, greatly simplifying development.

Feature Characteristics

Custom Injection of OkHttpClient
Annotation-based Interceptors
Connection Pool Management
Log Printing
Request Retry
Error Decoders
Global Interceptors
Circuit Breaker and Degradation
HTTP Calls Between Microservices
Call Adapters
Data Converters

Quick Usage

Introduce Dependencies

<dependency>
    <groupId>com.github.lianjiatech</groupId>
    <artifactId>retrofit-spring-boot-starter</artifactId>
    <version>2.2.2</version>
</dependency>

Define HTTP Interfaces

Interfaces must be marked with the @RetrofitClient annotation! HTTP-related annotations can refer to the official documentation: Retrofit official documentation.

@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

Inject and Use

Simply inject the interface into other services to use!

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

    public void test() {
        // Initiate HTTP requests through httpApi
    }
}

HTTP Request Annotations

HTTP request-related annotations all use the retrofit native annotations. For detailed information, refer to the official documentation: Retrofit official documentation, below is a simple explanation.

Annotation Category	Supported Annotations
Request Methods	<span>@GET``@HEAD``@POST``@PUT``@DELETE``@OPTIONS</span>
Request Headers	<span>@Header``@HeaderMap``@Headers</span>
Query Parameters	<span>@Query``@QueryMap``@QueryName</span>
Path Parameters	`<span>@Path</span>`
Form-encoded Parameters	<span>@Field``@FieldMap``@FormUrlEncoded</span>
File Upload	<span>@Multipart``@Part``@PartMap</span>
URL Parameters	`<span>@Url</span>`

Configuration Item Description

retrofit-spring-boot-starter supports multiple configurable properties to address different business scenarios. You can modify them as needed, specific descriptions are as follows:

Configuration	Default Value	Description
enable-log	true	Enable log printing
logging-interceptor	DefaultLoggingInterceptor	Log printing interceptor
pool	Connection pool configuration
disable-void-return-type	false	Disable java.lang.Void return type
retry-interceptor	DefaultRetryInterceptor	Request retry interceptor
global-converter-factories	JacksonConverterFactory	Global converter factory
global-call-adapter-factories	BodyCallAdapterFactory,ResponseCallAdapterFactory	Global call adapter factory
enable-degrade	false	Whether to enable circuit breaker degradation
degrade-type	sentinel	Circuit breaker degradation implementation method (currently only supports Sentinel)
resource-name-parser	DefaultResourceNameParser	Circuit breaker resource name parser, used to parse resource names

yml configuration method:

retrofit:
  enable-response-call-adapter: true
# Enable log printing
enable-log: true
# Connection pool configuration
  pool:
    test1:
      max-idle-connections: 3
      keep-alive-second: 100
    test2:
      max-idle-connections: 5
      keep-alive-second: 50
# Disable void return type
disable-void-return-type: false
# Log printing interceptor
  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
# Request retry interceptor
  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor
# Global converter factory
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory
# Global call adapter factory
  global-call-adapter-factories:
    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory
    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory
# Whether to enable circuit breaker degradation
enable-degrade: true
# Circuit breaker degradation implementation method
  degrade-type: sentinel
# Circuit breaker resource name parser
  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

Advanced Features

Custom Injection of OkHttpClient

Generally, dynamically creating the OkHttpClient object through the @RetrofitClient annotation properties can meet most usage scenarios. However, in some cases, users may need to customize the OkHttpClient, at which point, you can define a static method returning type OkHttpClient.Builder on the interface to achieve this. The code example is as follows:

@RetrofitClient(baseUrl = "http://ke.com")
public interface HttpApi3 {

    @OkHttpClientBuilder
    static OkHttpClient.Builder okhttpClientBuilder() {
        return new OkHttpClient.Builder()
                .connectTimeout(1, TimeUnit.SECONDS)
                .readTimeout(1, TimeUnit.SECONDS)
                .writeTimeout(1, TimeUnit.SECONDS);
    }

    @GET
    Result<Person> getPerson(@Url String url, @Query("id") Long id);
}

The method must be marked with the @OkHttpClientBuilder annotation!

Annotation-based Interceptors

Many times, we want certain HTTP requests under a specific interface to execute unified interception logic. To support this functionality, retrofit-spring-boot-starter provides annotation-based interceptors, achieving URL path-based matching interception. The steps to use are mainly divided into 2 steps:

Inherit BasePathMatchInterceptor to write the interceptor handler;
Use @Intercept to annotate the interface. If you need to configure multiple interceptors, just annotate multiple @Intercept annotations on the interface!

Below is an example of appending a timestamp to the end of a specified request URL to illustrate how to use annotation-based interceptors.

Inherit `BasePathMatchInterceptor` to write the interceptor handler

@Component
public class TimeStampInterceptor extends BasePathMatchInterceptor {

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl url = request.url();
        long timestamp = System.currentTimeMillis();
        HttpUrl newUrl = url.newBuilder()
                .addQueryParameter("timestamp", String.valueOf(timestamp))
                .build();
        Request newRequest = request.newBuilder()
                .url(newUrl)
                .build();
        return chain.proceed(newRequest);
    }
}

Use `@Intercept` to annotate the interface

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

The above @Intercept configuration indicates: intercept requests under the HttpApi interface at the /api/** path (excluding /api/test/savePerson), using the TimeStampInterceptor as the interceptor.

Extend Annotation-based Interceptors

Sometimes, we need to dynamically pass some parameters into the intercept annotation, and then use this parameter during the interception. In such cases, we can extend to implement a custom intercept annotation. The custom intercept annotation must be marked with @InterceptMark, and it must include the include(), exclude(), handler() attribute information. The steps to use are mainly divided into 3 steps:

Custom intercept annotation
Inherit BasePathMatchInterceptor to write the interceptor handler
Use the custom intercept annotation on the interface;

For example, if we need to dynamically add accessKeyId and accessKeySecret signature information in the request header to initiate HTTP requests normally, we can define a signing interceptor annotation @Sign to achieve this.

Custom `@Sign` Annotation

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {
    /**
     * Secret key
     * Supports placeholder configuration.
     *
     * @return
     */
    String accessKeyId();

    /**
     * Secret
     * Supports placeholder configuration.
     *
     * @return
     */
    String accessKeySecret();

    /**
     * Interceptor matching path
     *
     * @return
     */
    String[] include() default {"/**"};

    /**
     * Interceptor exclusion matching, exclude specified path interception
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * The interceptor class that handles this annotation
     * It first tries to get the corresponding Bean from the spring container, if not found, it uses reflection to create one!
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

There are two points to note about extending the custom intercept annotation:

Custom intercept annotation must be marked with @InterceptMark.
The annotation must include include(), exclude(), handler() attribute information.

Implement `SignInterceptor`

@Component
public class SignInterceptor extends BasePathMatchInterceptor {

    private String accessKeyId;

    private String accessKeySecret;

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("accessKeyId", accessKeyId)
                .addHeader("accessKeySecret", accessKeySecret)
                .build();
        return chain.proceed(newReq);
    }
}

The above accessKeyId and accessKeySecret field values will be automatically injected based on the @Sign annotation’s accessKeyId() and accessKeySecret() values. If the @Sign specifies a placeholder string, the configuration property value will be used for injection. Additionally, **accessKeyId and accessKeySecret fields must provide setter methods**.

Use on the Interface `@Sign`

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

This way, signature information can be automatically added to requests for the specified URL.

Connection Pool Management

By default, all HTTP requests sent through Retrofit will use the default connection pool of max-idle-connections=5 keep-alive-second=300. Of course, we can also configure multiple custom connection pools in the configuration file and specify which one to use through the @RetrofitClient’s poolName property. For example, if we want all requests under a certain interface to use the poolName=test1 connection pool, the code implementation is as follows:

Configure the connection pool.

   retrofit:
       # Connection pool configuration
       pool:
           test1:
           max-idle-connections: 3
           keep-alive-second: 100
           test2:
           max-idle-connections: 5
           keep-alive-second: 50

Specify the connection pool to use through the @RetrofitClient’s poolName property.

   @RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
   public interface HttpApi {

       @GET("person")
       Result<Person> getPerson(@Query("id") Long id);
   }

Log Printing

In many cases, we want to log HTTP request details. The retrofit.enableLog configuration can globally control whether logging is enabled. For each interface, you can control whether logging is enabled through the @RetrofitClient’s enableLog property, and specify the logging level and strategy for each interface through logLevel and logStrategy. retrofit-spring-boot-starter supports 5 logging levels (ERROR, WARN, INFO, DEBUG, TRACE), defaulting to INFO; it supports 4 logging strategies (NONE, BASIC, HEADERS, BODY), defaulting to BASIC. The meanings of the 4 logging strategies are as follows:

NONE: No logs.
BASIC: Logs request and response lines.
HEADERS: Logs request and response lines and their respective headers.
BODY: Logs request and response lines and their respective headers and bodies (if present).

retrofit-spring-boot-starter uses the DefaultLoggingInterceptor to perform the actual logging functionality, which is based on the native HttpLoggingInterceptor of okhttp. Of course, you can also implement your own logging interceptor by inheriting from BaseLoggingInterceptor (for specific implementation, refer to the DefaultLoggingInterceptor implementation), and configure it in the configuration file.

retrofit:
  # Log printing interceptor
  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor

Request Retry

retrofit-spring-boot-starter supports request retry functionality, simply add the @Retry annotation to the interface or method. **@Retry supports retry count maxRetries, retry interval intervalMs, and retry rules retryRules configuration**. The retry rules support three configurations:

RESPONSE_STATUS_NOT_2XX: Retry when the response status code is not 2xx;
OCCUR_IO_EXCEPTION: Retry when an IO exception occurs;
OCCUR_EXCEPTION: Retry when any exception occurs;

By default, it automatically retries when the response status code is not 2xx or an IO exception occurs. If needed, you can also inherit from BaseRetryInterceptor to implement your own request retry interceptor and configure it.

retrofit:
  # Request retry interceptor
  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

Error Decoders

When an HTTP request error occurs (including exceptions or response data not meeting expectations), the error decoder can decode the HTTP-related information into a custom exception. You can specify the current interface’s error decoder in the @RetrofitClient annotation’s errorDecoder() method; custom error decoders need to implement the <code>ErrorDecoder interface:

/**
 * Error Decoder. ErrorDecoder.
 * When an exception occurs in the request or an invalid response result is received, the HTTP related information is decoded into the exception,
 * and the invalid response is determined by the business itself.
 *
 * @author 陈添明
 */
public interface ErrorDecoder {

    /**
     * When the response is invalid, decode the HTTP information into the exception, invalid response is determined by business.
     *
     * @param request  request
     * @param response response
     * @return If it returns null, the processing is ignored and the processing continues with the original response.
     */
    default RuntimeException invalidRespDecode(Request request, Response response) {
        if (!response.isSuccessful()) {
            throw RetrofitException.errorStatus(request, response);
        }
        return null;
    }

    /**
     * When an IO exception occurs in the request, the HTTP information is decoded into the exception.
     *
     * @param request request
     * @param cause   IOException
     * @return RuntimeException
     */
    default RuntimeException ioExceptionDecode(Request request, IOException cause) {
        return RetrofitException.errorExecuting(request, cause);
    }

    /**
     * When the request has an exception other than the IO exception, the HTTP information is decoded into the exception.
     *
     * @param request request
     * @param cause   Exception
     * @return RuntimeException
     */
    default RuntimeException exceptionDecode(Request request, Exception cause) {
        return RetrofitException.errorUnknown(request, cause);
    }
}

Global Interceptors

Global Application Interceptors

If we need to perform unified interception processing on all HTTP requests in the system, we can customize and implement a global interceptor BaseGlobalInterceptor, and configure it as a bean in the spring container! For example, if we need to ensure that all HTTP requests initiated in the system carry source information.

@Component
public class SourceInterceptor extends BaseGlobalInterceptor {
    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("source", "test")
                .build();
        return chain.proceed(newReq);
    }
}

Global Network Interceptors

Simply implement the NetworkInterceptor interface and configure it as a bean in the spring container to support automatic weaving of global network interceptors.

Circuit Breaker and Degradation

In a distributed service architecture, performing circuit breaker degradation on unstable external services is one of the important measures to ensure high service availability. Since the stability of external services cannot be guaranteed, when external services are unstable, response times will increase. Consequently, the response time for the caller will also increase, threads will pile up, and eventually, it may exhaust the caller’s thread pool, leading to the entire service becoming unavailable. Therefore, we need to perform circuit breaker degradation on unstable weak dependency service calls to temporarily cut off unstable calls, preventing local instability from causing an overall service avalanche.

retrofit-spring-boot-starter supports circuit breaker degradation functionality, based on Sentinel. Specifically, it supports circuit breaker resource self-discovery and annotation-based degradation rule configuration. To use circuit breaker degradation, simply perform the following operations:

1. Enable Circuit Breaker Degradation Functionality

By default, circuit breaker degradation functionality is disabled, and you need to set the corresponding configuration items to enable it:

retrofit:
  # Whether to enable circuit breaker degradation
enable-degrade: true
  # Circuit breaker degradation implementation method (currently only supports Sentinel)
degrade-type: sentinel
  # Resource name parser
  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

The resource name parser is used to implement user-defined resource names, the default configuration is DefaultResourceNameParser, corresponding to the resource name format HTTP_OUT:GET:http://localhost:8080/api/degrade/test. Users can inherit the BaseResourceNameParser class to implement their own resource name parser.

Additionally, since circuit breaker degradation functionality is optional, enabling it requires users to manually introduce the Sentinel dependency:

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-core</artifactId>
    <version>1.6.3</version>
</dependency>

2. Configure Degradation Rules (Optional)

retrofit-spring-boot-starter supports annotation-based configuration of degradation rules through the @Degrade annotation. The @Degrade annotation can be configured on interfaces or methods, with method-level configurations taking precedence.

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Documented
public @interface Degrade {

    /**
     * RT threshold or exception ratio threshold count.
     */
    double count();

    /**
     * Degrade recover timeout (in seconds) when degradation occurs.
     */
    int timeWindow() default 5;

    /**
     * Degrade strategy (0: average RT, 1: exception ratio).
     */
    DegradeStrategy degradeStrategy() default DegradeStrategy.AVERAGE_RT;
}

If the application project supports configuring degradation rules through a configuration center, the annotation-based configuration method can be ignored.

3. Set fallback or fallbackFactory in `@RetrofitClient` (Optional)

If @RetrofitClient does not set fallback or fallbackFactory, when a circuit breaker is triggered, it will directly throw a RetrofitBlockException exception. Users can customize the return value of the method when a circuit breaker is triggered by setting fallback or fallbackFactory. The fallback class must be an implementation of the current interface, and the fallbackFactory must be an implementation of FallbackFactory<T>, with the generic parameter type being the current interface type. Additionally, the fallback and fallbackFactory instances must be configured as Bean in the Spring container.

fallbackFactory differs from fallback mainly in that it can perceive the cause of each circuit breaker (cause). The reference example is as follows:

@Slf4j
@Service
public class HttpDegradeFallback implements HttpDegradeApi {

    @Override
    public Result<Integer> test() {
        Result<Integer> fallback = new Result<>();
        fallback.setCode(100)
                .setMsg("fallback")
                .setBody(1000000);
        return fallback;
    }
}
@Slf4j
@Service
public class HttpDegradeFallbackFactory implements FallbackFactory<HttpDegradeApi> {

    /**
     * Returns an instance of the fallback appropriate for the given cause
     *
     * @param cause fallback cause
     * @return an instance that implements the retrofit interface.
     */
    @Override
    public HttpDegradeApi create(Throwable cause) {
        log.error("Circuit breaker triggered! ", cause.getMessage(), cause);
        return new HttpDegradeApi() {
            @Override
            public Result<Integer> test() {
                Result<Integer> fallback = new Result<>();
                fallback.setCode(100)
                        .setMsg("fallback")
                        .setBody(1000000);
                return fallback;
            }
        };
    }
}

HTTP Calls Between Microservices

To enable microservice calls, the following configurations are required:

Configure `ServiceInstanceChooser` as a `Spring` container `Bean`

Users can implement the ServiceInstanceChooser interface themselves to complete the service instance selection logic and configure it as a Spring container Bean. For Spring Cloud applications, retrofit-spring-boot-starter provides the SpringCloudServiceInstanceChooser implementation, and users only need to configure it as a Spring Bean.

@Bean
@Autowired
public ServiceInstanceChooser serviceInstanceChooser(LoadBalancerClient loadBalancerClient) {
    return new SpringCloudServiceInstanceChooser(loadBalancerClient);
}

Use `@Retrofit`’s `serviceId` and `path` properties to achieve HTTP calls between microservices

@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class)
@Retry
public interface ApiCountService {
}

Call Adapters and Data Converters

Call Adapters

Retrofit can adapt the Call<T> object to the return value type of the interface method through call adapters CallAdapterFactory. retrofit-spring-boot-starter extends two CallAdapterFactory implementations:

   BodyCallAdapterFactory

Enabled by default, can be disabled by configuring retrofit.enable-body-call-adapter=false.
Synchronously executes HTTP requests, adapting the response body content to the return value type instance of the interface method.
Besides Retrofit.Call<T>, Retrofit.Response<T>, and java.util.concurrent.CompletableFuture<T>, other return types can use this adapter.

 ResponseCallAdapterFactory

Enabled by default, can be disabled by configuring retrofit.enable-response-call-adapter=false.
Synchronously executes HTTP requests, adapting the response body content to return Retrofit.Response<T>.
If the method’s return value type is Retrofit.Response<T>, this adapter can be used.

Retrofit automatically selects the corresponding CallAdapterFactory for adaptation based on the method return value type! In addition to the default CallAdapterFactory, it supports various forms of method return value types:

Call<T>: No adaptation processing, directly returns the Call<T> object
CompletableFuture<T>: Adapts the response body content to return a CompletableFuture<T> object
Void: Can use Void if the return type is not a concern. If the HTTP status code is not 2xx, it throws an error directly!
Response<T>: Adapts the response content to return a Response<T> object
Any other Java type: Adapts the response body content to return a corresponding Java type object, if the HTTP status code is not 2xx, it throws an error directly!

    /**
     * Call<T>
     * No adaptation processing, directly returns Call<T> object
     * @param id
     * @return
     */
    @GET("person")
    Call<Result<Person>> getPersonCall(@Query("id") Long id);

    /**
     *  CompletableFuture<T>
     *  Adapts the response body content to return a CompletableFuture<T> object
     * @param id
     * @return
     */
    @GET("person")
    CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);

    /**
     * Void
     * Can use Void if the return type is not a concern. If the HTTP status code is not 2xx, it throws an error directly!
     * @param id
     * @return
     */
    @GET("person")
    Void getPersonVoid(@Query("id") Long id);

    /**
     *  Response<T>
     *  Adapts the response content to return a Response<T> object
     * @param id
     * @return
     */
    @GET("person")
    Response<Result<Person>> getPersonResponse(@Query("id") Long id);

    /**
     * Any other Java type
     * Adapts the response body content to return a corresponding Java type object, if the HTTP status code is not 2xx, it throws an error directly!
     * @param id
     * @return
     */
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

We can also extend our own CallAdapter.Factory by inheriting from it!

retrofit-spring-boot-starter supports configuring global call adapter factories through retrofit.global-call-adapter-factories, the factory instance is prioritized to be obtained from the Spring container, and if not obtained, it is created via reflection. The default global call adapter factories are [BodyCallAdapterFactory, ResponseCallAdapterFactory]!

retrofit:
  # Global call adapter factory
  global-call-adapter-factories:
    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory
    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory

For each Java interface, you can also specify the CallAdapter.Factory used by the current interface through the @RetrofitClient annotation’s callAdapterFactories(), the specified factory instance is still prioritized to be obtained from the Spring container.

Note: If the CallAdapter.Factory does not have a public no-argument constructor, please manually configure it as a Spring container Bean object!

Data Converters

Retrofit uses Converter to convert objects annotated with @Body into request bodies and to convert response body data into a Java object. The following types of Converter can be selected:

Gson: com.squareup.Retrofit:converter-gson
Jackson: com.squareup.Retrofit:converter-jackson
Moshi: com.squareup.Retrofit:converter-moshi
Protobuf: com.squareup.Retrofit:converter-protobuf
Wire: com.squareup.Retrofit:converter-wire
Simple XML: com.squareup.Retrofit:converter-simplexml
JAXB: com.squareup.retrofit2:converter-jaxb

retrofit-spring-boot-starter supports configuring global data converter factories through retrofit.global-converter-factories, the converter factory instance is prioritized to be obtained from the Spring container, and if not obtained, it is created via reflection. The default global data converter factory is retrofit2.converter.jackson.JacksonConverterFactory, and you can directly configure the jackson serialization rules through spring.jackson.*, for configuration reference, see Customize the Jackson ObjectMapper!

retrofit:
  # Global converter factory
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory

For each Java interface, you can also specify the Converter.Factory used by the current interface through the @RetrofitClient annotation’s converterFactories(), the specified converter factory instance is still prioritized to be obtained from the Spring container.

Note: If the Converter.Factory does not have a public no-argument constructor, please manually configure it as a Spring container Bean object!

Summary

retrofit-spring-boot-starter is a lightweight HTTP client framework suitable for SpringBoot projects, which has been stably running online for over a year and has been adopted by multiple external companies.

Apologies, It’s Time to Replace HttpClient!

Introduction

Feature Characteristics

Quick Usage

Introduce Dependencies

Define HTTP Interfaces

Inject and Use

HTTP Request Annotations

Configuration Item Description

Advanced Features

Custom Injection of OkHttpClient

Annotation-based Interceptors

Inherit `<span>BasePathMatchInterceptor</span>` to write the interceptor handler

Use `<span>@Intercept</span>` to annotate the interface

Extend Annotation-based Interceptors

Custom `<span>@Sign</span>` Annotation

Implement `<span>SignInterceptor</span>`

Use on the Interface `<span>@Sign</span>`

Connection Pool Management

Log Printing

Request Retry

Error Decoders

Global Interceptors

Global Application Interceptors

Global Network Interceptors

Circuit Breaker and Degradation

1. Enable Circuit Breaker Degradation Functionality

2. Configure Degradation Rules (Optional)

3. Set fallback or fallbackFactory in `<span>@RetrofitClient</span>` (Optional)

HTTP Calls Between Microservices

Configure `<span>ServiceInstanceChooser</span>` as a `<span>Spring</span>` container `<span>Bean</span>`

Use `<span>@Retrofit</span>`’s `<span>serviceId</span>` and `<span>path</span>` properties to achieve HTTP calls between microservices

Call Adapters and Data Converters

Call Adapters

Data Converters

Summary

Leave a Comment Cancel reply

Introduction

Feature Characteristics

Quick Usage

Introduce Dependencies

Define HTTP Interfaces

Inject and Use

HTTP Request Annotations

Configuration Item Description

Advanced Features

Custom Injection of OkHttpClient

Annotation-based Interceptors

Inherit <span>BasePathMatchInterceptor</span> to write the interceptor handler

Use <span>@Intercept</span> to annotate the interface

Extend Annotation-based Interceptors

Custom <span>@Sign</span> Annotation

Implement <span>SignInterceptor</span>

Use on the Interface <span>@Sign</span>

Connection Pool Management

Log Printing

Request Retry

Error Decoders

Global Interceptors

Global Application Interceptors

Global Network Interceptors

Circuit Breaker and Degradation

1. Enable Circuit Breaker Degradation Functionality

2. Configure Degradation Rules (Optional)

3. Set fallback or fallbackFactory in <span>@RetrofitClient</span> (Optional)

HTTP Calls Between Microservices

Configure <span>ServiceInstanceChooser</span> as a <span>Spring</span> container <span>Bean</span>

Use <span>@Retrofit</span>’s <span>serviceId</span> and <span>path</span> properties to achieve HTTP calls between microservices

Call Adapters and Data Converters

Call Adapters

Data Converters

Summary

Leave a Comment Cancel reply

Inherit `<span>BasePathMatchInterceptor</span>` to write the interceptor handler

Use `<span>@Intercept</span>` to annotate the interface

Custom `<span>@Sign</span>` Annotation

Implement `<span>SignInterceptor</span>`

Use on the Interface `<span>@Sign</span>`

3. Set fallback or fallbackFactory in `<span>@RetrofitClient</span>` (Optional)

Configure `<span>ServiceInstanceChooser</span>` as a `<span>Spring</span>` container `<span>Bean</span>`

Use `<span>@Retrofit</span>`’s `<span>serviceId</span>` and `<span>path</span>` properties to achieve HTTP calls between microservices