为axios添加基于window的缓存能力

业务诉求

有些业务对时效性要求并不高,可以通过给接口增加基于window的缓存能力,即在一定时间内相同的请求复用之前的请求结果,来实现页面的快速展现。比如

  • 页面中有些图表,可能底层是一个接口的数据,但每个图表对不同的指标进行聚合运算。倘若将数据查询也都封装到chart内部,结合数据缓存,可以使得每个图表功能高内聚且不影响性能;
  • 查看当前页面时,又返回之前的页面,倘若需要再等待一次请求,可能会有些考验耐心吧

axios interceptor && adapter

axios interceptors 是我们常用的拦截器,通常用来对request统一添加Header,对response统一处理error,axios文档上也有示例代码。为了支持对请求结果的代理拦截,还需要adapter参数来配合。

adapter介绍

axios对adapter参数是如此介绍的:

adapter allows custom handling of requests which makes testing easier.
// Return a promise and supply a valid response (see lib/adapters/README.md).
adapter: function (config) { /* ... */ },

adapter可以用来对特定请求,返回一个自定义的promise.所以首先约定对哪些请求进行缓存, 然后response中能够识别这些请求,并且进行缓存。

首先需要知道:request中配置的config默认都是会透传给response的,也就是每个请求的的request/response而言,两者是能获取到同一份config的。
所以可以约定在config中定义额外参数cache,如果有传值,则认为是需要缓存的。在response拦截时,对于config中有设置cache参数的请求结果进行缓存。

缓存设置精细化

对每个请求进行缓存,其存储形式为:

  • 将能够表示每个请求独特性的参数: url, method, params(data) stringify之后作为key
  • value中存放3个属性:
    • data: response data
    • pending: 是否正在请求
    • expire: 过期时间

这样设计可以满足:1. 自定义请求的缓存时间; 2. 同时发出多个相同请求,只会实际发出一个网络请求,其余等着返回结果公用。另外,对于配置了cache的请求,还需要支持另外一个参数forceUpdate,因为可能在缓存期间,需要拉去最新数据,比如列表页中完成创建任务后。

代码如下:

/**
 *
 * 在axios config中添加了cache<number>, 单位秒。
 * 与之配合的有forceUpdate,使用场景:列表页新增之后的refetch需要从接口拉去最新数据,此时就需要添加该参数
 * 对相同参数(url与params/data的组合)的请求,只会实际请求一次。
 *
 */
import axios from 'axios';
import EventEmitter from 'yourEventEmitter'; // 随意一个eventEmiter就好,就用到了emit和once方法

const event = new EventEmitter();

const cacheData = Symbol('window_cache');
window[cacheData] = {};

function getCacheKey(config = {}) {
  let reqParams = {};
  const { method, params, data } = config;
  const reqData = method === 'get' ? params : data;
  if (typeof reqData === 'string') {
    try {
      reqParams = JSON.parse(reqData);
    } catch (err) {
      console.error('parse cacheKey error:: ', err);
    }
  } else {
    reqParams = reqData;
  }
  const reqKey = {
    url: config.url,
    params: reqParams,
    method,
  };

  let key;
  try {
    key = btoa(JSON.stringify(reqKey));
  } catch (err) {
    console.error('btoa error::', err);
    key = JSON.stringify(reqKey);
  }

  return key;
}

axios.interceptors.request.use(
  function(config) {
    const { cache, forceUpdate } = config;
    if (cache) {
      const paramsKey = getCacheKey(config);

      if (!window[cacheData][paramsKey]) {
        window[cacheData][paramsKey] = {};
      }

      const { data, pending, expire } = window[cacheData][paramsKey];
      if (pending) {
        config.adapter = () => {
          return new Promise(resolve => {
            event.once(paramsKey, resData =>
              resolve({
                data: resData,
                status: config.status,
                statusText: config.statusText,
                headers: config.headers,
                config: {
                  ...config,
                  useCache: true,
                },
                request: config,
              }),
            );
          });
        };
      } else if (!forceUpdate && data && expire && Date.now() < expire) {
        config.adapter = () => {
          return Promise.resolve({
            data,
            status: config.status,
            statusText: config.statusText,
            headers: config.headers,
            config: {
              ...config,
              useCache: true,
            },
            request: config,
          });
        };
      } else {
        window[cacheData][paramsKey].pending = true;
      }
    }

    return config;
  },
  function(error) {
    return Promise.reject(error);
  },
);

axios.interceptors.response.use(
  function(response) {
      const { config = {}, data: resOriginData } = response;
      const { errNo } = resOriginData;
      const { cache, useCache } = config;
      //  只对接口请求缓存,从缓存读取时不再更新,也防止expire不断延期
      if (cache && !useCache) {
        const paramsKey = getCacheKey(config);
        const resData = response.data;
        //  需缓存的接口,请求失败时不缓存结果
        if (errNo !== 0) {
          window[cacheData][paramsKey] = {
            pending: false,
          };
        } else {
          window[cacheData][paramsKey] = {
            data: resData,
            pending: false,
            expire: Date.now() + cache * 1000,
          };
        }
        event.emit(paramsKey, resData);
      }

      return response;
  },
  function(error) {
    //  自定义错误处理
    return Promise.reject(error);
  },
);

export default axios;

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