天天看點
傳回

Spring Boot 中的 RestTemplate不好用？試試 Retrofit ！ 進來看看

大家都知道okhttp是一款由square公司開源的java版本http用戶端工具。實際上，square公司還開源了基于okhttp進一步封裝的retrofit工具，用來支援通過接口的方式發起http請求。

如果你的項目中還在直接使用RestTemplate或者okhttp，或者基于它們封裝的HttpUtils，那麼你可以嘗試使用Retrofit。

retrofit-spring-boot-starter

實作了Retrofit與spring-boot架構快速整合，并且支援了部分功能增強，進而極大的簡化spring-boot項目下http接口調用開發。接下來我們直接通過ret

rofit-spring-boot-starter

，來看看spring-boot項目發送http請求有多簡單。

retrofit官方并沒有提供與spring-boot快速整合的starter。

retrofit-spring-boot-starter

是筆者封裝的，已在生産環境使用，非常穩定。喜歡的話給個star。

https://github.com/LianjiaTech/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相關注解可參考官方文檔：

https://square.github.io/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請求了，真的很簡單。如果你在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方法。Java知音公衆号内回複“後端面試”，送你一份Java面試題寶典

接口上使用@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的連接配接池，代碼實作如下：

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

日志列印

很多情況下，我們希望将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進行請求資料格式化。Java知音公衆号内回複“後端面試”，送你一份Java面試題寶典

你也可以進行自定義，隻需要繼承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-simplexml

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

Spring Boot 中的 RestTemplate不好用？試試 Retrofit ！ 進來看看
上一篇: Java 繼承，Object中的方法（equal）
下一篇: 關于幾種類型的快排函數的說明