Android OkHttp + Retrofit 取消请求的方法

本贴最后更新于 1864 天前,其中的信息可能已经时移世改

[本文链接](https://rustfisher.com/2019/06/26/Android/Android-OkHttp_Retrofit_cancel_request/

前言

在某一个界面,用户发起了一个网络请求,因为某种原因用户在网络请求完成前离开了当前界面,比较好的做法是取消这个网络请求。对于 OkHttp 来说,具体是调用 Callcancel 方法。

如何找到这一个网络请求并取消掉它呢?

操作大致分为 3 步。第一步,在建立请求时,给请求(request)添加标记;第二步,根据标记,找到请求;最后,取消这个请求。

OkHttp 中的 tag

要取消一个请求,OkHttp 中可以使用 cancel 方法,参考

OkHttp 的 request 对象有 tag。可以根据 tag 来标示请求。参考 Stack Overflow

    //Set tags for your requests when you build them:
    Request request = new Request.Builder().
    url(url).tag("requestKey").build();

    //When you want to cancel:
    //A) go through the queued calls and cancel if the tag matches:
    for (Call call : mHttpClient.dispatcher().queuedCalls()) {
        if (call.request().tag().equals("requestKey"))
            call.cancel();
    }

    //B) go through the running calls and cancel if the tag matches:
    for (Call call : mHttpClient.dispatcher().runningCalls()) {
        if (call.request().tag().equals("requestKey"))
            call.cancel();
    }

Retrofit 中并没有显示地提供取消请求的接口。2018 年时 Retrofit 仍未提供直接访问 call 对象的方法
那么如何找到目标网络请求呢?

Retrofit 加入自定义 header

给每个与页面(Activity,Fragment)相关的 request 加入自定义 header,参考
给 OkHttpClient 添加拦截器。标记出页面的生存状态。如果页面销毁了,则取消对应的 request。

以 GithubOnAndroid 项目为例,https://github.com/RustFisher/GithubOnAndroid

添加标记

持有一个 ConcurrentHashMap<String, Boolean> 来标记页面存活状态。

    private static ConcurrentHashMap<String, Boolean> actLiveMap = new ConcurrentHashMap<>(); // 标记Activity是否存活

    public static void markPageAlive(String actName) {
        actLiveMap.put(actName, true);
    }

    public static void markPageDestroy(String actName) {
        actLiveMap.put(actName, false);
    }

Activity 中登记界面状态

给当前 Activity 起名字。每个 Activity 的标记名必须唯一。

private static final String MY_ACT_NAME = "xxx1Activity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        NetworkCenter.markPageAlive(MY_ACT_NAME);
        // ...
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        NetworkCenter.markPageDestroy(MY_ACT_NAME);
        // ...
    }

OkHttpClient 添加拦截器

给 OkHttpClient 添加拦截器,在拦截器中检查页面的存活情况。
检查后,把这个自定义 header 移除掉。

    public static final String HEADER_ACT_NAME = "Activity-Name"; // 标记Activity界面名字

    private Interceptor lifeInterceptor = new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request request = chain.request();
            String actName = request.header(HEADER_ACT_NAME);
            if (!TextUtils.isEmpty(actName)) {
                Log.d(TAG, "lifeInterceptor: actName: " + actName);
                Boolean actLive = actLiveMap.get(actName);
                if (actLive == null || !actLive) {
                    chain.call().cancel();
                    Log.d(TAG, "lifeInterceptor: 取消请求, actName: " + actName);
                } else {
                    Log.d(TAG, "lifeInterceptor: 发起请求, actName: " + actName);
                }
            }
            Request newRequest = request.newBuilder().removeHeader(HEADER_ACT_NAME).build();
            return chain.proceed(newRequest);
        }
    };


OkHttpClient = new OkHttpClient.Builder()
        .readTimeout(10, TimeUnit.SECONDS)
        .connectTimeout(10, TimeUnit.SECONDS)
        .addInterceptor(lifeInterceptor) // 添加拦截器
        .build();

call.cancel()后,不会再走 Retrofit 的 subscribe 方法。

添加 header

    @GET("users/{owner}/repos")
    Observable<List<UserRepo>> userRepo(
            @Header(NetworkCenter.HEADER_ACT_NAME) @Nullable String actName,
            @Path("owner") String owner,
            @Query("sort") String sortType);
  • Android

    Android 是一种以 Linux 为基础的开放源码操作系统,主要使用于便携设备。2005 年由 Google 收购注资,并拉拢多家制造商组成开放手机联盟开发改良,逐渐扩展到到平板电脑及其他领域上。

    334 引用 • 323 回帖 • 1 关注
  • OkHttp

    OkHttp 是一款 HTTP & HTTP/2 客户端库,专为 Android 和 Java 应用打造。

    16 引用 • 6 回帖 • 62 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...