用axios拦截器实现一个友好提示

简介

axios的拦截器是一个非常优秀的设计,借助它我们可以实现很多效果,节省重复的代码。

今天重点不是介绍axios,而是带领大家实现一个在网络较慢时弹出友好提示的拦截器。类似与下面的效果。


image.png

大家可以到这里来体验: http://ngzhixiao.gitee.io/heiibaiitoy/articles/axios/slownetwork/index.html

如果大家是在电脑上访问的话,可以打开控制台的network选择网络的slow 3G会更接近真实的体验
image.png

实现

// 记录当前请求发出但未返回的id
    const requestMap = new Set()

    function generateId(url) {
      return url+new Date().getTime()+Math.random()
    }

    /**
     * 慢网络提示拦截器,在网络慢的情况提示用户等待
     */
    const slowNetworkInterceptor = function(axios, slowTime = 5000) {

      if(!axios.defaults.headers.common.__config){
        axios.defaults.headers.common.__config = {}
      }

      axios.defaults.headers.common.__config.slowNetworkConfig = {
        slowTime, // 定义网络慢的条件
        close: false,  // 允许在某些接口关闭提示
      }

      axios.interceptors.request.use(config => {
        const snc = config.headers.common.__config.slowNetworkConfig
        if(snc.close) return config
        const id = generateId(config.url)
        requestMap.add(id)
        snc.id = id
        setTimeout(() => {
          if(requestMap.has(id)) {
            Toast("网络似乎正在开小差,请耐心等待噢(ง ˙o˙)ว")
            requestMap.delete(id)
          }
        }, snc.slowTime);
        return config
      }, err => Promise.reject(err))

      axios.interceptors.response.use(res => {
        const snc = res.config.headers.__config.slowNetworkConfig
        if(snc.close) return res
        requestMap.delete(snc.id)
        return res
      }, err => {
        const snc = err.config.headers.__config.slowNetworkConfig
        if(snc.close) return Promise.reject(err)
        requestMap.delete(snc.id)
        return Promise.reject(err)
      })

      return axios
    }

    slowNetworkInterceptor(axios)

代码如上所示。

在每次请求时会生成一个id并将其存储到请求配置config中,用来标记这个请求。在最开始的时候我们定义了一个记录发出但未返回的网络请求的requestMap,将这个请求的id记录下来。然后开启一个定时器(我们默认给它一个5s),如果5s内请求返回了,就在返回的拦截器删除掉对应的id;如果5s内还未返回,我们就弹框提示用户当前网络较慢。

其中有一个细节,为什么id和定时器时长的信息不直接放到请求对象的config中而是放在headers上呢?放到headers上不久随着请求发出去了吗?

其实这axios的实现有关,在真正的发出请求前,axios会把config中的参数进行一个合并操作,但是只会合并它定义的一些参数,所以如果直接放到config上就会被排除掉,而对headers时会进行一个深拷贝,同时将common提上一级,这也能解释在请求拦截中设置在common中的参数为什么在返回拦截中能直接在headers上拿到。

这会导致我们在请求头多一个参数,是这样的:__config: [object Object],但在大多数情况下这没什么影响。

总结

这只是拦截器的其中一种用法,其实在实际的开发过程中,我们还可以通过拦截器实现请求的签名、请求数据的加解密、甚至能实现缓存请求的缓存等操作。

axios是一个设计很巧妙的库,而且他的代码很短,是学习优秀开源库很好的例子,推荐有时间都能去看看它的源码。

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

推荐阅读更多精彩内容