Merge pull request #12 from LianjiaTech/develop

Develop

Author: chentianming11

README.md

@@ -5,16 +5,18 @@
 [![Build Status](https://api.travis-ci.com/LianjiaTech/retrofit-spring-boot-starter.svg?branch=master)](https://travis-ci.com/github/LianjiaTech/retrofit-spring-boot-starter)
 [![Maven central](https://maven-badges.herokuapp.com/maven-central/com.github.lianjiatech/retrofit-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.lianjiatech/retrofit-spring-boot-starter)
 [![GitHub release](https://img.shields.io/github/v/release/lianjiatech/retrofit-spring-boot-starter.svg)](https://github.com/LianjiaTech/retrofit-spring-boot-starter/releases)
-[![Author](https://img.shields.io/badge/Author-%E9%99%88%E6%B7%BB%E6%98%8E-orange.svg?style=flat-square)](https://juejin.im/user/3562073404738584/posts)
+[![License](https://img.shields.io/badge/JDK-1.8+-4EB1BA.svg)](https://docs.oracle.com/javase/8/docs/index.html)
+[![License](https://img.shields.io/badge/springboot-1.x+-green.svg)](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/)
+[![Author](https://img.shields.io/badge/Author-chentianming-orange.svg?style=flat-square)](https://juejin.im/user/3562073404738584/posts)
 [![QQ-Group](https://img.shields.io/badge/QQ%E7%BE%A4-806714302-orange.svg?style=flat-square) ](https://img.ljcdn.com/hc-picture/6302d742-ebc8-4649-95cf-62ccf57a1add)
 
-众所周知，`Retrofit`是适用于`Android`和`Java`且类型安全的HTTP客户端，其最大的特性的是**支持通过`接口`的方式发起HTTP请求**；而`spring-boot`是使用最广泛的Java开发框架。但是`Retrofit`官方没有支持与`spring-boot`框架快速整合，从而加大了在`spring-boot`框架中引入`Retrofit`的难度。
+> 众所周知，`Retrofit`是适用于`Android`和`Java`且类型安全的HTTP客户端，其最大的特性的是**支持通过`接口`的方式发起HTTP请求**。而`spring-boot`是使用最广泛的Java开发框架，但是`Retrofit`官方没有支持与`spring-boot`框架快速整合，因此我们开发了`retrofit-spring-boot-starter`。
 
-**`retrofit-spring-boot-starter`实现了`Retrofit`与`spring-boot`框架快速整合，并且支持了部分功能增强，从而极大的简化`spring-boot`项目下`http`接口调用开发**。
+**`retrofit-spring-boot-starter`实现了`Retrofit`与`spring-boot`框架快速整合，并且支持了诸多功能增强，极大简化开发**。
 
-<!--more-->
+| [快速使用](#快速使用) | [注解式拦截器](#注解式拦截器) | [连接池管理](#连接池管理) | [日志打印](#日志打印) | [异常信息格式化](#Http异常信息格式化器) | [请求重试](#请求重试) |[全局拦截器](#全局拦截器) | [调用适配器](#调用适配器) | [数据转换器](#数据转码器) |
 
-> 支持`spring-boot 1.x/2.x`；支持`Java8`及以上版本。
+<!--more-->
 
 ## 快速使用
 
@@ -24,7 +26,7 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.0.4</version>
+    <version>2.1.0</version>
 </dependency>
 ```
 
@@ -101,6 +103,7 @@ public class TestService {
 | pool | | 连接池配置 |
 | disable-void-return-type | false | 禁用java.lang.Void返回类型 |
 | http-exception-message-formatter | DefaultHttpExceptionMessageFormatter | Http异常信息格式化器 |
+| retry-interceptor | DefaultRetryInterceptor | 请求重试拦截器 |
 
 `yml`配置方式：
 
@@ -126,6 +129,8 @@ retrofit:
   logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
   # Http异常信息格式化器
   http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter
+  # 请求重试拦截器
+  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor
 ```
 
 ## 高级功能
@@ -187,7 +192,7 @@ public interface HttpApi {
 2. 继承`BasePathMatchInterceptor`编写拦截处理器
 3. 接口上使用自定义拦截注解；
 
-例如我们需要**在请求头里面动态加入`accessKeyId`、`accessKeySecret`签名信息才能正常发起http请求**，这个时候可以**自定义一个加签拦截器注解`@Sign`**来实现。下面以自定义`@Sign`拦截注解为例进行说明。
+例如我们需要**在请求头里面动态加入`accessKeyId`、`accessKeySecret`签名信息才能正常发起http请求**，这个时候**可以自定义一个加签拦截器注解`@Sign`来实现**。下面以自定义`@Sign`拦截注解为例进行说明。
 
 
 #### 自定义`@Sign`注解
@@ -349,7 +354,43 @@ retrofit:
   http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter
 ```
 
-## 调用适配器 CallAdapter
+### 请求重试
+
+`retrofit-spring-boot-starter`支持请求重试功能，只需要在接口或者方法上加上`@Retry`注解即可。**`@Retry`支持重试次数`maxRetries`、重试时间间隔`intervalMs`以及重试规则`retryRules`配置**。重试规则支持三种配置：
+
+1. `RESPONSE_STATUS_NOT_2XX`：响应状态码不是`2xx`时执行重试；
+2. `OCCUR_IO_EXCEPTION`：发生IO异常时执行重试；
+3. `OCCUR_EXCEPTION`：发生任意异常时执行重试；
+
+默认响应状态码不是`2xx`或者发生IO异常时自动进行重试。需要的话，你也可以继承`BaseRetryInterceptor`实现自己的请求重试拦截器，然后将其配置上去。
+
+```yaml
+retrofit:
+  # 请求重试拦截器
+  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor
+```
+
+### 全局拦截器
+
+如果我们需要对整个系统的的http请求执行统一的拦截处理，可以自定义实现全局拦截器`BaseGlobalInterceptor`, 并配置成`spring`中的`bean`！例如我们需要在整个系统发起的http请求，都带上来源信息。
+
+```java
+@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);
+    }
+}
+```
+
+## 调用适配器和数据转码器
+
+### 调用适配器
 
 `Retrofit`可以通过调用适配器`CallAdapterFactory`将`Call<T>`对象适配成接口方法的返回值类型。`retrofit-spring-boot-starter`扩展2种`CallAdapterFactory`实现：
 
@@ -422,7 +463,7 @@ retrofit:
 
 > 自定义配置的`CallAdapter.Factory`优先级更高！
 
-## 数据转码器 Converter
+### 数据转码器
 
 `Retrofit`使用`Converter`将`@Body`注解标注的对象转换成请求体，将响应体数据转换成一个`Java`对象，可以选用以下几种`Converter`：
 
@@ -440,24 +481,6 @@ retrofit:
 > 自定义配置的`Converter.Factory`优先级更高！
 
 
-## 全局拦截器 BaseGlobalInterceptor
-
-如果我们需要对整个系统的的http请求执行统一的拦截处理，可以自定义实现全局拦截器`BaseGlobalInterceptor`, 并配置成`spring`中的`bean`！例如我们需要在整个系统发起的http请求，都带上来源信息。
-
-```java
-@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);
-    }
-}
-```
-
 ## 其他功能示例
 
 ### 上传文件示例
@@ -493,13 +516,6 @@ Void upload(@Part MultipartBody.Part file);
 
 ```
 
-### TODO
-
-- [X] 考虑使用springboot JacksonAutoConfiguration提供的ObjectMapper替代自定义的
-- [ ] 缓存支持：支持客户端内存级别缓存，降低调用接口频率
-- [ ] BasePathMatchInterceptor自定义Scope，减少内存占用
-- [ ] 整合熔断降级
-
 ## 反馈建议
 
 如有任何问题，欢迎提issue或者加QQ群反馈。

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.0.4</version>
+    <version>2.1.0</version>
 
     <name>retrofit-spring-boot-starter</name>
     <description>retrofit-spring-boot-starter</description>

src/main/java/com/github/lianjiatech/retrofit/spring/boot/annotation/RetrofitClient.java

@@ -52,6 +52,7 @@
 
     /**
      * 针对当前接口是否启用日志打印
+     *
      * @return
      */
     boolean enableLog() default true;

src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitAutoConfiguration.java

@@ -8,6 +8,7 @@
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseHttpExceptionMessageFormatter;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.HttpExceptionMessageFormatterInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import okhttp3.ConnectionPool;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -94,6 +95,10 @@ public RetrofitConfigBean retrofitConfigBean(@Autowired ObjectMapper objectMappe
         Collection<BaseGlobalInterceptor> globalInterceptors = getBeans(BaseGlobalInterceptor.class);
         retrofitConfigBean.setGlobalInterceptors(globalInterceptors);
 
+        // retryInterceptor
+        Class<? extends BaseRetryInterceptor> retryInterceptor = retrofitProperties.getRetryInterceptor();
+        retrofitConfigBean.setRetryInterceptor(retryInterceptor.newInstance());
+
         return retrofitConfigBean;
     }
 

src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitConfigBean.java

@@ -1,6 +1,7 @@
 package com.github.lianjiatech.retrofit.spring.boot.config;
 
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.HttpExceptionMessageFormatterInterceptor;
 import okhttp3.ConnectionPool;
 import retrofit2.CallAdapter;
@@ -27,6 +28,8 @@ public class RetrofitConfigBean {
 
     private Collection<BaseGlobalInterceptor> globalInterceptors;
 
+    private BaseRetryInterceptor retryInterceptor;
+
     public RetrofitProperties getRetrofitProperties() {
         return retrofitProperties;
     }
@@ -74,4 +77,12 @@ public Collection<BaseGlobalInterceptor> getGlobalInterceptors() {
     public void setGlobalInterceptors(Collection<BaseGlobalInterceptor> globalInterceptors) {
         this.globalInterceptors = globalInterceptors;
     }
+
+    public BaseRetryInterceptor getRetryInterceptor() {
+        return retryInterceptor;
+    }
+
+    public void setRetryInterceptor(BaseRetryInterceptor retryInterceptor) {
+        this.retryInterceptor = retryInterceptor;
+    }
 }

src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitProperties.java

@@ -3,10 +3,8 @@
 
 import com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory;
 import com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseHttpExceptionMessageFormatter;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseLoggingInterceptor;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.interceptor.*;
+import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 import java.util.LinkedHashMap;
@@ -50,6 +48,12 @@ public class RetrofitProperties {
      */
     private Class<? extends BaseHttpExceptionMessageFormatter> httpExceptionMessageFormatter = DefaultHttpExceptionMessageFormatter.class;
 
+
+    /**
+     * 请求重试拦截器
+     */
+    private Class<? extends BaseRetryInterceptor> retryInterceptor = BaseRetryInterceptor.class;
+
     public Class<? extends BaseHttpExceptionMessageFormatter> getHttpExceptionMessageFormatter() {
         return httpExceptionMessageFormatter;
     }
@@ -115,4 +119,12 @@ public boolean isDisableVoidReturnType() {
     public void setDisableVoidReturnType(boolean disableVoidReturnType) {
         this.disableVoidReturnType = disableVoidReturnType;
     }
+
+    public Class<? extends BaseRetryInterceptor> getRetryInterceptor() {
+        return retryInterceptor;
+    }
+
+    public void setRetryInterceptor(Class<? extends BaseRetryInterceptor> retryInterceptor) {
+        this.retryInterceptor = retryInterceptor;
+    }
 }

src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/RetrofitFactoryBean.java

@@ -4,10 +4,7 @@
 import com.github.lianjiatech.retrofit.spring.boot.annotation.RetrofitClient;
 import com.github.lianjiatech.retrofit.spring.boot.config.RetrofitConfigBean;
 import com.github.lianjiatech.retrofit.spring.boot.config.RetrofitProperties;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseLoggingInterceptor;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BasePathMatchInterceptor;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.HttpExceptionMessageFormatterInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.interceptor.*;
 import com.github.lianjiatech.retrofit.spring.boot.util.BeanExtendUtils;
 import okhttp3.ConnectionPool;
 import okhttp3.Interceptor;
@@ -146,6 +143,10 @@ private synchronized OkHttpClient getOkHttpClient(Class<?> retrofitClientInterfa
         if (httpExceptionMessageFormatterInterceptor != null) {
             okHttpClientBuilder.addInterceptor(httpExceptionMessageFormatterInterceptor);
         }
+        // 请求重试拦截器
+        Interceptor retryInterceptor = retrofitConfigBean.getRetryInterceptor();
+        okHttpClientBuilder.addInterceptor(retryInterceptor);
+
         return okHttpClientBuilder.build();
     }
 

src/main/java/com/github/lianjiatech/retrofit/spring/boot/interceptor/HttpExceptionMessageFormatterInterceptor.java

@@ -8,6 +8,7 @@
 
 /**
  * http异常信息格式化
+ *
  * @author 陈添明
  */
 public class HttpExceptionMessageFormatterInterceptor implements Interceptor {

src/main/java/com/github/lianjiatech/retrofit/spring/boot/retry/BaseRetryInterceptor.java

@@ -0,0 +1,67 @@
+package com.github.lianjiatech.retrofit.spring.boot.retry;
+
+import okhttp3.Interceptor;
+import okhttp3.Request;
+import okhttp3.Response;
+import retrofit2.Invocation;
+
+import java.io.IOException;
+import java.lang.reflect.Method;
+
+/**
+ * 请求重试拦截器
+ *
+ * @author 陈添明
+ */
+public abstract class BaseRetryInterceptor implements Interceptor {
+
+
+    private static final int LIMIT_RETRIES = 10;
+
+    @Override
+    public Response intercept(Chain chain) throws IOException {
+        Request request = chain.request();
+        Invocation invocation = request.tag(Invocation.class);
+        assert invocation != null;
+        Method method = invocation.method();
+        // 获取重试配置
+        Retry retry;
+        if (method.isAnnotationPresent(Retry.class)) {
+            retry = method.getAnnotation(Retry.class);
+        } else {
+            Class<?> declaringClass = method.getDeclaringClass();
+            retry = declaringClass.getAnnotation(Retry.class);
+        }
+        if (retry == null) {
+            // 不用重试
+            return chain.proceed(request);
+        }
+        // 重试
+        int maxRetries = retry.maxRetries();
+        int intervalMs = retry.intervalMs();
+        RetryRule[] retryRules = retry.retryRules();
+        // 最多重试10次
+        maxRetries = maxRetries > LIMIT_RETRIES ? LIMIT_RETRIES : maxRetries;
+        try {
+            return retryIntercept(maxRetries, intervalMs, retryRules, chain);
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+
+    /**
+     * 执行可重试请求
+     * 这里访问级别设置为protected，可方便业务个性化扩展
+     *
+     * @param maxRetries 最大重试次数
+     * @param intervalMs 重试时间间隔
+     * @param retryRules 重试规则
+     * @param chain      执行链
+     * @return 请求响应
+     * @throws IOException 执行IO异常
+     * @throws InterruptedException 中断异常
+     */
+    protected abstract Response retryIntercept(int maxRetries, int intervalMs, RetryRule[] retryRules, Chain chain) throws IOException, InterruptedException;
+
+}