Android上使用retrofit+okhttp时token失

作者: 镜花水月一梦不觉 | 来源:发表于2016-02-18 18:22 被阅读19894次

提前声明,以下提到的方案并没有去验证过可行性,只是记录一下,未来需要用到的时候,在仔细验证一下。

一般情况下,各个公司的移动端关于登录令牌(token)的设定都各不相同。

可先参考这个链接:https://www.zhihu.com/question/30267006

了解一下,本文大概想说什么。

有些公司服务端是按照oauth设计,比较标准规范,但是有些公司有自己的特定业务,未完全按照oauth来设计。基于本公司的业务逻辑,考虑了一下登录的逻辑以及token的设计。

思路如下:

token即验证令牌,每次请求都带上,refreshToken用来刷新token的,每次请求可以不带上,但是要放在移动端保存。

1.通过username,password获取token和refreshToken

2.token的有效期为2小时,refreshToken的有效期为15天

3.如果服务器端判断token过期,而refreshToken未过期,就返回错误码给客户端,则客户端通过一个特定的接口传入refreshToken参数获取新的token和refreshToken

4.如果连续15天未使用app或者用户修改了密码,则表示refreshToken过期了,则跳到登录界面,重新登录获取token和refreshToken

基于上面的思路,如果服务端走rest风格,移动端(Android)采用retrofit(v2.0+)+okhttp(v2.7.0+)网络请求框架。那么当token过期了,Android端应该如何处理呢?

第一种方案

通过okhttp提供的Authenticator接口,相关资料点击这里 ,但是查看okhttp的源码会发现,只有返回HTTP的状态码为401时,才会使用Authenticator接口,如果服务端设计规范,可以尝试如下方法。

实现Authenticator接口

public class TokenAuthenticator implements Authenticator {

    @Override
    public Request authenticate(Proxy proxy, Response response) throws IOException {
        
        //取出本地的refreshToken
        String refreshToken = "sssgr122222222";

        // 通过一个特定的接口获取新的token,此处要用到同步的retrofit请求
        ApiService service = ServiceManager.getService(ApiService.class);
        Call<String> call = service.refreshToken(refreshToken);
        
        //要用retrofit的同步方式
        String newToken = call.execute().body();

        return response.request().newBuilder()
                .header("token", newToken)
                .build();
    }

    @Override
    public Request authenticateProxy(Proxy proxy, Response response) throws IOException {
        return null;
    }
}

然后给添加给OkHttpClient

OkHttpClient client = new OkHttpClient();
client.setAuthenticator(new TokenAuthenticator());
Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(BASEURL)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .client(client)
                .build();

第一种方案就这样了。

但是,万事不会尽如人意,如果服务端在token过期的时候,不给返回401的HTTP状态码,而是返回如下类型的数据,叫你根据code判断。

{
    "data":"[{"userId":"6b2bb89b68ef4b10988a7c3d089c70cf","userName":"leo","age":"20"},
             {"userId":"a46c3b3b847743649f201e232b5a544d","userName":"李四","age":"30"}]",
    "success":true,
    "msg":"message success"
    "code":401
}

这里要清楚HTTP状态码是指200,404,401这些,而上面的数据中的code是自定义的。如果在token过期时,服务端返回的是如上类型的数据,那么第一种方案就行不通。

第二种方案

通过okhttp的拦截器,okhttp 2.2.0 以后提供了拦截器的功能,相关介绍点击这里

public class TokenInterceptor implements Interceptor {

    private static final Charset UTF8 = Charset.forName("UTF-8");

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        // try the request
        Response originalResponse = chain.proceed(request);

        /**通过如下的办法曲线取到请求完成的数据
         *
         * 原本想通过  originalResponse.body().string()
         * 去取到请求完成的数据,但是一直报错,不知道是okhttp的bug还是操作不当
         *
         * 然后去看了okhttp的源码,找到了这个曲线方法,取到请求完成的数据后,根据特定的判断条件去判断token过期
         */
        ResponseBody responseBody = originalResponse.body();
        BufferedSource source = responseBody.source();
        source.request(Long.MAX_VALUE); // Buffer the entire body.
        Buffer buffer = source.buffer();
        Charset charset = UTF8;
        MediaType contentType = responseBody.contentType();
        if (contentType != null) {
            charset = contentType.charset(UTF8);
        }

        String bodyString = buffer.clone().readString(charset);

        LogUtil.debug("body---------->" + bodyString);

        /***************************************/

        if (response shows expired token){//根据和服务端的约定判断token过期

            //取出本地的refreshToken
            String refreshToken = "sssgr122222222";

            // 通过一个特定的接口获取新的token,此处要用到同步的retrofit请求
            ApiService service = ServiceManager.getService(ApiService.class);
            Call<String> call = service.refreshToken(refreshToken);

            //要用retrofit的同步方式
            String newToken = call.execute().body();


            // create a new request and modify it accordingly using the new token
            Request newRequest = request.newBuilder().header("token", newToken)
                    .build();

            // retry the request

            originalResponse.body().close();
            return chain.proceed(newRequest);
        }

        // otherwise just pass the original response on
        return originalResponse;
    }
}

然后给okhttp设置拦截器

OkHttpClient client = new OkHttpClient();
client.interceptors().add(new TokenInterceptor());
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(BASEURL)
        .addConverterFactory(GsonConverterFactory.create(gson))
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
        .client(getOkHttpClient())
        .build();

第二种方案的思路是通过拦截返回的数据,判断token是否过期,如果过期则进行一次刷新token的操作。

上面2种方案都没有进行实际验证过,希望以后有机会能验证。

完。。。

相关文章

  • Android上使用retrofit+okhttp时token失

    提前声明,以下提到的方案并没有去验证过可行性,只是记录一下,未来需要用到的时候,在仔细验证一下。 一般情况下,各个...

  • Android中 token 的使用

    什么是 token; 为什么要使用 token; 在 Android 中应该如何使用 token;ok,今天的学习...

  • Android token使用

    Android token使用 对于初学者来说,对Token和Session的使用难免会限于困境,开发过程中知道有...

  • token,cookie,session

    Android客户端和服务端如何使用Token和Session Token ,Cookie和Session的区别-...

  • Token,Session,cookie

    Token 参考Android客户端和服务端如何使用Token和Session 1.Token的存在? 如果一个A...

  • 遇到的问题

    1.网络数据使用token加密,当token失效时候,此时发出一个请求,由于网络慢,还未接受到后台返回token失...

  • 彻底理解OkHttp - OkHttp 源码解析及OkHttp的

    OkHttp 现在统治了Android的网络请求领域,最常用的框架是:Retrofit+okhttp。OkHttp...

  • android使用token登录

    步骤:1.客户端登录2.登陆成功后,服务端生成一个token返回给客户端3.客户端收到token后保存到本地,以后...

  • JJWT简介(翻译)

    Java JWT: JSON Web Token for Java and Android JJWT的是在JVM上...

  • Retrofit 源码初探

    现如今,Android开发中,网络层Retrofit+Okhttp组合好像已成标配,身为技术人员,这么火的框架当然...

网友评论

  • c432466413fb:楼主 问下
    originalResponse.body().close();
    return chain.proceed(newRequest);
    重新请求的是需要token的接口还是获取token的接口啊
  • 下雨天的小白鞋:我想问一下,我根据服务器返回code判断token是否过期,跳转到登录界面,可是一个页面有几个请求,就会出现跳转到登录界面几次,这样怎么解决呢?
    4fc0238b5269:@下雨天的小白鞋 并不能解决, 请求都是 同时进行的
    下雨天的小白鞋:@名字真难取1 弹出一个登陆界面马上清空token
    4fc0238b5269:同樣的問題, 有解決方案嗎?
  • username_883c:请问使用第二种拦截器方法,同步刷新token报 NetworkOnMainThreadException要怎么解决?
  • c0433b902f68:不会有重放攻击的问题么
  • 笠原May_:我用interceptor的方式实现了token的更新,但是我的接口回调中收到的response却是token更新之前的response,但是我log打印后发现回调方法确确实实是在return chain.proceed(newRequest)之后才调用到的啊,不知道我到底是哪个环节出了问题
  • Robo_G:博主,我现在的token是作为参数放在body中的,但是body中的数据请求时要加密。那我刷新后的token该怎么重新放到body中?将body中的原始数据先解密,然后修改token?或者有什么其他办法吗?
  • ZHG:并发情况下怎么处理呢?同时调用多个接口,第一个token失效了,在token,还没有刷新的时候,又再一次的刷新token,可是这时 freshToken已经失效了。刷新token失败。这个怎们解决呢?
  • ChenYyi:楼主,我用了第二种方式,但是有一个问题我不知道怎么解决:当有多个请求同时请求,都拦截到了token,过期,这样就会都去走token刷新的代码,请问这种情况怎么优雅的解决呢?
    ChenYyi:多次请求token导致有些请求失败了
  • ac8f59c1189d:楼主新的写法是啥呢 想瞅瞅 我才接触retrofit 我们的token要两步才能获取 ,先获取一个验证码,拿验证码请求 才给token 谢谢
  • 贝克汉姆CC:Request newRequest = request.newBuilder().header("token", newToken)
    .build();
    这段是重新发送请求吗 ,是只要把token传过去就会继续调起之前的请求吗
    贝克汉姆CC:@镜花水月一梦不觉
    if (bodyString.contains("用户token超时")) {
    Gson gson = new Gson();
    BasicBean basicBean = gson.fromJson(bodyString, BasicBean.class);
    mErrodCode = basicBean.getErrorCode();
    if (mErrodCode.equals("-102")) {

    String refreshToken1 = UIUtils.mSp.getString(Constants.REFRESHTOKEN1,"");
    Map<String, String> refreshMap = new HashMap<>();


    refreshMap.put("refreshToken1", UIUtils.jiami(refreshToken1));
    //获取实例
    Retrofit retrofit = new Retrofit.Builder()
    //设置OKHttpClient,如果不设置会提供一个默认的
    .client(new OkHttpClient())
    //设置baseUrl
    .baseUrl(Constants.BASEURL)
    //添加Gson转换器
    .addConverterFactory(GsonConverterFactory.create())
    .build();

    RefereshService service = retrofit.create(RefereshService.class);

    Call<BasicBean> call = service.loadRepo(refreshMap);

    retrofit2.Response<BasicBean> repos = call.execute();
    BasicBean tokenBean = repos.body();
    mAcctionToken = tokenBean.getData().getAcctionToken1();
    UIUtils.mSp.putString(Constants.ACCESSTOKEN1, mAcctionToken);
    String accessToken1 = getNewToken();
    //使用新的Token,创建新的请求
    Request newRequest = chain.request().newBuilder().header("accessToken1",UIUtils.jiami(accessToken1)).build();
    //重新请求
    response.body().close();
    return chain.proceed(newRequest);

    楼主我这样处理可以吗
    贝克汉姆CC:@镜花水月一梦不觉 楼主 这个刷新token的请求是不是必须要同步才可以,我现在重新刷新token的时候发现又重新走一遍拦截器
    镜花水月一梦不觉:就是修改了原来请求中的token值,换成新的
  • 08ef2c1f0143:我验证了 Authenticator 是没有问题的。 这种方法也应该是几种处理方法中最优雅的了。 前提就是和服务端的哥们约定好,遇到token问题统一返回401.
    镜花水月一梦不觉:@行胜于言 是的啊 ,服务端要有相应的配合才能这样干
  • 092532ea333f:这种情况下refreshtoken都是永久的么?
    镜花水月一梦不觉:@WenkChan 仔细看最开始的说明啊,refreshtoken是用来刷新token用的,看你的需求设定时间的,一般生命周期比较长
  • Weavey:我的token不是通过接口去拿的 后台会返回401错误 通过方法一添加获取token的header后 一直没奏效 一直拿不到token 不知道为什么
    镜花水月一梦不觉:@Weavey 试试第二种方式 通过拦截器的 方式,实现自定义
  • 欧阳鹏:按照第二种方式,通过okhttp的拦截器,实现了!
  • khunkk:okhttp + retrofit +rxjava
    rxjava 的Transfromer 来做错误处理 【切面】,处理所有错误
    使用Transfromer来做retrywhen处理,做Token失效自登陆+接口自动重调。(亲测,自用)
    SnapKit:看了一篇retryWhen实现的文章 评论里说让用拦截器实现 还链接到这篇文章 ,来到这里又看到让用retrywhen:smiley:
    http://www.jianshu.com/p/6a452d93363c
    Weavey:@际遇做向导JOAH 有介绍的文章吗
    阿蕊儿:@际遇做向导JOAH 可以详细说一下么,这种方式怎么重新调用访问失效的接口
  • qluojieq:确实都有这样的问题,这里都是借助第三方框架的实现,如果是自己写的,无非就是中间判断截取,刷新然后继续请求,有时间再来看看
  • 无辜的小黄人:我想问下Token失效后怎么重新继续请求啊?
    镜花水月一梦不觉:@无辜的小黄人 :不可能吧,难道你获取token的接口 也要带上token吗?还没获取到就要带token 参数,确定不是接口设计有问题吗?
    无辜的小黄人:因为我现在每个接口Token值都是作为参数,所以每个接口访问的时候都有可能遇到Token失效需要重新刷然后继续完成请求的情况。。
    镜花水月一梦不觉:@无辜的小黄人 重新请求的是 获取token的接口,不是需要token的接口
  • e5c768cdef80:并没有提及refreshToken过期时, 需要重新登录的情况.
    镜花水月一梦不觉:@tellfresh 像这种都是统一封装,在外层解析Response ,然后根据错误码来判断逻辑,我这主要是由于服务器返回的数据 不规范才这样做
    e5c768cdef80:@镜花水月一梦不觉 在哪里处理跳转逻辑? Authenticator里面?怎么获得context? 就算能拿到context, 把跳转逻辑和刷新token逻辑耦合在一起不好吧.
    镜花水月一梦不觉:@tellfresh 如果refreshToken过期,应该是直接跳到登录界面,这个应该逻辑不复杂
  • 0b9dd1b03829:originalResponse.body().string()这个方法只能使用一次,使用第二次的时候就会报错,猜测应该是你的其他的拦截器里面先于这个调用了这个方法
  • 则卷滔滔:解决了我的问题 ,谢谢!

本文标题:Android上使用retrofit+okhttp时token失

本文链接:https://www.haomeiwen.com/subject/eqgmkttx.html