我終于決定要放棄 okhttp、httpClient，選擇了這個(gè)牛逼的神仙工具！賊爽

程序員的成長(zhǎng)之路

互聯(lián)網(wǎng)/程序員/技術(shù)/資料共享?

前言

功能特性

• 自定義注入OkHttpClient
• 注解式攔截器
• 連接池管理
• 日志打印
• 請(qǐng)求重試
• 錯(cuò)誤解碼器
• 全局?jǐn)r截器
• 熔斷降級(jí)
• 微服務(wù)之間的HTTP調(diào)用
• 調(diào)用適配器
• 數(shù)據(jù)轉(zhuǎn)換器

快速使用

引入依賴

@RetrofitClient(baseUrl = "${test.baseUrl}")public interface HttpApi {
    @GET("person")    Result getPerson(@Query("id") Long id);}

注入使用

retrofit:  enable-response-call-adapter: true  # 啟用日志打印  enable-log: true  # 連接池配置  pool:    test1:      max-idle-connections: 3      keep-alive-second: 100    test2:      max-idle-connections: 5      keep-alive-second: 50  # 禁用void返回值類型  disable-void-return-type: false  # 日志打印攔截器  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor  # 請(qǐng)求重試攔截器  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor  # 全局轉(zhuǎn)換器工廠  global-converter-factories:    - retrofit2.converter.jackson.JacksonConverterFactory  # 全局調(diào)用適配器工廠  global-call-adapter-factories:    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory  # 是否啟用熔斷降級(jí)  enable-degrade: true  # 熔斷降級(jí)實(shí)現(xiàn)方式  degrade-type: sentinel  # 熔斷資源名稱解析器  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

高級(jí)功能

自定義注入OkHttpClient

@Componentpublic 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進(jìn)行標(biāo)注

@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)@Documented@InterceptMarkpublic @interface Sign {    /**     * 密鑰key     * 支持占位符形式配置。     *     * @return     */    String accessKeyId();
    /**     * 密鑰     * 支持占位符形式配置。     *     * @return     */    String accessKeySecret();
    /**     * 攔截器匹配路徑     *     * @return     */    String[] include() default {"/**"};
    /**     * 攔截器排除匹配，排除指定路徑攔截     *     * @return     */    String[] exclude() default {};
    /**     * 處理該注解的攔截器類     * 優(yōu)先從spring容器獲取對(duì)應(yīng)的Bean，如果獲取不到，則使用反射創(chuàng)建一個(gè)！     *     * @return     */    Classextends BasePathMatchInterceptor> handler() default SignInterceptor.class;}

1. 自定義攔截注解必須使用?@InterceptMark標(biāo)記。
2. 注解中必須包括?include()、exclude()、handler()屬性信息。

實(shí)現(xiàn)SignInterceptor

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

連接池管理

1. 配置連接池。

   @RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")   public interface HttpApi {          @GET("person")       Result getPerson(@Query("id") Long id);   }

日志打印

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:  # 請(qǐng)求重試攔截器  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

錯(cuò)誤解碼器

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

全局網(wǎng)絡(luò)攔截器

熔斷降級(jí)

1. 開啟熔斷降級(jí)功能

<dependency>    <groupId>com.alibaba.cspgroupId>    <artifactId>sentinel-coreartifactId>    <version>1.6.3version>dependency>

2. 配置降級(jí)規(guī)則（可選）

@Slf4j@Servicepublic class HttpDegradeFallback implements HttpDegradeApi {
    @Override    public Result test() {        Result fallback = new Result<>();        fallback.setCode(100)                .setMsg("fallback")                .setBody(1000000);        return fallback;    }}@Slf4j@Servicepublic class HttpDegradeFallbackFactory implements FallbackFactory<HttpDegradeApi> {
    /**     * Returns an instance of the fallback appropriate for the given cause     *     * @param cause fallback cause     * @return 實(shí)現(xiàn)了retrofit接口的實(shí)例。an instance that implements the retrofit interface.     */    @Override    public HttpDegradeApi create(Throwable cause) {        log.error("觸發(fā)熔斷了! ", cause.getMessage(), cause);        return new HttpDegradeApi() {            @Override            public Result test() {                Result fallback = new Result<>();                fallback.setCode(100)                        .setMsg("fallback")                        .setBody(1000000);                return fallback;            }    }}

微服務(wù)之間的HTTP調(diào)用

配置ServiceInstanceChooser為Spring容器Bean

@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class)@Retrypublic interface ApiCountService {
}

調(diào)用適配器和數(shù)據(jù)轉(zhuǎn)碼器

調(diào)用適配器

 ResponseCallAdapterFactory

• 默認(rèn)啟用，可通過(guò)配置?retrofit.enable-response-call-adapter=false關(guān)閉
• 同步執(zhí)行http請(qǐng)求，將響應(yīng)體內(nèi)容適配成?Retrofit.Response返回。
• 如果方法的返回值類型為?Retrofit.Response，則可以使用該適配器。

• Call: 不執(zhí)行適配處理，直接返回?Call對(duì)象
• CompletableFuture: 將響應(yīng)體內(nèi)容適配成?CompletableFuture對(duì)象返回
• Void: 不關(guān)注返回類型可以使用?Void。如果http狀態(tài)碼不是2xx，直接拋錯(cuò)！
• Response: 將響應(yīng)內(nèi)容適配成?Response對(duì)象返回
• 其他任意Java類型：將響應(yīng)體內(nèi)容適配成一個(gè)對(duì)應(yīng)的Java類型對(duì)象返回，如果http狀態(tài)碼不是2xx，直接拋錯(cuò)！
  
  

retrofit:  # 全局調(diào)用適配器工廠  global-call-adapter-factories:    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory復(fù)制代碼

數(shù)據(jù)轉(zhuǎn)碼器

• 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
• JAXB: com.squareup.retrofit2:converter-jaxb

retrofit:  # 全局轉(zhuǎn)換器工廠  global-converter-factories:    - retrofit2.converter.jackson.JacksonConverterFactory

總結(jié)

推薦閱讀：

干掉 RESTful API ！

IDEA 上位？不！Eclipse Theia 1.0 發(fā)布！

微信掃描二維碼，關(guān)注我的公眾號(hào)

朕已閱?