前端取消請求及取消重復(fù)請求方式

更新時間：2022年07月08日 16:07:38 作者：還是那個大斌啊

這篇文章主要為大家介紹了前端取消請求及取消重復(fù)請求方式，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

一、前言

今天，我想跟大家分享幾種前端取消請求的幾種方式。

相信大家在平時的開發(fā)中，肯定或多或少的會遇到需要取消重復(fù)請求的場景，比如最常見的，我們在使用tab欄時，我們都會使用一個盒子去存放內(nèi)容，然后在切換tab欄時，會清除掉原來的內(nèi)容，然后替換上新的內(nèi)容，這個時候，如果我們的數(shù)據(jù)是通過服務(wù)從后端獲取的，就會存在一個問題，由于獲取數(shù)據(jù)是需要一定的時間的，就會存在當(dāng)我們切換tab欄到新的tab頁時，原來的tab頁的服務(wù)還在響應(yīng)中，這時新的tab頁的數(shù)據(jù)服務(wù)已經(jīng)響應(yīng)完成了，且頁面已經(jīng)顯示了新的tab頁的內(nèi)容，但是，這個時候舊的tab頁的數(shù)據(jù)也成功了并返回了數(shù)據(jù)，并將新的tab頁的內(nèi)容覆蓋了。。。

所以為了避免這種情況的發(fā)生，我們就需要在切換tab欄發(fā)送新的請求之前，將原來的的請求取消掉，至于如何取消請求，這便是今天我要講的內(nèi)容。

二、項目準(zhǔn)備

在正式學(xué)習(xí)之前，我們先搭建一個項目，并還原剛剛所說的場景，為了節(jié)省時間，我們使用腳手架搭建了一個前端vue+TS+vite項目，簡單的做了幾個Demo，頁面如下，上面是我們現(xiàn)實內(nèi)容的區(qū)域，點擊tab1按鈕時獲取并展示tab1的內(nèi)容，點擊tab2按鈕時獲取并展示tab2的內(nèi)容，以此類推，內(nèi)容比較簡單，這里就不放具體代碼了。

然后我們需要搭建一個本地服務(wù)器，這里我們新建一個app.ts文件，使用express以及cors解決跨域問題去搭建一個簡單的服務(wù)器，具體代碼如下：

// app.ts
const express = require('express')
const app = express()
const cors = require('cors')
app.use(cors())
app.get('/tab1', (req, res) => {
  res.send('這是tab1的內(nèi)容...')
})
app.get('/tab2', (req, res) => {
  setTimeout(() => {
    res.send('這是tab2的內(nèi)容...')
  }, 3000)
})
app.get('/tab3', (req, res) => {
  res.send('這是tab3的內(nèi)容...')
})
app.listen('3000', () => {
  console.log('server running at 3000 port...')
})

上面代碼，我們新建了一個服務(wù)器并讓他運行在本地的3000端口，同時在獲取tab2的內(nèi)容時，我們設(shè)置了3秒的延遲，以便實現(xiàn)我們想要的場景，然后我們使用node app.ts啟動服務(wù)器，當(dāng)終端打印了server running at 3000 port...就說明服務(wù)器啟動成功了。

然后我們使用axios去發(fā)送請求，安裝axios，然后我們在項目中src下面新建utils文件夾，然后新建request.ts文件，具體代碼如下：

import axios, { AxiosRequestConfig } from 'axios'
// 新建一個axios實例
const ins = axios.create({
  baseURL: 'http://localhost:3000',
  timeout: 5000,
})
export function request(Args: AxiosRequestConfig) {
  return ins.request(Args)
}

這里我們新建了一個axios實例，并配置了baseURL和超時時間，并做了一個簡單的封裝然后導(dǎo)出，需要注意的是，axios請求方法的別名有很多種，如下圖這里就不做過多介紹了，大家想了解的可以去看官網(wǎng),我們這里使用request方法。

最后，我們在頁面上引入并綁定請求：

// bar.vue
<script setup lang="ts">
import { ref } from 'vue'
import { request } from '@/utils/request'
const context = ref('tab1的內(nèi)容...')
const getTab1Context = async () => {
  const { data } = await request({
    url: '/tab1',
  })
  context.value = data
}
const getTab2Context = async () => {
  const { data } = await request({
    url: '/tab2',
  })
  context.value = data
}
const getTab3Context = async () => {
  const { data } = await request({
    url: '/tab3',
  })
  context.value = data
}
</script>

為了方便理解，將template部分代碼也附上：

// bar.vue
<template>
  <div class="container">
    <div class="context">{{ context }}</div>
    <div class="btns">
      <el-button type="primary" @click="getTab1Context">tab1</el-button>
      <el-button type="primary" @click="getTab2Context">tab2</el-button>
      <el-button type="primary" @click="getTab3Context">tab3</el-button>
    </div>
  </div>
</template>

到這里，我們的項目準(zhǔn)備工作就好了，看下效果圖

然后看下我們前面提到的問題：

注意看，在我點擊了tab2之后立馬點擊tab3，盒子中會先顯示tab3的內(nèi)容，然后又被tab2的內(nèi)容覆蓋了。

三、原生方法

項目準(zhǔn)備好之后，我們就可以進入正題了，其實，關(guān)于取消請求的方法，axios官方就已經(jīng)有了，所以我們先來了解下使用axios原生的方法如何取消請求：先看下官方的代碼：

可以使用 CancelToken.source 工廠方法創(chuàng)建 cancel token 像這樣：

const CancelToken = axios.CancelToken;
const source = CancelToken.source();
axios.get('/user/12345', {
    cancelToken: source.token
}).catch(function (thrown) {
    if (axios.isCancel(thrown)) {
        console.log('Request canceled', thrown.message);
    } else { /* 處理錯誤 */ }
});
axios.post('/user/12345', {
    name: 'new name'
}, {
    cancelToken: source.token
});
// 取消請求 (message 參數(shù)是可選的)
source.cancel('Operation canceled by the user.');

同時還可以通過傳遞一個executor函數(shù)到CancelToken的構(gòu)造函數(shù)來創(chuàng)建 cancel token ：

const CancelToken = axios.CancelToken;
let cancel;
axios.get('/user/12345', {
    cancelToken: new CancelToken(function executor(c) {
        // executor 函數(shù)接收一個 cancel 函數(shù)作為參數(shù)
        cancel = c;
    })
});
// 取消請求
cancel();

這是官方提供的兩種方法，我們將他們用到我們的項目上，因為都差不多，所以我們這里就只演示一種，選擇通過傳遞函數(shù)的方式來取消請求；

進入項目utils文件夾下的request.ts文件，修改代碼如下：

// request.ts
import axios, { AxiosRequestConfig } from 'axios'
const CancelToken = axios.CancelToken
const ins = axios.create({
  baseURL: 'http://localhost:3000',
  timeout: 5000,
})
// 新建一個取消請求函數(shù)并導(dǎo)出
export let cancelFn = (cancel: string) => {
  console.log(cancel)
}
export function request(Args: AxiosRequestConfig) {
  // 在請求配置中增加取消請求的Token
  Args.cancelToken = new CancelToken(function (cancel) {
    cancelFn = cancel
  })
  return ins.request(Args)
}

然后我們就可以在想要取消請求的地方調(diào)用cancelFn函數(shù)就可以了，我們給tab1和tab3按鈕都加上取消請求功能：

// bar.vue
<script setup lang="ts">
import { ref } from 'vue'
import { request, cancelFn } from '@/utils/request'
const context = ref('tab1的內(nèi)容...')
const getTab1Context = async () => {
  cancelFn('取消了tab2的請求')
  const { data } = await request({
    url: '/tab1',
  })
  context.value = data
}
const getTab2Context = async () => {
  const { data } = await request({
    url: '/tab2',
  })
  context.value = data
}
const getTab3Context = async () => {
  cancelFn('取消了tab2的請求')
  const { data } = await request({
    url: '/tab3',
  })
  context.value = data
}
</script>

這樣取消請求的功能就完成了，看下效果：

四、promise

除了官網(wǎng)的方式之外，其實我們也可以借助Promise對象，我們都知道，Promise對象的狀態(tài)一旦確定就不能再改變的，基于這個原理，我們可以使用Promise封裝下我們的請求，然后通過手動改變Promise的狀態(tài)去阻止請求的響應(yīng)，看下面代碼：

// request.ts
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios'
const ins = axios.create({
  baseURL: 'http://localhost:3000',
  timeout: 5000,
})
// 新建一個取消請求函數(shù)并導(dǎo)出
export let cancelFn = (cancel: string) => {
  console.log(cancel)
}
export function request(Args: AxiosRequestConfig): Promise<AxiosResponse> {
  return new Promise((resolve, reject) => {
    ins.request(Args).then((res: AxiosResponse) => {
      resolve(res)
    })
    cancelFn = (msg) => {
      reject(msg)
    }
  })
}

效果也是一樣的

需要注意的是，雖然效果是一樣的，但是使用Promise的方式，我們只是手動修改了Promise的狀態(tài)為reject，但是請求還是一樣發(fā)送并響應(yīng)了，沒有取消，這個是和使用Axios原生方法的不同之處。

五、借助Promise.race

講完了取消請求，其實還有一種場景也很常見，那就是取消重復(fù)請求，如果是要取消重復(fù)請求，我們又該怎么實現(xiàn)呢？其實我們可以借助Promise.race，Promise.race的作用就是將多個Promise對象包裝成一個，即它接受一個數(shù)組，每一個數(shù)組成員都是一個Promise對象，只要這些成員中有一個狀態(tài)改變，Promise.race的狀態(tài)就隨之改變，基于這個原理，我們可以實現(xiàn)取消重復(fù)請求請求的目的。

基本思路就是，我們給每一個請求身邊都放一個Promise對象，這個對象就是一顆炸彈，將他們一起放到Promise.race里面，當(dāng)我們需要取消請求的時候就可以點燃這顆炸藥。

還是上面的例子，我們針對按鈕tab2做一個取消重復(fù)請求的功能，我們先聲明一個類，在里面做取消重復(fù)請求的功能，在utils下新建cancelClass.ts文件：

// cancelClass.ts
import { AxiosResponse } from 'axios'
export class CancelablePromise {
  pendingPromise: any
  reject: any
  constructor() {
    this.pendingPromise = null
    this.reject = null
  }
  handleRequest(requestFn: any): Promise<AxiosResponse> {
    if (this.pendingPromise) {
      this.cancel('取消了上一個請求。。。')
    }
    const promise = new Promise((resolve, reject) => (this.reject = reject))
    this.pendingPromise = Promise.race([requestFn(), promise])
    return this.pendingPromise
  }
  cancel(reason: string) {
    this.reject(reason)
    this.pendingPromise = null
  }
}

上面代碼中，我們聲明了一個類，然后在類中聲明了兩個屬性pendingPromise和reject，一個request請求方法用來封裝請求并判斷上一個請求是否還在響應(yīng)中，如果還未響應(yīng)則手動取消上一次的請求，同時聲明了一個promise對象，并將他的reject方法保存在類的reject屬性中，然后用promise.race包裝了請求函數(shù)和剛剛聲明的promise對象。

最后聲明了一個cancel方法，在cancel方法中觸發(fā)reject函數(shù)，來觸發(fā)promise對象的狀態(tài)改變，這樣就無法獲取到reuestFn的響應(yīng)數(shù)據(jù)了。從而達到了取消請求的目的；

因為requestFn必須是一個函數(shù)，所以我們需要改裝下Axios的request函數(shù),讓他返回一個函數(shù)；

// request.ts
export function request(Args: AxiosRequestConfig) {
  return () => ins.request(Args)
}

最后在頁面中引入并使用：

// bar.vue
<script setup lang="ts">
import { ref } from 'vue'
import { request, cancelFn } from '@/utils/request'
import { CancelablePromise } from '@/utils/cancelClass'
...
const cancelablePromise = new CancelablePromise()
...
const getTab2Context = async () => {
  const { data } = await cancelablePromise.handleRequest(
    request({
      url: '/tab2',
    })
  )
  context.value = data
}
</script>

最后看下效果

六、總結(jié)

到這里，我們前端取消請求和取消重復(fù)請求的方法就學(xué)習(xí)完了，需要注意的是，即使是使用官方的方法，也僅僅是取消服務(wù)器還沒接收到的請求，如果請求已經(jīng)發(fā)送到了服務(wù)端是取消不了的，只能讓后端同時去處理了，使用promise的方法，僅僅只是通過改變promise的狀態(tài)來阻止響應(yīng)結(jié)果的接收，服務(wù)還是照常發(fā)送的。

以上就是前端取消請求及取消重復(fù)請求方式的詳細內(nèi)容，更多關(guān)于前端取消請求取消重復(fù)請求的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: