项目问题-OkHttp请求时偶尔不携带Cookie的问题

  感觉挺奇怪的,公司有两套后台接口,后续开发的接口全部放在新接口里面,都能用。两套后台接口主机相同,就path不同。网络请求框架用的是OkHttp+Retrofit,Cookie也做了持久化。

  然后有一天突然发现有个新接口不能用了,提示需要登录,我一脸懵逼。然后用Stetho查看这个接口请求以及响应数据,一看发现mmp居然没携带Cookie。然后将缓存和Cookie清空然后退出账号重新登陆,结果还是一样,和同事讨论过也没讨论出个结果。

  这个问题也不是说100%出现,只是偶尔出现,不过只要出现,新后台的API全部受影响。所以没办法,再诡异也要解决。

  先是在网上搜索看有没有人碰到这个问题,结果甚至Stack Overflow上都没人提过这个问题,难道我搜索的姿势不对?然后去OkHttp的Github主页上去找别人提的issue,看有没有人反馈过,结果还真没人碰到这个问题,不过在查看issue的过程中swankjesse提到了可以使用Cookie.matches(url) 来check for a domain match。

/*
    Returns true if this cookie should be included on a request to url. 
    In addition to this check callers should also confirm that this cookie has not expired.
*/
public boolean matches(HttpUrl url)

  OkHttp设定了一个Interceptor,可以根据需求决定请求是否携带Cookie。然后调试发现居然是matches()返回了false,Cookie和这个url对应的主机不匹配,所以不会在请求上添加Cookie信息了。我要在你脸上写个惨字

  我不太清楚Cookie是如何匹配的,所以目前我只能先将后台api的Cookie独立缓存到一个集合中,每次请求时先让Cookie自己匹配,如果匹配失败我再检查请求的url是否是公司的后台api,如果是就直接携带,不是就忽略。

update:2018-1-3

  项目中的坑远比我想像中还要深。其实上面那些问题实际上可能不会出现。公司项目中是因为新接口和老接口主要是path不同但是host是相同的。

http://baidu.com/api;
http://baidu.com/2.0/api;

  而且专门为新接口写一个HttpService接口(Retrofit),而且也单独创建了一个OkHttpClient,并且Cookie持久化的类PersistentCookieJar也是单独创建的。因为OkHttp缓存路径以及Cookie保存路径在是同一个位置。

//旧Api相关的
mCookieJar = new PersistentCookieJar(x,x);
mCache = new Cache(new File(dir,"HttpCache"),1024 * 1024 * 100);
mOkHttpClient = new OkHttpClient.Builder()
                            .cache(cache)
                            .cookieJar(cookieJar)
                            .baseUrl("www.example.com/api")
                            .build();
mHttpService = new Retrofit.Builder().client(mOkHttpClient).build();
//新Api相关
mCookieJar = new PersistentCookieJar(x,x);
mCache = new Cache(new File(dir,"HttpCache"),1024 * 1024 * 100);
mOkHttpClient = new OkHttpClient.Builder()
                            .cache(cache)
                            .cookieJar(cookieJar)
                            .baseUrl("www.example.com/2.0/api")
                            .build();
mHttpService = new Retrofit.Builder().client(mOkHttpClient).build();

  理论上两个OkHttp和PersistentCookieJar应该能正常携带Cookie,事实上之前是正常使用的不过在我接盘这个项目的时候就出现了这个问题[喵喵喵?],问题出现概率不高,不过一旦出了这个问题,那么所有的新接口全部受影响。研究了很长时间,把OkHttp的Github上的issue翻了个遍发现每个卵用。后来debug调试发现新接口不是没有携带Cookie而是压根就没有Cookie。然后好好研究分析了一下发现可能的原因是新Api相关的OkHttp在请求时读取保存在本地的Cookie时发生了错误。后来在就Api相关的封装类中提供一个获取PersistentCookieJar和Cache的方法,在创建新Api相关的封装类时用旧Api相关的封装类中的数据来构建,这样问题就真正的解决了。话说回来,这个问题实际上在12月初就发现了,但是一直没找到问题根本。说来说去还是之前的项目开发者挖的坑[微笑中透露着mmp]。

你可能感兴趣的:(项目问题-OkHttp请求时偶尔不携带Cookie的问题)