2. 程式人生 > 實用技巧 >Spring Boot專案下最優雅的http客戶端工具，用它就夠了，太香了

Spring Boot專案下最優雅的http客戶端工具，用它就夠了，太香了

阿新 • • 發佈：2020-11-03

大家都知道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是筆者封裝的，已在生產環境使用，非常穩定。造輪子不易，跪求各位大佬star。

引入依賴

<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")
publicclassRetrofitTestApplication{

publicstaticvoidmain(String[]args){
SpringApplication.run(RetrofitTestApplication.class,args);
}
}

定義http介面

介面必須使用@RetrofitClient註解標記！http相關注解可參考官方文件：retrofit官方文件。

@RetrofitClient(baseUrl="${test.baseUrl}")
publicinterfaceHttpApi{

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

注入使用

將介面注入到其它Service中即可使用。

@Service
publicclassTestService{

@Autowired
privateHttpApihttpApi;

publicvoidtest(){
//通過httpApi發起http請求
}
}

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

註解式攔截器

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

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

  2. 介面上使用@Intercept進行標註。

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

繼承BasePathMatchInterceptor編寫攔截處理器

@Component
publicclassTimeStampInterceptorextendsBasePathMatchInterceptor{

@Override
publicResponsedoIntercept(Chainchain)throwsIOException{
Requestrequest=chain.request();
HttpUrlurl=request.url();
longtimestamp=System.currentTimeMillis();
HttpUrlnewUrl=url.newBuilder()
.addQueryParameter("timestamp",String.valueOf(timestamp))
.build();
RequestnewRequest=request.newBuilder()
.url(newUrl)
.build();
returnchain.proceed(newRequest);
}
}

介面上使用@Intercept進行標註

@RetrofitClient(baseUrl="${test.baseUrl}")
@Intercept(handler=TimeStampInterceptor.class,include={"/api/**"},exclude="/api/test/savePerson")
publicinterfaceHttpApi{

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

@POST("savePerson")
Result<Person>savePerson(@BodyPersonperson);
}

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

擴充套件註解式攔截器

有的時候，我們需要在攔截註解動態傳入一些引數，然後再執行攔截的時候需要使用這個引數。這種時候，我們可以擴充套件實現自定義攔截註解。自定義攔截註解必須使用@InterceptMark標記，並且註解中必須包括include()、exclude()、handler()屬性資訊。使用的步驟主要分為3步：

  1. 自定義攔截註解

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

  3. 介面上使用自定義攔截註解；

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

自定義@Sign註解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public@interfaceSign{
/**
*金鑰key
*支援佔位符形式配置。
*
*@return
*/
StringaccessKeyId();

/**
*金鑰
*支援佔位符形式配置。
*
*@return
*/
StringaccessKeySecret();

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

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

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

擴充套件自定義攔截註解有以下2點需要注意：

  1. 自定義攔截註解必須使用@InterceptMark標記。

  2. 註解中必須包括include()、exclude()、handler()屬性資訊。

實現SignInterceptor

@Component
publicclassSignInterceptorextendsBasePathMatchInterceptor{

privateStringaccessKeyId;

privateStringaccessKeySecret;

publicvoidsetAccessKeyId(StringaccessKeyId){
this.accessKeyId=accessKeyId;
}

publicvoidsetAccessKeySecret(StringaccessKeySecret){
this.accessKeySecret=accessKeySecret;
}

@Override
publicResponsedoIntercept(Chainchain)throwsIOException{
Requestrequest=chain.request();
RequestnewReq=request.newBuilder()
.addHeader("accessKeyId",accessKeyId)
.addHeader("accessKeySecret",accessKeySecret)
.build();
returnchain.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"})
publicinterfaceHttpApi{

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

@POST("savePerson")
Result<Person>savePerson(@BodyPersonperson);
}

這樣就能在指定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種日誌列印策略含義如下：

  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-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實現：

  1. BodyCallAdapterFactory 預設啟用，可通過配置retrofit.enable-body-call-adapter=false關閉 同步執行http請求，將響應體內容適配成介面方法的返回值型別例項。 除了Retrofit.Call<T>、Retrofit.Response<T>、java.util.concurrent.CompletableFuture<T>之外，其它返回型別都可以使用該介面卡。

  2. 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>物件
*@paramid
*@return
*/
@GET("person")
Call<Result<Person>>getPersonCall(@Query("id")Longid);

/**
*CompletableFuture<T>
*將響應體內容適配成CompletableFuture<T>物件返回
*@paramid
*@return
*/
@GET("person")
CompletableFuture<Result<Person>>getPersonCompletableFuture(@Query("id")Longid);

/**
*Void
*不關注返回型別可以使用Void。如果http狀態碼不是2xx，直接拋錯！
*@paramid
*@return
*/
@GET("person")
VoidgetPersonVoid(@Query("id")Longid);

/**
*Response<T>
*將響應內容適配成Response<T>物件返回
*@paramid
*@return
*/
@GET("person")
Response<Result<Person>>getPersonResponse(@Query("id")Longid);

/**
*其他任意Java型別
*將響應體內容適配成一個對應的Java型別物件返回，如果http狀態碼不是2xx，直接拋錯！
*@paramid
*@return
*/
@GET("person")
Result<Person>getPerson(@Query("id")Longid);

我們也可以通過繼承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
publicclassSourceInterceptorextendsBaseGlobalInterceptor{
@Override
publicResponsedoIntercept(Chainchain)throwsIOException{
Requestrequest=chain.request();
RequestnewReq=request.newBuilder()
.addHeader("source","test")
.build();
returnchain.proceed(newReq);
}
}

結語

至此，spring-boot專案下最優雅的http客戶端工具介紹就結束了

相關推薦

Spring Boot專案下最優雅的http客戶端工具，用它就夠了，太香了

大家都知道okhttp是一款由square公司開源的java版本http客戶端工具。實際上，square公司還開源了基於okhttp進一步封裝的retrofit工具，用來支援通過介面的方式發起http請求。如果你的專案中還在直接使用RestTemplat

retrofit get請求_【學習充電】Spring Boot專案整合Retrofit最佳實踐，最優雅的HTTP客戶端工具！...

技術標籤：retrofit get請求 大家都知道 OKHttp 是一款由 Square公司開源的 Java 版本 HTTP 客戶端工具。實際上，Square公司還開源了基於OKHttp進一步封裝的 Retrofit工具，用來支援通過介面的方式發起HTTP請

SpringBoot專案整合Retrofit最佳實踐，這才是最優雅的HTTP客戶端工具！

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

Spring Boot專案如何同時支援HTTP和HTTPS協議

本文首發於個人網站：Spring Boot專案如何同時支援HTTP和HTTPS協議 如今，企業級應用程式的常見場景是同時支援HTTP和HTTPS兩種協議，這篇文章考慮如何讓Spring Boot應用程式同時支援HTTP和HTTPS兩種協議。

Spring Boot專案如何同時支援HTTP和HTTPS協議的實現

如今，企業級應用程式的常見場景是同時支援HTTP和HTTPS兩種協議，這篇文章考慮如何讓Spring Boot應用程式同時支援HTTP和HTTPS兩種協議。

Spring Boot 2.x 版本預設Redis客戶端已經使用Lettuce

一、Redis的常用三個java客戶端：Jedis,Redisson,Lettuce Jedis：是Redis的Java實現客戶端，提供了比較全面的Redis命令的支援，使用阻塞的I/O，程式流需要等到sockets處理完I/O才能執行，不支援非同步。Jedis客戶端

最優雅的Docker+Jenkins pipeline部署Spring boot專案

使用Jenkins釋出專案已經4年多，做過多次改進，儘量減少Jenkins的配置和釋出指令碼的書寫。從最初的構建一個自由風格的軟體專案到流水線專案到現在的流水線+docker，流水線可以讓專案釋出流程更加清晰，docker可以大

Spring Boot 系列：最新版優雅停機詳解

愛生活，愛編碼，本文已收錄架構技術專欄關注這個喜歡分享的地方。 開源專案：

spring boot不同版本的優雅關閉(graceful shutdown)和在windows下winsw服務方式執行的配置

起因 spring boot預設是不會優雅關閉的，這樣就導致在重啟時會將正在執行的程式打斷，導致故障發生。

Spring Boot專案優雅的全域性異常處理方式

前言 在日常專案開發中，異常是常見的，但是如何更高效的處理好異常資訊，讓我們能快速定位到BUG，是很重要的，不僅能夠提高我們的開發效率，還能讓你程式碼看上去更舒服，SpringBoot的專案已經對有一定的異常處理

spring boot專案在外部tomcat環境下部署

spring-boot預設提供內嵌的tomcat，所以打包直接生成jar包，用java -jar命令就可以啟動。但是，有時候我們更希望一個tomcat來管理多個專案，這種情況下就需要專案是war格式的包而不是jar格式的包。spring-boot同樣提

Spring Boot專案中如何定製servlet-filters

本文首發於個人網站：Spring Boot專案中如何定製servlet-filters 在實際的web應用程式中，經常需要在請求（request）外面增加包裝用於：記錄呼叫日誌、排除有XSS威脅的字元、執行許可權驗證等等。除了上述提到的之

Spring Boot2 系列教程(三)理解 Spring Boot 專案中的 parent

前面和大夥聊了 Spring Boot 專案的三種建立方式，這三種建立方式，無論是哪一種，建立成功後，pom.xml 座標檔案中都有如下一段引用：

Spring Boot專案中如何定製PropertyEditors

本文首發於個人網站：Spring Boot專案中如何定製PropertyEditors 在Spring Boot: 定製HTTP訊息轉換器一文中我們學習瞭如何配置訊息轉換器用於HTTP請求和響應資料，實際上，在一次請求的完成過程中還發生了其他的轉

Spring Boot專案中如何定製攔截器

本文首發於個人網站：Spring Boot專案中如何定製攔截器 Servlet 過濾器屬於Servlet API，和Spring關係不大。除了使用過濾器包裝web請求，Spring MVC還提供HandlerInterceptor（攔截器）工具。根據檔案，HandlerI

在Spring Boot專案中使用Spock測試框架

本文首發於個人網站：在Spring Boot專案中使用Spock測試框架 Spock框架是基於Groovy語言的測試框架，Groovy與Java具備良好的互操作性，因此可以在Spring Boot專案中使用該框架寫優雅、高效以及DSL化的測試用例。

Spring Boot專案中使用Mockito

本文首發於個人網站：Spring Boot專案中使用Mockito Spring Boot可以和大部分流行的測試框架協同工作：通過Spring JUnit建立單元測試；生成測試資料初始化資料庫用於測試；Spring Boot可以跟BDD（Behavier Drive

Spring Boot專案中使用事件派發器模式

在專案開發中，會遇到如下情形：我們自己的服務訂閱、接收來自訊息佇列或者客戶端的事件和請求，基於不同的事件採取對應的行動，這種情況下適合應用派發器模式。

Spring Boot實戰（十）：使用Docker部署Spring Boot專案

本文使用Docker部署Spring Boot專案。部署之前需要環境中已經安裝Docker和Maven（用於打包），所以本文先進行安裝Docker和Maven；接著搭建一個Spring Boot專案，使其支援Docker部署；最後進行部署和測試。

Spring Boot實戰（一）：只需兩步！Eclipse+Maven快速構建第一個Spring Boot專案

隨著使用Spring進行開發的個人和企業越來越多，Spring從一個單一簡潔的框架變成了一個大而全的開源軟體，最直觀的變化就是Spring需要引入的配置也越來越多。配置繁瑣，容易出錯，讓人無比頭疼，簡化Spring配置簡直可