推薦一款 Spring Boot 的 HTTP 客戶端框架

• 自定義注入OkHttpClient
• 注解式攔截器
• 連接池管理
• 日志打印
• 請求重試
• 錯誤解碼器
• 全局攔截器
• 熔斷降級
• 微服務(wù)之間的HTTP調(diào)用
• 調(diào)用適配器
• 數(shù)據(jù)轉(zhuǎn)換器

引入依賴

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

定義http接口

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

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

注入使用

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

    public void test() {
        // 通過httpApi發(fā)起http請求
    }
}

HTTP請求相關(guān)注解

HTTP請求相關(guān)注解，全部使用了retrofit原生注解。詳細信息可參考官方文檔：retrofit官方文檔 ，以下是一個簡單說明。

配置項說明

retrofit-spring-boot-starter支持了多個可配置的屬性，用來應(yīng)對不同的業(yè)務(wù)場景。您可以視情況進行修改，具體說明如下：

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
  # 全局轉(zhuǎn)換器工廠
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory
  # 全局調(diào)用適配器工廠
  global-call-adapter-factories:
    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory
    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory
  # 是否啟用熔斷降級
  enable-degrade: true
  # 熔斷降級實現(xiàn)方式
  degrade-type: sentinel
  # 熔斷資源名稱解析器
  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

高級功能

自定義注入OkHttpClient

@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注解標(biāo)記！

注解式攔截器

1. 繼承BasePathMatchInterceptor編寫攔截處理器；

2. 接口上使用@Intercept進行標(biāo)注。如需配置多個攔截器，在接口上標(biāo)注多個@Intercept注解即可！

@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 進行標(biāo)注

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

擴展注解式攔截器

1. 自定義攔截注解

2. 繼承BasePathMatchInterceptor編寫攔截處理器

3. 接口上使用自定義攔截注解；

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

    /**
     * 處理該注解的攔截器類
     * 優(yōu)先從spring容器獲取對應(yīng)的Bean，如果獲取不到，則使用反射創(chuàng)建一個！
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

1.自定義攔截注解必須使用@InterceptMark標(biāo)記。

2. 注解中必須包括include()、exclude()、handler()屬性信息。

實現(xiàn)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);
    }
}

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

1. 配置連接池。

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

2. 通過@RetrofitClient的poolName屬性來指定使用的連接池。

@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

日志打印

1. NONE：No logs.

2. BASIC：Logs request and response lines.

3. HEADERS：Logs request and response lines and their respective headers.

4. BODY：Logs request and response lines and their respective headers and bodies (if present).

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

請求重試

1. RESPONSE_STATUS_NOT_2XX：響應(yīng)狀態(tài)碼不是2xx時執(zhí)行重試；

2. OCCUR_IO_EXCEPTION：發(fā)生IO異常時執(zhí)行重試；

3. OCCUR_EXCEPTION：發(fā)生任意異常時執(zhí)行重試；

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

錯誤解碼器

/**
 * 錯誤解碼器。ErrorDecoder.
 * 當(dāng)請求發(fā)生異常或者收到無效響應(yīng)結(jié)果的時候，將HTTP相關(guān)信息解碼到異常中，無效響應(yīng)由業(yè)務(wù)自己判斷
 *
 * 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 {

    /**
     * 當(dāng)無效響應(yīng)的時候，將HTTP信息解碼到異常中，無效響應(yīng)由業(yè)務(wù)自行判斷。
     * 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;
    }


    /**
     * 當(dāng)請求發(fā)生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);
    }

    /**
     * 當(dāng)請求發(fā)生除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);
    }

}

全局攔截器

全局應(yīng)用攔截器

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

全局網(wǎng)絡(luò)攔截器

熔斷降級

1. 開啟熔斷降級功能

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

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

2. 配置降級規(guī)則（可選）

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

如果應(yīng)用項目已支持通過配置中心配置降級規(guī)則，可忽略注解式配置方式 。

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

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

微服務(wù)之間的HTTP調(diào)用

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

使用@Retrofit的serviceId和path屬性，可以實現(xiàn)微服務(wù)之間的HTTP調(diào)用

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

}

調(diào)用適配器和數(shù)據(jù)轉(zhuǎn)碼器

調(diào)用適配器

BodyCallAdapterFactory

• 默認啟用，可通過配置retrofit.enable-body-call-adapter=false關(guān)閉
• 同步執(zhí)行http請求，將響應(yīng)體內(nèi)容適配成接口方法的返回值類型實例。
• 除了Retrofit.Call<T>、Retrofit.Response<T>、java.util.concurrent.CompletableFuture<T>之外，其它返回類型都可以使用該適配器。

 ResponseCallAdapterFactory

• 默認啟用，可通過配置retrofit.enable-response-call-adapter=false關(guān)閉
• 同步執(zhí)行http請求，將響應(yīng)體內(nèi)容適配成Retrofit.Response<T>返回。
• 如果方法的返回值類型為Retrofit.Response<T>，則可以使用該適配器。

• Call<T>: 不執(zhí)行適配處理，直接返回Call<T>對象
• CompletableFuture<T>: 將響應(yīng)體內(nèi)容適配成CompletableFuture<T>對象返回
• Void: 不關(guān)注返回類型可以使用Void。如果http狀態(tài)碼不是2xx，直接拋錯！
• Response<T>: 將響應(yīng)內(nèi)容適配成Response<T>對象返回
• 其他任意Java類型：將響應(yīng)體內(nèi)容適配成一個對應(yīng)的Java類型對象返回，如果http狀態(tài)碼不是2xx，直接拋錯！

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

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

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

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

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

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

• 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:
  # 全局轉(zhuǎn)換器工廠
  global-converter-factories:
    - retrofit2.converter.jackson.JacksonConverterFactory

來源：juejin.cn/post/6898485806587969544

 關(guān)注公眾號：Java后端編程，回復(fù)下面關(guān)鍵字 

要Java學(xué)習(xí)完整路線，回復(fù)  路線 
缺Java入門視頻，回復(fù)： 視頻 
要Java面試經(jīng)驗，回復(fù)  面試 
缺Java項目，回復(fù)： 項目 
進Java粉絲群： 加群 

PS：如果覺得我的分享不錯，歡迎大家隨手點贊、在看。
（完）




加我"微信" 獲取一份 最新Java面試題資料
請備注：666，不然不通過～

最近好文

1、GitHub 近兩萬 Star，可一鍵生成前后端代碼
2、Spring 官方為什么建議構(gòu)造器注入？
3、10000 字講清楚 Spring Boot 注解原理
4、13個優(yōu)秀的 Vue 開源項目及合集推薦
5、Java項目實戰(zhàn)：利用注解 + 反射消除重復(fù)代碼


最近面試BAT，整理一份面試資料《Java面試BAT通關(guān)手冊》，覆蓋了Java核心技術(shù)、JVM、Java并發(fā)、SSM、微服務(wù)、數(shù)據(jù)庫、數(shù)據(jù)結(jié)構(gòu)等等。
獲取方式：關(guān)注公眾號并回復(fù) java 領(lǐng)取，更多內(nèi)容陸續(xù)奉上。
明天見(??ω??)??