大家都知道okhttp是一款由square公司開源的java版本http客戶端工具读第。實際上曙博，square公司還開源了基于okhttp進一步封裝的retrofit工具，用來支持通過接口的方式發(fā)起http請求怜瞒。如果你的項目中還在直接使用RestTemplate或者okhttp父泳，或者基于它們封裝的HttpUtils，那么你可以嘗試使用Retrofit吴汪。
retrofit-spring-boot-starter實現(xiàn)了Retrofit與spring-boot框架快速整合惠窄，并且支持了部分功能增強，從而極大的簡化spring-boot項目下http接口調(diào)用開發(fā)浇坐。接下來我們直接通過retrofit-spring-boot-starter睬捶，來看看spring-boot項目發(fā)送http請求有多簡單。
retrofit官方并沒有提供與spring-boot快速整合的starter近刘。retrofit-spring-boot-starter是筆者封裝的擒贸，已在生產(chǎn)環(huán)境使用，非常穩(wěn)定觉渴。
項目源碼：retrofit-spring-boot-starter
引入依賴
com.github.lianjiatech
retrofit-spring-boot-starter
2.0.2
配置@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")
ResultgetPerson(@Query("id")Long?id);
}
注入使用
將接口注入到其它Service中即可使用。
@Service
publicclassTestService{
@Autowired
privateHttpApi?httpApi;
publicvoidtest(){
//?通過httpApi發(fā)起http請求
}
}
只要通過上述幾個步驟踢京，就能實現(xiàn)通過接口發(fā)送http請求了誉碴，真的很簡單。如果你在spring-boot項目里面使用過mybatis瓣距，相信你對這種使用方式會更加熟悉黔帕。接下來我們繼續(xù)介紹一下retrofit-spring-boot-starter更高級一點的功能。
注解式攔截器
很多時候蹈丸，我們希望某個接口下的某些http請求執(zhí)行統(tǒng)一的攔截處理邏輯成黄。這個時候可以使用注解式攔截器。使用的步驟主要分為2步：
繼承BasePathMatchInterceptor編寫攔截處理器逻杖；
接口上使用@Intercept進行標注奋岁。
下面以給指定請求的url后面拼接timestamp時間戳為例，介紹下如何使用注解式攔截器荸百。
繼承BasePathMatchInterceptor編寫攔截處理器
@Component
publicclassTimeStampInterceptorextendsBasePathMatchInterceptor{
@Override
publicResponsedoIntercept(Chain?chain)throwsIOException{
Request?request?=?chain.request();
HttpUrl?url?=?request.url();
longtimestamp?=?System.currentTimeMillis();
HttpUrl?newUrl?=?url.newBuilder()
.addQueryParameter("timestamp",?String.valueOf(timestamp))
.build();
Request?newRequest?=?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")
ResultgetPerson(@Query("id")Long?id);
@POST("savePerson")
ResultsavePerson(@Body?Person?person);
}
上面的@Intercept配置表示：攔截HttpApi接口下/api/**路徑下（排除/api/test/savePerson）的請求闻伶，攔截處理器使用TimeStampInterceptor。
擴展注解式攔截器
有的時候管搪，我們需要在攔截注解動態(tài)傳入一些參數(shù)虾攻，然后再執(zhí)行攔截的時候需要使用這個參數(shù)铡买。這種時候，我們可以擴展實現(xiàn)自定義攔截注解霎箍。自定義攔截注解必須使用@InterceptMark標記奇钞，并且注解中必須包括include()、exclude()漂坏、handler()屬性信息景埃。使用的步驟主要分為3步：
自定義攔截注解
繼承BasePathMatchInterceptor編寫攔截處理器
接口上使用自定義攔截注解；
例如我們需要在請求頭里面動態(tài)加入accessKeyId顶别、accessKeySecret簽名信息才能正常發(fā)起http請求豌骏，這個時候可以自定義一個加簽攔截器注解@Sign來實現(xiàn)趁啸。下面以自定義@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{};
/**
*?處理該注解的攔截器類
*?優(yōu)先從spring容器獲取對應的Bean缤谎，如果獲取不到炊汹，則使用反射創(chuàng)建一個！
*
*@return
*/
Class?handler()defaultSignInterceptor.class;
}
擴展自定義攔截注解有以下2點需要注意：
自定義攔截注解必須使用@InterceptMark標記拴孤。
注解中必須包括include()脾歧、exclude()、handler()屬性信息演熟。
實現(xiàn)SignInterceptor
@Component
publicclassSignInterceptorextendsBasePathMatchInterceptor{
privateString?accessKeyId;
privateString?accessKeySecret;
publicvoidsetAccessKeyId(String?accessKeyId){
this.accessKeyId?=?accessKeyId;
}
publicvoidsetAccessKeySecret(String?accessKeySecret){
this.accessKeySecret?=?accessKeySecret;
}
@Override
publicResponsedoIntercept(Chain?chain)throwsIOException{
Request?request?=?chain.request();
Request?newReq?=?request.newBuilder()
.addHeader("accessKeyId",?accessKeyId)
.addHeader("accessKeySecret",?accessKeySecret)
.build();
returnchain.proceed(newReq);
}
}
上述accessKeyId和accessKeySecret字段值會依據(jù)@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")
ResultgetPerson(@Query("id")Long?id);
@POST("savePerson")
ResultsavePerson(@Body?Person?person);
}
這樣就能在指定url的請求上，自動加上簽名信息了化漆。
連接池管理
默認情況下囤热，所有通過Retrofit發(fā)送的http請求都會使用max-idle-connections=5 keep-alive-second=300的默認連接池。當然获三，我們也可以在配置文件中配置多個自定義的連接池，然后通過@RetrofitClient的poolName屬性來指定使用锨苏。比如我們要讓某個接口下的請求全部使用poolName=test1的連接池疙教，代碼實現(xiàn)如下：
配置連接池。
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")
publicinterfaceHttpApi{
@GET("person")
ResultgetPerson(@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執(zhí)行真正的日志打印功能，其底層就是okhttp原生的HttpLoggingInterceptor窖贤。當然砖顷，你也可以自定義實現(xiàn)自己的日志打印攔截器，只需要繼承BaseLoggingInterceptor（具體可以參考DefaultLoggingInterceptor的實現(xiàn)）赃梧，然后在配置文件中進行相關配置即可滤蝠。
retrofit:
#?日志打印攔截器
??logging-interceptor:com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
Http異常信息格式化器
當出現(xiàn)http請求異常時，原始的異常信息可能閱讀起來并不友好授嘀，因此retrofit-spring-boot-starter提供了Http異常信息格式化器物咳，用來美化輸出http請求參數(shù)，默認使用DefaultHttpExceptionMessageFormatter進行請求數(shù)據(jù)格式化蹄皱。你也可以進行自定義览闰，只需要繼承BaseHttpExceptionMessageFormatter，再進行相關配置即可夯接。
retrofit:
#?Http異常信息格式化器
??http-exception-message-formatter:com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter
調(diào)用適配器 CallAdapter
Retrofit可以通過調(diào)用適配器CallAdapterFactory將Call<T>對象適配成接口方法的返回值類型焕济。retrofit-spring-boot-starter擴展2種CallAdapterFactory實現(xiàn)：
BodyCallAdapterFactory
默認啟用，可通過配置retrofit.enable-body-call-adapter=false關閉
同步執(zhí)行http請求盔几，將響應體內(nèi)容適配成接口方法的返回值類型實例晴弃。
除了Retrofit.Call<T>、Retrofit.Response<T>逊拍、java.util.concurrent.CompletableFuture<T>之外上鞠，其它返回類型都可以使用該適配器。
ResponseCallAdapterFactory
默認啟用芯丧，可通過配置retrofit.enable-response-call-adapter=false關閉
同步執(zhí)行http請求芍阎，將響應體內(nèi)容適配成Retrofit.Response<T>返回。
如果方法的返回值類型為Retrofit.Response<T>缨恒，則可以使用該適配器谴咸。
Retrofit自動根據(jù)方法返回值類型選用對應的CallAdapterFactory執(zhí)行適配處理！加上Retrofit默認的CallAdapterFactory骗露，可支持多種形式的方法返回值類型：
Call<T>: 不執(zhí)行適配處理岭佳，直接返回Call<T>對象
CompletableFuture<T>: 將響應體內(nèi)容適配成CompletableFuture<T>對象返回
Void: 不關注返回類型可以使用Void。如果http狀態(tài)碼不是2xx萧锉，直接拋錯珊随！
Response<T>: 將響應內(nèi)容適配成Response<T>對象返回
其他任意Java類型：將響應體內(nèi)容適配成一個對應的Java類型對象返回，如果http狀態(tài)碼不是2xx，直接拋錯叶洞！
/**
*?Call
*?不執(zhí)行適配處理鲫凶，直接返回Call對象
*@paramid
*@return
*/
@GET("person")
Call>?getPersonCall(@Query("id")?Long?id);
/**
*??CompletableFuture
*??將響應體內(nèi)容適配成CompletableFuture對象返回
*@paramid
*@return
*/
@GET("person")
CompletableFuture>?getPersonCompletableFuture(@Query("id")?Long?id);
/**
*?Void
*?不關注返回類型可以使用Void。如果http狀態(tài)碼不是2xx衩辟，直接拋錯螟炫！
*@paramid
*@return
*/
@GET("person")
VoidgetPersonVoid(@Query("id")Long?id);
/**
*??Response
*??將響應內(nèi)容適配成Response對象返回
*@paramid
*@return
*/
@GET("person")
Response>?getPersonResponse(@Query("id")?Long?id);
/**
*?其他任意Java類型
*?將響應體內(nèi)容適配成一個對應的Java類型對象返回，如果http狀態(tài)碼不是2xx惭婿，直接拋錯不恭！
*@paramid
*@return
*/
@GET("person")
ResultgetPerson(@Query("id")Long?id);
我們也可以通過繼承CallAdapter.Factory擴展實現(xiàn)自己的CallAdapter；然后將自定義的CallAdapterFactory配置成spring的bean财饥！
自定義配置的CallAdapter.Factory優(yōu)先級更高换吧！
數(shù)據(jù)轉(zhuǎn)碼器 Converter
Retrofi使用Converter將@Body注解標注的對象轉(zhuǎn)換成請求體，將響應體數(shù)據(jù)轉(zhuǎn)換成一個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進行序列化轉(zhuǎn)換沾瓦！如果需要使用其它序列化方式，在項目中引入對應的依賴谦炒，再把對應的ConverterFactory配置成spring的bean即可贯莺。
我們也可以通過繼承Converter.Factory擴展實現(xiàn)自己的Converter；然后將自定義的Converter.Factory配置成spring的bean宁改！
自定義配置的Converter.Factory優(yōu)先級更高缕探！
全局攔截器 BaseGlobalInterceptor
如果我們需要對整個系統(tǒng)的的http請求執(zhí)行統(tǒng)一的攔截處理，可以自定義實現(xiàn)全局攔截器BaseGlobalInterceptor, 并配置成spring中的bean还蹲！例如我們需要在整個系統(tǒng)發(fā)起的http請求爹耗，都帶上來源信息。
@Component
publicclassSourceInterceptorextendsBaseGlobalInterceptor{
@Override
publicResponsedoIntercept(Chain?chain)throwsIOException{
Request?request?=?chain.request();
Request?newReq?=?request.newBuilder()
.addHeader("source","test")
.build();
returnchain.proceed(newReq);
}
}
