Retrofit实现重试机制(自定义Interceptor或封装callback)

最近在一个项目需求中,涉及到网络请求能有重试机制,而我们项目中网络请求使用的是Retrofit框架,以前也没做过这种,老大提示了下说可以用拦截器Interceptor或者封装Callback实现。

自定义Interceptor

废话少说,直接上代码

public class OkHttpRetryInterceptor implements Interceptor{

    private int mMaxRetryCount;
    private long mRetryInterval;

    public OkHttpRetryInterceptor(int maxRetryCount, long retryInterval) {
        mMaxRetryCount = maxRetryCount;
        mRetryInterval = retryInterval;
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Response response = doRequest(chain, request);
        int retryNum = 1;
        while(((response==null)||response.isSuccessful())&&retryNum<=mMaxRetryCount){
            try {
                Thread.sleep(mRetryInterval);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }C
            retryNum++;
            response = doRequest(chain, request);

        }
        return response;
    }

    private Response doRequest(Chain chain, Request request) {
        try {
            return chain.proceed(request);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    public static class Builder {

        private int mRetryCount = 1;
        private long mRetryInterval = 1000;

        public Builder buildRetryCount(int retryCount){
            this.mRetryCount = retryCount;
            return this;
        }

        public Builder buildRetryInterval(long retryInterval){
            this.mRetryInterval = retryInterval;
            return this;
        }

        public OkHttpRetryInterceptor build(){
            return new OkHttpRetryInterceptor(mRetryCount,mRetryInterval);
        }

    }

}

OkHttpClient okHttpClient = new OkHttpClient.Builder()
            .addInterceptor(new OkHttpRetryInterceptor.Builder()
                    .buildRetryCount(retryCount)
                    .buildRetryInterval(retryInterval)
                    .build())
            .build();

思路解释:

  1. 自定义了一个OkHttpRetryInterceptor类,实现Interceptor接口
  2. 定义mMaxRetryCount ,mRetryInterval 两个成员变量用于保存最大重试次数和重试间隔,并利用Build模式对外提供自定义这两个变量的接口。
  3. 重试机制最核心的部分是实现了Interceptor接口的intercept(Chain chain)方法,该方法提供了一个Chain类型的对象,Chain对象中可以获取到Request对象,而调用Chain对象的proceed方法(该方法接收一个Request对象)就可发起一次网络请求,该方法返回Response对象。
  4. 通过上述返回的Response对象可判断请求结果,如果失败则利用Thread.sleep相应的间隔时间之后,再调用Chain对象的proceed方法再发起一次,如此循环到请求成功或最大重试次数之后返回。
  5. 最后在OkHttpClient的对象构造时加入自定义的OkHttpRetryInterceptor即实现了重试机制。

封装Callback

public abstract class RetryCallback<T> implements Callback<T> {

    private static final String TAG = RetryCallback.class.getSimpleName();

    private int mRetryCount;
    private long mRetryInterval;

    private int mCurrentRetryCount;

    private boolean isExecuting;

    private Call<T> mCall;

    private Timer timer = new Timer();

    public RetryCallback(Call<T> call, int retryCount, long retryInterval) {
        isExecuting = true;
        mCall = call;
        mRetryCount = retryCount;
        mRetryInterval = retryInterval;
    }

    @Override
    public final void onResponse(@NonNull Call<T> call, @NonNull Response<T> response) {
        MLog.i(TAG,"onResponse");
        isExecuting = false;
        if (!response.isSuccessful() && mCurrentRetryCount < mRetryCount) {
            mCurrentRetryCount++;
            retryRequest(call);
        } else {
            onRequestResponse(call, response);
        }
    }

    @Override
    public final void onFailure(@NonNull Call<T> call, @NonNull Throwable t) {
        MLog.i(TAG,"onFailure");
        isExecuting = false;
        if (mCurrentRetryCount < mRetryCount) {
            mCurrentRetryCount++;
            retryRequest(call);
        } else {
            onRequestFail(call, t);
        }
    }

    private void retryRequest(final Call<T> call) {
        MLog.i(TAG,"retryRequest");
        onStartRetry();
        TimerTask timerTask = new TimerTask() {
            @Override
            public void run() {
                synchronized (RetryCallback.this){
                    mCall = call.clone();
                    mCall.enqueue(RetryCallback.this);
                    isExecuting = true;
                }
            }
        };
        timer.schedule(timerTask, mRetryInterval);

    }

    public void cancelCall(){
        synchronized (this){
            if (!isExecuting){
                timer.cancel();
            }else {
                mCall.cancel();
            }
        }
    }

    public abstract void onRequestResponse(Call call, Response response);

    public abstract void onRequestFail(Call call, Throwable t);

    public abstract void onStartRetry();
}

这种方式是基于在Retrofit的异步请求方法enqueue中,需要传入的一个Callback类型的对象参数。

在Callback接口中有两个方法,onResponse和onFailure。在这两个方法中都能拿到一个Call类型的对象,该对象其实就是最开始发起请求时构造的Call对象,用以再次发起网络请求,这就是该方式实现重试机制的基础。

当通过Callback的两个回调接口判断请求失败时,则利用Timer延时相应的重试间隔,这里需要注意,因为一个Call对象只能使用一次,回调中拿到的Call对象是前一次请求使用过的,于是就需要调用Call的clone方法克隆出一个相同的Call对象。再调用Call的enqueue方法发起请求,这样就实现了重试机制。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容

  • 简介 OkHttp 是一款用于 Android 和 Java 的网络请求库,也是目前 Android 中最火的一个...
    然则阅读 1,152评论 1 39
  • 这篇文章主要讲 Android 网络请求时所使用到的各个请求库的关系,以及 OkHttp3 的介绍。(如理解有误,...
    小庄bb阅读 1,140评论 0 4
  • OkHttp解析系列 OkHttp解析(一)从用法看清原理OkHttp解析(二)网络连接OkHttp解析(三)关于...
    Hohohong阅读 20,965评论 4 58
  • 前言 用OkHttp很久了,也看了很多人写的源码分析,在这里结合自己的感悟,记录一下对OkHttp源码理解的几点心...
    Java小铺阅读 1,490评论 0 13
  • 『古微』 剑入鞘,声若鸣泣。 不曾取下的剑穗,明黄已暗。剑穗上的流苏,他还记得,是她亲手缠上的。 但是关于她,他却...
    乔芷约阅读 233评论 1 4