掃二維碼與項目經(jīng)理溝通
我們在微信上24小時期待你的聲音
解答本文疑問/技術(shù)咨詢/運(yùn)營咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流
大家都知道okhttp是一款由square公司開源的java版本http客戶端工具。實際上，square公司還開源了基于okhttp進(jìn)一步封裝的retrofit工具，用來支持通過接口的方式發(fā)起http請求。
臨縣ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場景，ssl證書未來市場廣闊！成為成都創(chuàng)新互聯(lián)的ssl證書銷售渠道，可以享受市場價格4-6折優(yōu)惠！如果有意向歡迎電話聯(lián)系或者加微信：18982081108（備注：SSL證書合作）期待與您的合作！
如果你的項目中還在直接使用RestTemplate或者okhttp，或者基于它們封裝的HttpUtils，那么你可以嘗試使用Retrofit。
retrofit-spring-boot-starter實現(xiàn)了Retrofit與spring-boot框架快速整合，并且支持了部分功能增強(qiáng)，從而極大的簡化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)定。
項目源碼：??https://github.com/LianjiaTech/retrofit-spring-boot-starter??
com.github.lianjiatech
retrofit-spring-boot-starter
2.0.2
你可以給帶有 @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);
}
}
接口必須使用@RetrofitClient注解標(biāo)記！
http相關(guān)注解可參考官方文檔：??https://square.github.io/retrofit/??
@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {
@GET("person")
Result getPerson(@Query("id") Long id);
}
將接口注入到其它Service中即可使用。
@Service
public class TestService {
@Autowired
private HttpApi httpApi;
public void test() {
// 通過httpApi發(fā)起http請求
}
}
只要通過上述幾個步驟，就能實現(xiàn)通過接口發(fā)送http請求了，真的很簡單。如果你在spring-boot項目里面使用過mybatis，相信你對這種使用方式會更加熟悉。
接下來我們繼續(xù)介紹一下retrofit-spring-boot-starter更高級一點(diǎn)的功能。
很多時候，我們希望某個接口下的某些http請求執(zhí)行統(tǒng)一的攔截處理邏輯。這個時候可以使用注解式攔截器。使用的步驟主要分為2步：
下面以給指定請求的url后面拼接timestamp時間戳為例，介紹下如何使用注解式攔截器。
@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);
}
}
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {
@GET("person")
Result getPerson(@Query("id") Long id);
@POST("savePerson")
Result savePerson(@Body Person person);
}
上面的@Intercept配置表示：攔截HttpApi接口下/api/**路徑下（排除/api/test/savePerson）的請求，攔截處理器使用TimeStampInterceptor。
有的時候，我們需要在攔截注解動態(tài)傳入一些參數(shù)，然后再執(zhí)行攔截的時候需要使用這個參數(shù)。這種時候，我們可以擴(kuò)展實現(xiàn)自定義攔截注解。
自定義攔截注解必須使用@InterceptMark標(biāo)記，并且注解中必須包括include()、exclude()、handler()屬性信息。使用的步驟主要分為3步：
例如我們需要在請求頭里面動態(tài)加入accessKeyId、accessKeySecret簽名信息才能正常發(fā)起http請求，這個時候可以**自定義一個加簽攔截器注解@Sign**來實現(xiàn)。下面以自定義@Sign攔截注解為例進(jìn)行說明。
@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 handler() default SignInterceptor.class;
}
擴(kuò)展自定義攔截注解有以下2點(diǎn)需要注意：
@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字段值會依據(jù)@Sign注解的accessKeyId()和accessKeySecret()值自動注入，如果@Sign指定的是占位符形式的字符串，則會取配置屬性值進(jìn)行注入。另外，accessKeyId和accessKeySecret字段必須提供setter方法。
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {
@GET("person")
Result getPerson(@Query("id") Long id);
@POST("savePerson")
Result savePerson(@Body Person person);
}
這樣就能在指定url的請求上，自動加上簽名信息了。
默認(rèn)情況下，所有通過Retrofit發(fā)送的http請求都會使用max-idle-connections=5 keep-alive-second=300的默認(rèn)連接池。
當(dāng)然，我們也可以在配置文件中配置多個自定義的連接池，然后通過@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(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {
@GET("person")
Result getPerson(@Query("id") Long id);
}
很多情況下，我們希望將http請求日志記錄下來。通過@RetrofitClient的logLevel和logStrategy屬性，您可以指定每個接口的日志打印級別以及日志打印策略。
retrofit-spring-boot-starter支持了5種日志打印級別(ERROR, WARN, INFO, DEBUG, TRACE)，默認(rèn)INFO；支持了4種日志打印策略（NONE, BASIC, HEADERS, BODY），默認(rèn)BASIC。
4種日志打印策略含義如下：
retrofit-spring-boot-starter默認(rèn)使用了DefaultLoggingInterceptor執(zhí)行真正的日志打印功能，其底層就是okhttp原生的HttpLoggingInterceptor。
當(dāng)然，你也可以自定義實現(xiàn)自己的日志打印攔截器，只需要繼承BaseLoggingInterceptor（具體可以參考DefaultLoggingInterceptor的實現(xiàn)），然后在配置文件中進(jìn)行相關(guān)配置即可。
retrofit:
# 日志打印攔截器
logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
當(dāng)出現(xiàn)http請求異常時，原始的異常信息可能閱讀起來并不友好，因此retrofit-spring-boot-starter提供了Http異常信息格式化器，用來美化輸出http請求參數(shù)，默認(rèn)使用DefaultHttpExceptionMessageFormatter進(jìn)行請求數(shù)據(jù)格式化。
你也可以進(jìn)行自定義，只需要繼承BaseHttpExceptionMessageFormatter，再進(jìn)行相關(guān)配置即可。
retrofit:
# Http異常信息格式化器
http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter
Retrofit可以通過調(diào)用適配器CallAdapterFactory將Call