“真香”警告！Spring Boot 專案最優雅的 HTTP 客戶端工具-有解無憂

大家都知道okhttp是一款由square公司開源的java版本http客戶端工具，實際上，square公司還開源了基于okhttp進一步封裝的retrofit工具，用來支持通過介面的方式發起http請求，如果你的專案中還在直接使用RestTemplate或者okhttp，或者基于它們封裝的HttpUtils，那么你可以嘗試使用Retrofit，retrofit-spring-boot-starter實作了Retrofit與spring-boot框架快速整合，并且支持了部分功能增強，從而極大的簡化spring-boot專案下http介面呼叫開發，接下來我們直接通過retrofit-spring-boot-starter，來看看spring-boot專案發送http請求有多簡單，

retrofit官方并沒有提供與spring-boot快速整合的starter，retrofit-spring-boot-starter是筆者封裝的，已在生產環境使用，非常穩定，

專案原始碼：retrofit-spring-boot-starter

引入依賴

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

配置`@RetrofitScan`注解

你可以給帶有@Configuration的類配置@RetrofitScan，或者直接配置到spring-boot的啟動類上，如下：

@SpringBootApplication
@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
public class RetrofitTestApplication {
    public static void main(String[] args) {
        SpringApplication.run(RetrofitTestApplication.class, args);
    }
}

定義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() {
        
    }
}

只要通過上述幾個步驟，就能實作通過介面發送http請求了，真的很簡單，如果你在spring-boot專案里面使用過mybatis，相信你對這種使用方式會更加熟悉，接下來我們繼續介紹一下retrofit-spring-boot-starter更高級一點的功能，

注解式攔截器

很多時候，我們希望某個介面下的某些http請求執行統一的攔截處理邏輯，這個時候可以使用注解式攔截器，使用的步驟主要分為2步：

繼承BasePathMatchInterceptor撰寫攔截處理器；
介面上使用@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);
}

連接池管理

默認情況下，所有通過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

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

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

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

日志列印

很多情況下，我們希望將http請求日志記錄下來，通過@RetrofitClient的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

Http例外資訊格式化器

當出現http請求例外時，原始的例外資訊可能閱讀起來并不友好，因此retrofit-spring-boot-starter提供了Http例外資訊格式化器，用來美化輸出http請求引數，默認使用DefaultHttpExceptionMessageFormatter進行請求資料格式化，你也可以進行自定義，只需要繼承BaseHttpExceptionMessageFormatter，再進行相關配置即可，

retrofit:
  # Http例外資訊格式化器
  http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter

呼叫配接器 CallAdapter`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；然后將自定義的CallAdapterFactory配置成spring的bean！

自定義配置的CallAdapter.Factory優先級更高！
資料轉碼器 Converter
Retrofi使用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-simplexmlretrofit-spring-boot-starter默認使用的是jackson進行序列化轉換！如果需要使用其它序列化方式，在專案中引入對應的依賴，再把對應的ConverterFactory配置成spring的bean即可，我們也可以通過繼承Converter.Factory擴展實作自己的Converter；然后將自定義的Converter.Factory配置成spring的bean！
  自定義配置的Converter.Factory優先級更高！
- 全域攔截器 BaseGlobalInterceptor
  如果我們需要對整個系統的的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);
    }
}
```
  結語
  
  至此，spring-boot專案下最優雅的http客戶端工具介紹就結束了，更多詳細資訊可以參考官方檔案：retrofit以及retrofit-spring-boot-starter，實作原理解讀可查看基于Retrofit實作自己的輕量級http呼叫工具

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/134887.html

標籤：其他

上一篇：Python中最常用的6個地圖可視化庫

下一篇：學習第39天

“真香”警告！Spring Boot 專案最優雅的 HTTP 客戶端工具

引入依賴

配置@RetrofitScan注解

注解式攔截器

繼承BasePathMatchInterceptor撰寫攔截處理器

介面上使用@Intercept進行標注

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

擴展注解式攔截器

自定義@Sign注解

實作SignInterceptor

介面上使用@Sign