網絡請求工具之axios,vue-resouce,fetch

網絡請求工具之axios,vue-resouce,fetch

一.背景

目前前端三大框架中,要調用接口,發送網絡請求,如果還是使用以前的jquery來操作的話,是很不明智的,jquery是個比較龐大的dom操作庫,體積比較大,然後這個時候,就出現了很多的網絡請求工具,體積小,專門用來發送網絡請求,比較方便

1.angularjs

使用內置的http模塊

2.vuejs

使用vue-resource.fetch.axios

3.react

使用fetch,axios

二.請求工具

1.vue-resource

vue 1.x的時候,vue內置的一個發送網絡請求請求插件,vue-resource的用法和axios相似度很高.vue2.x的時候,尤大就推薦我們使用axios,官網就不在維護vue-resource了

1.1 安裝

$ npm install vue-resource

1.2 使用

main.js文件中

//引入vue
import Vue from 'vue'
//引入vue-resource
import VueResource from 'vue-resource'

//使用
Vue.http或者this.$http

1.3 常用api

this.$http.get(url,[options]).then().catch();
this.$http.post(url,[body],options).then().catch();
this.$http(options).then().catch();

注意:請求傳參的時候,注意get方式和post方式,與之前的jquery的ajax傳參不一樣,這邊的傳遞url參數是params參數,post傳參是body參數,其實就是對象

2.fetch

ES6提供的.一個底層的請求API,用來替代XMLHttpRequest這個API的

2.1.安裝

不需要額外的安裝,因爲fetch是底層的API,也就是原生js提供的,所以可以當做全局變量來使用,它是掛在window對象身上的.

但是fetch有兼容性問題,如果要處理兼容性問題時,需要去安裝一個Polyfill

2.2.使用

使用時需要對接收到的數據根據數據類型做轉換

fetch(url).then(response=>response.json()).then().catch();
fetch(url).then(response=>response.text()).then().catch();

詳情api,可以參考MDN

3.axios

參考鏈接 axios

一款基於XMLHttpRequest對象封裝的網絡請求工具,同時支持瀏覽器和nodejs,繼承了Promise

根據環境不同

瀏覽器是基於XMLHttpRequest

Nodejs是基於http模塊

3.1 安裝

$ npm install axios

3.2使用

axios.get(url,[options]).then().catch()
axios.post(url,[body],[options]).then().catch()
...
axios(options).then().catch()

更多Api見官網

3.3 axios特點

• 從瀏覽器中創建XMLHttpRequest

• 從node.js創建http請求

• 支持Promise Api

• 攔截請求和響應

• 轉換請求數據和響應數據

• 取消請求

• 自動轉換JSON數據

• 客戶端支持防禦XSRF

3.4 axios響應對象

axios的響應數據不是接口直接的響應,而是axios的一個包裝對象.

{
    //此屬性,纔是接口的響應,我們需要的數據
    data:{},
    //響應的狀態碼
    status:200,
    //服務器響應信息
    statusText:'ok',
    //服務器響應的頭
    headers:{},
    //爲請求提供的配置信息
    config:{}   
}

3.5 axios 請求對象

這些是創建請求時可以用的配置選項。只有 url 是必需的。如果沒有指定 method，請求將默認使用 get 方法。

{
  // `url` 是用於請求的服務器 URL
  url: '/user',

  // `method` 是創建請求時使用的方法
  method: 'get', // 默認是 get

  // `baseURL` 將自動加在 `url` 前面，除非 `url` 是一個絕對 URL。
  // 它可以通過設置一個 `baseURL` 便於爲 axios 實例的方法傳遞相對 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允許在向服務器發送前，修改請求數據
  // 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法
  // 後面數組中的函數必須返回一個字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data) {
    // 對 data 進行任意轉換處理

    return data;
  }],

  // `transformResponse` 在傳遞給 then/catch 前，允許修改響應數據
  transformResponse: [function (data) {
    // 對 data 進行任意轉換處理

    return data;
  }],

  // `headers` 是即將被髮送的自定義請求頭
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是即將與請求一起發送的 URL 參數
  // 必須是一個無格式對象(plain object)或 URLSearchParams 對象
  params: {
    ID: 12345
  },

  // `paramsSerializer` 是一個負責 `params` 序列化的函數
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  // `data` 是作爲請求主體被髮送的數據
  // 只適用於這些請求方法 'PUT', 'POST', 和 'PATCH'
  // 在沒有設置 `transformRequest` 時，必須是以下類型之一：
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 瀏覽器專屬：FormData, File, Blob
  // - Node 專屬： Stream
  data: {
    firstName: 'Fred'
  },

  // `timeout` 指定請求超時的毫秒數(0 表示無超時時間)
  // 如果請求話費了超過 `timeout` 的時間，請求將被中斷
  timeout: 1000,

  // `withCredentials` 表示跨域請求時是否需要使用憑證
  withCredentials: false, // 默認的

  // `adapter` 允許自定義處理請求，以使測試更輕鬆
  // 返回一個 promise 並應用一個有效的響應 (查閱 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

  // `auth` 表示應該使用 HTTP 基礎驗證，並提供憑據
  // 這將設置一個 `Authorization` 頭，覆寫掉現有的任意使用 `headers` 設置的自定義 `Authorization`頭
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示服務器響應的數據類型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 默認的

  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名稱
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` 是承載 xsrf token 的值的 HTTP 頭的名稱
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默認的

  // `onUploadProgress` 允許爲上傳處理進度事件
  onUploadProgress: function (progressEvent) {
    // 對原生進度事件的處理
  },

  // `onDownloadProgress` 允許爲下載處理進度事件
  onDownloadProgress: function (progressEvent) {
    // 對原生進度事件的處理
  },

  // `maxContentLength` 定義允許的響應內容的最大尺寸
  maxContentLength: 2000,

  // `validateStatus` 定義對於給定的HTTP 響應狀態碼是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者設置爲 `null` 或 `undefined`)，promise 將被 resolve; 否則，promise 將被 rejecte
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默認的
  },

  // `maxRedirects` 定義在 node.js 中 follow 的最大重定向數目
  // 如果設置爲0，將不會 follow 任何重定向
  maxRedirects: 5, // 默認的

  // `httpAgent` 和 `httpsAgent` 分別在 node.js 中用於定義在執行 http 和 https 時使用的自定義代理。允許像這樣配置選項：
  // `keepAlive` 默認沒有啓用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 'proxy' 定義代理服務器的主機名稱和端口
  // `auth` 表示 HTTP 基礎驗證應當用於連接代理，並提供憑據
  // 這將會設置一個 `Proxy-Authorization` 頭，覆寫掉已有的通過使用 `header` 設置的自定義 `Proxy-Authorization` 頭。
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // `cancelToken` 指定用於取消請求的 cancel token
  // （查看後面的 Cancellation 這節瞭解更多）
  cancelToken: new CancelToken(function (cancel) {
  })
}

特別注意的是:

一般情況下請求時

• get請求的參數是params選項
• post請求的參數是data選項

但是特殊情況下,post請求也是可以傳遞params選項的,具體看接口的定義

3.6 axios 請求攔截

先引入一個問題:

我們調接口時,有時候會需要傳入一個token,而我們的token是放在cookie或者localStorage裏,如果說我們token改變了,用戶退出再登錄的情況下,後續會攜帶的token將是上一次的token,爲了保證我們每次請求是最新的token,所以需要請求攔截了.

// 封裝請求攔截器
instance.interceptors.request.use((config) => {
    // 在這裏做一些檢測或者包裝等處理
    // console.log('請求攔截', config)
    // 鑑權 token添加
    config.headers.Authorization = localStorage.getItem('token') || ''
    return config
})

3.7 axios 響應攔截

同樣引入一個問題,每次我們通過axios去請求接口時,返回的response體並不是我們想要的數據,response中的data纔是我們想要的,這時就可以使用使用響應攔截了

// 封裝響應攔截器
instance.interceptors.response.use((response) => {
    
    // 請求成功
    // console.log('響應攔截', response)
    // 數據過濾，根據後端標識字符來進行數據
    if (response.data && response.data.err == 0) {
        return response.data.data
    } 
}, (error) => {
    // 請求失敗
    return Promise.reject(error)
})

3.8 axios在vue中全局使用

將axios掛載到Vue的原型上即可

//main.js
import Vue from 'vue';
import axios from 'axios'
Vue.prototype.$axios=axios;

//我在項目中一般喜歡把接口都封裝在apis文件中之後,然後全局調用接口
//方法都是可以,看個人情況
//引入api,將api掛載到vue原型,方便調用
import http from '@/utils/apis'
Vue.prototype.$http = http

3.9 封裝一個axios

//fetch.js

//引入axios 
import axios from 'axios';

//創建一個axios的實例對象
var instance = axios.create({
    //baseUrl 自己按實際情況配置
    baseUrl: "http://localhost:8080",
    //設置超時時間 ms
    timeout: 7000,
    headers: {
        'Content-Type': 'application/json;charset=UTF-8'
    }
});

// 封裝請求攔截器
instance.interceptors.request.use((config) => {
    // 在這裏做一些檢測或者包裝等處理
    // console.log('請求攔截', config)
    // 鑑權 token添加
    config.headers.Authorization = localStorage.getItem('token') || ''
    return config
})

// 封裝響應攔截器
instance.interceptors.response.use((response) => {
    //按自己實際情況配置
    // 請求成功
    // console.log('響應攔截', response)
    // 數據過濾，根據後端標識字符來進行數據
    if (response.data && response.data.err == 0) {
        return response.data.data
    } 
}, (error) => {
    // 請求失敗
    return Promise.reject(error)
})

// 暴露axios實例
export default instance;