你知道的越多，不知道的就越多，業餘的像一棵小草！

你來，咱們一塊兒精進！你不來，我和你的競爭對手一塊兒精進！
java

編輯：業餘草

juejin.cn/post/6898485806587969544

推薦：https://www.xttblog.com/?p=5120

在SpringBoot項目直接使用okhttp、httpClient或者RestTemplate發起HTTP請求，既繁瑣又不方便統一管理。所以，在這裏推薦一個適用於SpringBoot項目的輕量級HTTP客戶端框架retrofit-spring-boot-starter，使用很是簡單方便，同時又提供諸多功能加強。目前項目已經更新至2.2.2版本，而且會持續進行迭代優化。
git

前言

Retrofit是適用於Android和Java且類型安全的HTTP客戶端，其最大的特性的是支持經過接口的方式發起HTTP請求 。而spring-boot是使用最普遍的Java開發框架，可是Retrofit官方沒有支持與spring-boot框架快速整合，所以咱們開發了retrofit-spring-boot-starter。github

retrofit-spring-boot-starter實現了Retrofit與spring-boot框架快速整合，而且支持了諸多功能加強，極大簡化開發 。web

🚀項目持續優化迭代。spring

功能特性

自定義注入OkHttpClient
註解式攔截器
鏈接池管理
日誌打印
請求重試
錯誤解碼器
全局攔截器
熔斷降級
微服務之間的HTTP調用
調用適配器
數據轉換器

快速使用

引入依賴

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

定義http接口

接口必須使用@RetrofitClient註解標記 ！http相關注解可參考官方文檔：retrofit官方文檔。安全

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

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

注入使用

將接口注入到其它Service中便可使用！網絡

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

    public void test() {
        // 經過httpApi發起http請求
    }
}
架構

HTTP請求相關注解

HTTP請求相關注解，所有使用了retrofit原生註解。詳細信息可參考官方文檔：retrofit官方文檔 ，如下是一個簡單說明。

註解分類

支持的註解


請求方式	`@GET` `@HEAD` `@POST` `@PUT` `@DELETE` `@OPTIONS`
請求頭	`@Header` `@HeaderMap` `@Headers`
Query參數	`@Query` `@QueryMap` `@QueryName`
path參數	`@Path`
form-encoded參數	`@Field` `@FieldMap` `@FormUrlEncoded`
文件上傳	`@Multipart` `@Part` `@PartMap`
url參數	`@Url`

配置項說明

retrofit-spring-boot-starter支持了多個可配置的屬性，用來應對不一樣的業務場景。您能夠視狀況進行修改，具體說明以下：

配置默認值說明


enable-log	true	啓用日誌打印
logging-interceptor	DefaultLoggingInterceptor	日誌打印攔截器
pool		鏈接池配置
disable-void-return-type	false	禁用java.lang.Void返回類型
retry-interceptor	DefaultRetryInterceptor	請求重試攔截器
global-converter-factories	JacksonConverterFactory	全局轉換器工廠
global-call-adapter-factories	BodyCallAdapterFactory,ResponseCallAdapterFactory	全局調用適配器工廠
enable-degrade	false	是否啓用熔斷降級
degrade-type	sentinel	熔斷降級實現方式(目前僅支持Sentinel)
resource-name-parser	DefaultResourceNameParser	熔斷資源名稱解析器，用於解析資源名稱

yml配置方式：

retrofit:
  enable-response-call-adapter: true
  # 啓用日誌打印
  enable-log: true
  # 鏈接池配置
  pool:
    test1:
      max-idle-connections: 3
      keep-alive-second: 100
    test2:
      max-idle-connections: 5
      keep-alive-second: 50
  # 禁用void返回值類型
  disable-void-return-type: false
  # 日誌打印攔截器
  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
  # 請求重試攔截器
  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor
  # 全局轉換器工廠
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory
  # 全局調用適配器工廠
  global-call-adapter-factories:
    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory
    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory
  # 是否啓用熔斷降級
  enable-degrade: true
  # 熔斷降級實現方式
  degrade-type: sentinel
  # 熔斷資源名稱解析器
  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

高級功能

自定義注入OkHttpClient

一般狀況下，經過@RetrofitClient註解屬性動態建立OkHttpClient對象可以知足大部分使用場景。可是在某些狀況下，用戶可能須要自定義OkHttpClient，這個時候，能夠在接口上定義返回類型是OkHttpClient.Builder的靜態方法來實現。代碼示例以下：

@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);
}

方法必須使用@OkHttpClientBuilder註解標記！

註解式攔截器

不少時候，咱們但願某個接口下的某些http請求執行統一的攔截處理邏輯。爲了支持這個功能，retrofit-spring-boot-starter提供了註解式攔截器 ，作到了基於url路徑的匹配攔截 。使用的步驟主要分爲2步：

繼承 BasePathMatchInterceptor編寫攔截處理器；
接口上使用 @Intercept進行標註。如需配置多個攔截器，在接口上標註多個 @Intercept註解便可！

下面以給指定請求的url後面拼接timestamp時間戳爲例，介紹下如何使用註解式攔截器。

繼承`BasePathMatchInterceptor`編寫攔截處理器

@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);
    }
}

接口上使用`@Intercept`進行標註

@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);
}

上面的@Intercept配置表示：攔截HttpApi接口下/api/**路徑下（排除/api/test/savePerson）的請求，攔截處理器使用TimeStampInterceptor。

擴展註解式攔截器

有的時候，咱們須要在攔截註解 動態傳入一些參數，而後再執行攔截的時候須要使用這個參數。這種時候，咱們能夠擴展實現自定義攔截註解 。自定義攔截註解必須使用@InterceptMark標記，而且註解中必須包括include()、exclude()、handler()屬性信息 。使用的步驟主要分爲3步：

自定義攔截註解
繼承 BasePathMatchInterceptor編寫攔截處理器
接口上使用自定義攔截註解；

例如咱們須要在請求頭裏面動態加入accessKeyId、accessKeySecret簽名信息才能正常發起http請求 ，這個時候能夠自定義一個加簽攔截器註解@Sign來實現 。下面以自定義@Sign攔截註解爲例進行說明。

自定義`@Sign`註解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {
    /**
     * 密鑰key
     * 支持佔位符形式配置。
     *
     * @return
     */
    String accessKeyId();

    /**
     * 密鑰
     * 支持佔位符形式配置。
     *
     * @return
     */
    String accessKeySecret();

    /**
     * 攔截器匹配路徑
     *
     * @return
     */
    String[] include() default {"/**"};

    /**
     * 攔截器排除匹配，排除指定路徑攔截
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * 處理該註解的攔截器類
     * 優先從spring容器獲取對應的Bean，若是獲取不到，則使用反射建立一個！
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

擴展自定義攔截註解有如下2點須要注意：

自定義攔截註解必須使用 @InterceptMark標記。
註解中必須包括 include()、exclude()、handler()屬性信息。

實現`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);
    }
}

上述accessKeyId和accessKeySecret字段值會依據@Sign註解的accessKeyId()和accessKeySecret()值自動注入，若是@Sign指定的是佔位符形式的字符串，則會取配置屬性值進行注入。另外，accessKeyId和accessKeySecret字段必須提供setter方法 。

接口上使用`@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);
}

這樣就能在指定url的請求上，自動加上簽名信息了。

鏈接池管理

默認狀況下，全部經過Retrofit發送的http請求都會使用max-idle-connections=5 keep-alive-second=300的默認鏈接池。固然，咱們也能夠在配置文件中配置多個自定義的鏈接池，而後經過@RetrofitClient的poolName屬性來指定使用。好比咱們要讓某個接口下的請求所有使用poolName=test1的鏈接池，代碼實現以下：

一、配置鏈接池。

   retrofit:
       # 鏈接池配置
       pool:
           test1:
           max-idle-connections: 3
           keep-alive-second: 100
           test2:
           max-idle-connections: 5
           keep-alive-second: 50

一、經過@RetrofitClient的poolName屬性來指定使用的鏈接池。

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

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

日誌打印

不少狀況下，咱們但願將http請求日誌記錄下來。經過retrofit.enableLog配置能夠全局控制日誌是否開啓。針對每一個接口，能夠經過@RetrofitClient的enableLog控制是否開啓，經過logLevel和logStrategy，能夠指定每一個接口的日誌打印級別以及日誌打印策略。retrofit-spring-boot-starter支持了5種日誌打印級別(ERROR, WARN, INFO, DEBUG, TRACE)，默認INFO；支持了4種日誌打印策略（NONE, BASIC, HEADERS, BODY），默認BASIC。4種日誌打印策略含義以下：

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默認使用了DefaultLoggingInterceptor執行真正的日誌打印功能，其底層就是okhttp原生的HttpLoggingInterceptor。固然，你也能夠自定義實現本身的日誌打印攔截器，只須要繼承BaseLoggingInterceptor（具體能夠參考DefaultLoggingInterceptor的實現），而後在配置文件中進行相關配置便可。

retrofit:
# 日誌打印攔截器
logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor

請求重試

retrofit-spring-boot-starter支持請求重試功能，只須要在接口或者方法上加上@Retry註解便可。@Retry支持重試次數maxRetries、重試時間間隔intervalMs以及重試規則retryRules配置 。重試規則支持三種配置：

RESPONSE_STATUS_NOT_2XX：響應狀態碼不是 2xx時執行重試；
OCCUR_IO_EXCEPTION：發生IO異常時執行重試；
OCCUR_EXCEPTION：發生任意異常時執行重試；

默認響應狀態碼不是2xx或者發生IO異常時自動進行重試。須要的話，你也能夠繼承BaseRetryInterceptor實現本身的請求重試攔截器，而後將其配置上去。

retrofit:
# 請求重試攔截器
retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

錯誤解碼器

在HTTP發生請求錯誤(包括髮生異常或者響應數據不符合預期)的時候，錯誤解碼器可將HTTP相關信息解碼到自定義異常中。你能夠在@RetrofitClient註解的errorDecoder()指定當前接口的錯誤解碼器，自定義錯誤解碼器須要實現ErrorDecoder接口：

/**
* 錯誤解碼器。ErrorDecoder.
* 當請求發生異常或者收到無效響應結果的時候，將HTTP相關信息解碼到異常中，無效響應由業務本身判斷
*
* 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 {

    /**
     * 當無效響應的時候，將HTTP信息解碼到異常中，無效響應由業務自行判斷。
     * 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;
    }

    /**
     * 當請求發生IO異常時，將HTTP信息解碼到異常中。
     * 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);
    }

    /**
     * 當請求發生除IO異常以外的其它異常時，將HTTP信息解碼到異常中。
     * 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);
    }

}

全局攔截器

全局應用攔截器

若是咱們須要對整個系統的的http請求執行統一的攔截處理，能夠自定義實現全局攔截器BaseGlobalInterceptor, 並配置成spring容器中的bean！例如咱們須要在整個系統發起的http請求，都帶上來源信息。

@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);
    }
}

全局網絡攔截器

只須要實現NetworkInterceptor接口並配置成spring容器中的bean就支持自動織入全局網絡攔截器。

熔斷降級

在分佈式服務架構中，對不穩定的外部服務進行熔斷降級是保證服務高可用的重要措施之一。因爲外部服務的穩定性是不能保證的，當外部服務不穩定時，響應時間會變長。相應地，調用方的響應時間也會變長，線程會產生堆積，最終可能耗盡調用方的線程池，致使整個服務不可用。所以咱們須要對不穩定的弱依賴服務調用進行熔斷降級，暫時切斷不穩定調用，避免局部不穩定致使總體服務雪崩。

retrofit-spring-boot-starter支持熔斷降級功能，底層基於Sentinel實現。具體來講，支持了熔斷資源自發現 和註解式降級規則配置 。如需使用熔斷降級，只須要進行如下操做便可：

1. 開啓熔斷降級功能

默認狀況下，熔斷降級功能是關閉的，須要設置相應的配置項來開啓熔斷降級功能 ：

retrofit:
  # 是否啓用熔斷降級
  enable-degrade: true
  # 熔斷降級實現方式(目前僅支持Sentinel)
  degrade-type: sentinel
  # 資源名稱解析器
  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

資源名稱解析器用於實現用戶自定義資源名稱，默認配置是DefaultResourceNameParser，對應的資源名稱格式爲HTTP_OUT:GET:http://localhost:8080/api/degrade/test。用戶能夠繼承BaseResourceNameParser類實現本身的資源名稱解析器。

另外，因爲熔斷降級功能是可選的，所以啓用熔斷降級須要用戶自行引入Sentinel依賴 ：

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

2. 配置降級規則（可選）

retrofit-spring-boot-starter支持註解式配置降級規則，經過@Degrade註解來配置降級規則 。@Degrade註解能夠配置在接口或者方法上，配置在方法上的優先級更高。

@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;
}

若是應用項目已支持經過配置中心配置降級規則，可忽略註解式配置方式 。

3. @RetrofitClient設置fallback或者fallbackFactory (可選)

若是@RetrofitClient不設置fallback或者fallbackFactory，當觸發熔斷時，會直接拋出RetrofitBlockException異常。用戶能夠經過設置fallback或者fallbackFactory來定製熔斷時的方法返回值 。fallback類必須是當前接口的實現類，fallbackFactory必須是FallbackFactory<T>實現類，泛型參數類型爲當前接口類型。另外，fallback和fallbackFactory實例必須配置成Spring容器的Bean。

fallbackFactory相對於fallback，主要差異在於可以感知每次熔斷的異常緣由(cause) 。參考示例以下：

@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 實現了retrofit接口的實例。an instance that implements the retrofit interface.
     */
    @Override
    public HttpDegradeApi create(Throwable cause) {
        log.error("觸發熔斷了! ", 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調用

爲了可以使用微服務調用，須要進行以下配置：

配置`ServiceInstanceChooser`爲`Spring`容器`Bean`

用戶能夠自行實現ServiceInstanceChooser接口，完成服務實例的選取邏輯，並將其配置成Spring容器的Bean。對於Spring Cloud應用，retrofit-spring-boot-starter提供了SpringCloudServiceInstanceChooser實現，用戶只需將其配置成Spring的Bean便可。

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

使用`@Retrofit`的`serviceId`和`path`屬性，能夠實現微服務之間的HTTP調用

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

}

調用適配器和數據轉碼器

調用適配器

Retrofit能夠經過調用適配器CallAdapterFactory將Call<T>對象適配成接口方法的返回值類型。retrofit-spring-boot-starter擴展2種CallAdapterFactory實現：

BodyCallAdapterFactory

默認啓用，可經過配置 retrofit.enable-body-call-adapter=false關閉
同步執行http請求，將響應體內容適配成接口方法的返回值類型實例。
除了 Retrofit.Call<T>、 Retrofit.Response<T>、 java.util.concurrent.CompletableFuture<T>以外，其它返回類型均可以使用該適配器。

ResponseCallAdapterFactory

默認啓用，可經過配置 retrofit.enable-response-call-adapter=false關閉
同步執行http請求，將響應體內容適配成 Retrofit.Response<T>返回。
若是方法的返回值類型爲 Retrofit.Response<T>，則可使用該適配器。

Retrofit自動根據方法返回值類型選用對應的CallAdapterFactory執行適配處理！加上Retrofit默認的CallAdapterFactory，可支持多種形式的方法返回值類型：

Call<T>: 不執行適配處理，直接返回 Call<T>對象
CompletableFuture<T>: 將響應體內容適配成 CompletableFuture<T>對象返回
Void: 不關注返回類型可使用 Void。若是http狀態碼不是2xx，直接拋錯！
Response<T>: 將響應內容適配成 Response<T>對象返回
其餘任意Java類型：將響應體內容適配成一個對應的Java類型對象返回，若是http狀態碼不是2xx，直接拋錯！

    /**
     * Call<T>
     * 不執行適配處理，直接返回Call<T>對象
     * @param id
     * @return
     */
    @GET("person")
    Call<Result<Person>> getPersonCall(@Query("id") Long id);

    /**
     *  CompletableFuture<T>
     *  將響應體內容適配成CompletableFuture<T>對象返回
     * @param id
     * @return
     */
    @GET("person")
    CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);

    /**
     * Void
     * 不關注返回類型可使用Void。若是http狀態碼不是2xx，直接拋錯！
     * @param id
     * @return
     */
    @GET("person")
    Void getPersonVoid(@Query("id") Long id);

    /**
     *  Response<T>
     *  將響應內容適配成Response<T>對象返回
     * @param id
     * @return
     */
    @GET("person")
    Response<Result<Person>> getPersonResponse(@Query("id") Long id);

    /**
     * 其餘任意Java類型
     * 將響應體內容適配成一個對應的Java類型對象返回，若是http狀態碼不是2xx，直接拋錯！
     * @param id
     * @return
     */
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

咱們也能夠經過繼承CallAdapter.Factory擴展實現本身的CallAdapter ！

retrofit-spring-boot-starter支持經過retrofit.global-call-adapter-factories配置全局調用適配器工廠，工廠實例優先從Spring容器獲取，若是沒有獲取到，則反射建立。默認的全局調用適配器工廠是[BodyCallAdapterFactory, ResponseCallAdapterFactory]！

retrofit:
  # 全局調用適配器工廠
  global-call-adapter-factories:
    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory
    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory

針對每一個Java接口，還能夠經過@RetrofitClient註解的callAdapterFactories()指定當前接口採用的CallAdapter.Factory，指定的工廠實例依然優先從Spring容器獲取。

注意：若是CallAdapter.Factory沒有public的無參構造器，請手動將其配置成Spring容器的Bean對象 ！

數據轉碼器

Retrofit使用Converter將@Body註解標註的對象轉換成請求體，將響應體數據轉換成一個Java對象，能夠選用如下幾種Converter：

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支持經過retrofit.global-converter-factories配置全局數據轉換器工廠，轉換器工廠實例優先從Spring容器獲取，若是沒有獲取到，則反射建立。默認的全局數據轉換器工廠是retrofit2.converter.jackson.JacksonConverterFactory，你能夠直接經過spring.jackson.*配置jackson序列化規則，配置可參考Customize the Jackson ObjectMapper！

retrofit:
  # 全局轉換器工廠
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory

針對每一個Java接口，還能夠經過@RetrofitClient註解的converterFactories()指定當前接口採用的Converter.Factory，指定的轉換器工廠實例依然優先從Spring容器獲取。

注意：若是Converter.Factory沒有public的無參構造器，請手動將其配置成Spring容器的Bean對象 ！

總結

retrofit-spring-boot-starter一個適用於SpringBoot項目的輕量級HTTP客戶端框架，已在線上穩定運行一年多，而且已經有多個外部公司也接入使用。

本文分享自微信公衆號 - 業餘草（yyucao）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。

爲何我決定要放棄 okhttp、httpClient？