OkHttp系列:自动获取access_token

发表于 更新于

我们经常接入一些第三方服务，一般使用相应服务的前提都是通过app_id，app_key获取access_token，然后每个请求带着access_token来执行。

通常，我们的做法可能是先判断有没有access_token，并且在有效期内，然后执行请求。但是，请求一定能成功吗？很有可能还会提示access_token过期或无效（比如：客户端时间修改。或者“单点登录”导致本机token失效）。所以，我们有可能会在请求的返回结果中判断是否有token失效的错误，然后重新请求token，重新执行业务请求。

有没有更好的方案呢？

有，本文要介绍的就是被动获取token的方案。先执行业务请求，如果返回结果是token失效，那么重新获取token，并重新执行业务请求。

  1. 前置条件：依赖okhttp
  2. 技术点：使用okhttp的Intercepter。
  3. 优点：对业务请求透明。业务功能使用者不需要关心access_token的事情，不需要判断access_token是否过期。

注：因为是“被动获取token”，所以本方案相对而言，更适用于token大概率不会过期的服务。在我们实际开发中，多数都是这样。比如本例中用到的baidu ai抠图，token过期时间为一个月。对于token时间很短，在接口访问周期内大概率会过期的情况，我们也可以巧妙地利用okhttp的Intercepter来实现无感知地判断token是否过期，并且更新请求中的token。

使用

  1. 添加依赖

    1
    2
    3
    4
    5
    6
    7
    allprojects {
        repositories {
            maven { url 'https://github.com/dwvip/repo/raw/master' }
        }
    }

    implementation 'wang.unclecat.smarttoken:SmartToken:1.1'

  2. 继承PassiveSmartToken，并实现相应的抽像方法(指定token的位置、token对应的key、从服务端获取token的实现)。将之加入okhttp拦截器。

    支持的token类型

    1
    2
    3
    int TOKEN_IN_QUERY = 1;//token 在query
    int TOKEN_IN_HEADER = 2;//token 在header
    int TOKEN_IN_QUERY_AND_HEADER = 3;//token 在query和header同时存在

    需要实现的抽像方法

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    /**
     * 解析http resp body，判断是否是“access token无效”错误
     *
     * @param respBody http 返回实体字符串
     * @return true: 是, false: 否
     */
    protected abstract boolean checkTokenError(String respBody);

    /**
     * access token在query或header里对应的key
     */
    protected abstract String tokenKey();

    /**
     * 同步获取access token
     */
    protected abstract String getAccessTokenFromServer() throws IOException;

    详请参考demo中BaiduAccessToken2.java

demo及源码

https://github.com/andych008/SmartToken

欢迎star, follow, pr

2020-12-17更新(主动获取token的方案)：

后来我在SmartToken中又添加了主动获取token的方案，以满足不同使用者的需求。同样是无感知的，只需要继承ActiveSmartToken，并将之加入okhttp拦截器。

demo截图：