Fetch拦截器的实现

背景

为了满足老板的需求,需要往公司采购的一个第三方系统里注入脚本,拦截所有的请求,支持修改请求参数和响应参数。

所谓的注入脚本,就是往index.html里插入script标签,执行相应的代码,可以通过nginx去实现。

因第三方系统用的都是fetch请求,所以本文主要讲解fetch请求的拦截

在实现拦截器之前,先回顾一下Fetch的用法

Fetch基本使用

fetch等同于我们常用的XMLHttpRequest,用来发送HTTP请求获取资源,但Fetch设计得更加简洁易用,并基于Promise实现,解决了XMLHttpRequest的回调地狱问题

语法

 Promise<Response> fetch(input[, init]); 

参数

fetch方法接收两个参数:

  • input 可以是字符串或者Request对象
  • init(可选)一个配置项对象,包括所有对请求的设置

返回值

fetch方法会返回一个Promiseresolve时回传Response对象

示例

// GET请求
fetch('http://example.com/movies.json?name=example')
    .then(res => res.json)
    .then(data => console.log(data))
// POST请求
const data = { username: 'example' };

fetch('https://example.com/profile', {
  method: 'POST', // or 'PUT'
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(data),
})
.then(response => response.json())
.then(data => {
  console.log('Success:', data);
})
.catch((error) => {
  console.error('Error:', error);
});
// Request对象
let request = new Request('http://example.com/movies.json', {
    method: 'POST',
    body: '{name: example}'
})

fetch(request).then(res => res.json)

Request第二个参数和fetch方法的init参数一致

拦截器设计

拦截器的目的是在原生的fetch基础之上,新增拦截请求的功能。所以我们可以重新写一个fetch方法,让window.fetch = hijackFetch。这样第三方系统里调用fetch方法,就会走到hijackFetch里

从fetch的语法和参数来看,我们可以知道:

  • fetch是一个函数
  • 接收两个参数,第一个参数定义要获取的资源(也可以是Request对象)。第二个参数为可选项,一个配置项对象,包括所有对请求的设置;
  • 返回结果是一个promise对象。

在实现hijackFetch前,我们先来思考如何添加拦截器,这里参考axios的拦截器用法

// 请求拦截
hijackFetch.interceptor.request.use('/api/example', function(request) {
    // do something
    return request
})

// 响应拦截
hijackFetch.interceptor.response.use('/api/example', function(response) {
    // do something
    return response
})

和axios的拦截器不同,因为业务需求不需要对所有的fetch请求进行拦截,仅针对某几个特定的接口拦截,所以拦截器接收两个参数:

  • 接口地址
  • 回调函数

代码框架

var request = (function() {
  var originalFetch = window.fetch;
   
  var interceptor_req = {
      // url1: [callback1, callback2,...], 
      // url2: [] 
  }; 
    
  var interceptor_res = {
      // url1: [callback1, callback2,...], 
      // url2: [] 
  };
    
   function hijackFetch() {
       // ...
   }
    
   hijackFetch.interceptor = {
        // 请求拦截
        request: {
            use: function(url, callback) {
                // ...
            }
        },
        // 响应拦截
        response: {
            use: function(url, callback) {
                // ...
            }
        }
    }
    
    return {
        hijackFetch: hijackFetch
    }
})()

主要思路:

  1. 维护interceptor_req和interceptor_res两个对象,数据结构为{url: [callback]}的形式。

  2. 调用拦截器的use方法时,将callback函数push到对应的队列里。

  3. 在发起请求前和获取响应后执行该请求对应的callback队列,修改request和response

完整代码

var qbi_request = (function () {
  var originalFetch = window.fetch;
  var originalRequest = window.Request;

  // Request实例取不到body参数
  function Request(input, init){
      this.input = input;
      this.init = init;

      this.req = new originalRequest(input, init);

      for(var key in this.req){
          this[key] = this.req[key];
      }
  }

  window.Request = Request;

  var interceptor_req = {};
  var interceptor_res = {};

  function getPath(url) {
    return url.split("?")[0]
  }

  function hijackFetch() {
    var request = null
    if(typeof arguments[0] === 'string') {
      request = new Request(arguments[0], arguments[1] || {}) 
    } else {
      request = new Request(arguments[0].input, arguments[0].init)
    }

    var path = getPath(request.input)
    if(interceptor_req[path]) {
      // 清空队列,避免跳转页面后,重复执行callback
      // 这里的循环是请求拦截的关键代码,循环执行拦截器的回调方法,修改request
      while(fn = interceptor_req[path].shift()) {
        request = fn(request)
      }
    }

    return new Promise((resolve, reject) => {
      originalFetch(request.input, request.init)
        .then((res) => {
          var path = getPath(request.input)
          if(interceptor_res[path]) {
            // 这里的循环是响应拦截的关键代码,循环执行拦截器的回调方法,修改res
            while(fn = interceptor_res[path].shift()) {
              res = fn(res)
            }
          }

          resolve(res);
        })
        .catch((err) => {
          reject(err);
        });
    });
  }

  hijackFetch.interceptor = {
    request: {
      use: function (url, callback) {
        if(interceptor_req[url]) {
          interceptor_req[url].push(callback)
        } else {
          interceptor_req[url] = [callback]
        }
      },
    },
    response: {
      use: function (url, callback) {
        if(interceptor_res[url]) {
          interceptor_res[url].push(callback)
        } else {
          interceptor_res[url] = [callback]
        }
      },
    },
  };

  window.fetch = hijackFetch;

  return {
    hijackFetch: hijackFetch,
  };
})();

通过Request调用fetch方法的话,Request实例获取不到body对象,即获取不到请求参数,这样拦截也没有意义。所以对Request这个类也进行了重写,新增init属性,在new Request时将参数保存起来

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

推荐阅读更多精彩内容