Ditch OkHttp and HttpClient: This Lightweight HTTP Client Framework is Incredibly Useful!

Using OkHttp, HttpClient, or RestTemplate to initiate HTTP requests directly in a SpringBoot project 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 enhanced features. The project has currently been updated to version 2.2.2 and will continue to be iterated and optimized.

GitHub project address: github.com/LianjiaTech…

Gitee project address: gitee.com/lianjiatech…

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 achieves quick integration of Retrofit with the spring-boot framework and supports many enhanced features, greatly simplifying development.

Features

Custom injection of OkHttpClient
Annotation-based interceptors
Connection pool management
Logging
Request retries
Error decoders
Global interceptors
Circuit breaker and degradation
HTTP calls between microservices
Call adapters
Data converters

Quick Start

Include Dependency

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

Define HTTP Interface

The interface must be marked with the @RetrofitClient annotation! For HTTP-related annotations, please 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 it!

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

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

HTTP Request Related Annotations

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

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

Configuration Item Description

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

Configuration	Default Value	Description
enable-log	true	Enable logging
logging-interceptor	DefaultLoggingInterceptor	Logging 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	Enable circuit breaker and degradation
degrade-type	sentinel	Circuit breaker implementation method (currently only supports Sentinel)
resource-name-parser	DefaultResourceNameParser	Circuit breaker resource name parser for parsing resource names

YML configuration method:

retrofit:
  enable-response-call-adapter: true
  # Enable logging
  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
  # Logging 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
  # Enable circuit breaker and degradation
  enable-degrade: true
  # Circuit breaker 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

In most cases, dynamically creating the OkHttpClient object through the properties of the @RetrofitClient annotation can meet most usage scenarios. However, in some cases, users may need to customize the OkHttpClient. In this case, you can define a static method that returns a type of 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 it are mainly divided into 2 steps:

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

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

Inherit `BasePathMatchInterceptor` to write the interceptor

@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.

Extend Annotation-based Interceptors

Sometimes, we need to dynamically pass some parameters into the intercept annotation and then use these parameters during 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 properties include(), exclude(), handler() in the annotation. The steps to use it are mainly divided into 3 steps:

Custom intercept annotation
Inherit BasePathMatchInterceptor to write the interceptor
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. Below is an example of the custom @Sign intercept annotation.

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 {"/**"};

    /**
     * Exclude matching for the interceptor, exclude specified paths from interception
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * Interceptor class that handles this annotation
     * Priority is given to obtaining the corresponding Bean from the spring container; if not found, it will be created using reflection!
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

Extending the custom intercept annotation has the following 2 points to note:

Custom intercept annotation must be marked with @InterceptMark.
The annotation must include include(), exclude(), handler() property 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, the 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 will 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 with 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 specific 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);
}

Logging

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 using logLevel and logStrategy. retrofit-spring-boot-starter supports 5 logging levels (ERROR, WARN, INFO, DEBUG, TRACE) with a default of INFO; it supports 4 logging strategies (NONE, BASIC, HEADERS, BODY) with a default of 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 function, 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 then configure it in the configuration file.

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

Request Retries

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 when 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 Decoder

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(); the custom error decoder needs to implement the 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 Interceptor

If we need to perform unified interception processing for all HTTP requests in the system, we can customize and implement a global interceptor BaseGlobalInterceptor and configure it as a Spring container bean! For example, if we want all HTTP requests initiated in the system to 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 Interceptor

Simply implement the NetworkInterceptor interface and configure it as a Spring container bean 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 availability of services. 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 automatic discovery of circuit breaker resources and annotation-based degradation rule configuration. To use circuit breaker degradation, simply perform the following operations:

1. Enable Circuit Breaker Degradation Functionality

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

retrofit:
  # Enable circuit breaker degradation
  enable-degrade: true
  # Circuit breaker 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, with the default configuration being DefaultResourceNameParser, corresponding to the resource name format of HTTP_OUT:GET:http://localhost:8080/api/degrade/test. Users can inherit from the BaseResourceNameParser class to implement their own resource name parser.

Additionally, since the 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 higher priority given to configurations on methods.

@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 already 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 the @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 Spring container Beans.

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

@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 configuration is required:

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

Users can implement the ServiceInstanceChooser interface 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 implement 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 Call<T> objects to the return value type of interface methods through call adapters CallAdapterFactory. retrofit-spring-boot-starter extends two implementations of CallAdapterFactory:

```
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 a 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>: Does not perform adaptation, directly returns the <code>Call<T> object
CompletableFuture<T>: Adapts the response body content to return a <code>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!
Response<T>: Adapts the response content to return a <code>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!

    /**
     * Call<T>
     * Does not perform adaptation, 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
     * Does not focus on the return type, can use Void. If the HTTP status code is not 2xx, it throws an error!
     * @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!
     * @param id
     * @return
     */
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

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

retrofit-spring-boot-starter supports configuring global call adapter factories through retrofit.global-call-adapter-factories, with factory instances prioritized to be obtained from the Spring container; if not found, they will be created using 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(), with the specified factory instance 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, with converter factory instances prioritized to be obtained from the Spring container; if not found, they will be created using reflection. The default global data converter factory is retrofit2.converter.jackson.JacksonConverterFactory, and you can directly configure spring.jackson.* to set Jackson serialization rules. For configuration, please refer to 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(), with the specified converter factory instance 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!

Conclusion

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 several external companies.

Author: 夜尽天明_

https://juejin.cn/post/6898485806587969544

·················END·················

Resource Links

Tsinghua University senior's self-study Linux notes, top-level!
New version of Bird Brother's Linux private cookbook materials
Alibaba's big shots summarized "Illustrated Java" has become popular, full version PDF open for download!

Alibaba officially launched! SpringBoot + SpringCloud full-color guide
The strongest full-stack project of SpringBoot + Vue in China, no rebuttal accepted!

Ditch OkHttp and HttpClient: This Lightweight HTTP Client Framework is Incredibly Useful!

Introduction

Features

Quick Start

Include Dependency

Define HTTP Interface

Inject and Use

HTTP Request Related Annotations

Configuration Item Description

Advanced Features

Custom Injection of OkHttpClient

Annotation-based Interceptors

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

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

Logging

Request Retries

Error Decoder

Global Interceptors

Global Application Interceptor

Global Network Interceptor

Circuit Breaker and Degradation

1. Enable Circuit Breaker Degradation Functionality

2. Configure Degradation Rules (Optional)

3. Set Fallback or FallbackFactory in @RetrofitClient (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 implement HTTP calls between microservices

Call Adapters and Data Converters

Call Adapters

Data Converters

Conclusion

Leave a Comment Cancel reply

Introduction

Features

Quick Start

Include Dependency

Define HTTP Interface

Inject and Use

HTTP Request Related Annotations

Configuration Item Description

Advanced Features

Custom Injection of OkHttpClient

Annotation-based Interceptors

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

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

Logging

Request Retries

Error Decoder

Global Interceptors

Global Application Interceptor

Global Network Interceptor

Circuit Breaker and Degradation

1. Enable Circuit Breaker Degradation Functionality

2. Configure Degradation Rules (Optional)

3. Set Fallback or FallbackFactory in @RetrofitClient (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 implement HTTP calls between microservices

Call Adapters and Data Converters

Call Adapters

Data Converters

Conclusion

Related posts

Leave a Comment Cancel reply

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

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

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

Implement `<span>SignInterceptor</span>`

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

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 implement HTTP calls between microservices