axios簡單封裝

寫在最前面

新手前端剛剛接觸vue，感受真的好用。項目中須要使用axios，而後學習了一下。借鑑網上一些大佬的經驗，如今分享一下axios的簡單封裝，若是有什麼錯誤的地方，請你們指出。

axios安裝

npm install axios --save

最最簡單的使用

首先在src目錄下建立axios文件夾，而後建立index.js和fetch.js兩個文件。

fetch.js文件代碼以下:

import axios from 'axios'
//定義fetch函數，config爲配置
export function fetch(config){
   //返回promise對象
   return new Promise((resolve,reject) =>{
       //建立axios實例，把基本的配置放進去
       const instance = axios.create({
           //定義請求文件類型
           headers:{
              'Content-Type': 'application/json',
            },      
            timeout: 3000,
            //定義請求根目錄
            baseURL: 'http://www.xxx.com/'
        });
       //請求成功後執行的函數
        instance(config).then(res =>{
            console.log(res);
            resolve(res);
        //失敗後執行的函數
        }).catch(err => {
            console.log(err);
            reject(err);
        })
    });
}

關於自定義const instance = axios.create({ }) 能夠有不少配置，我只是寫了最基本的幾個，官方都給了詳細說明，我這裏也貼一下。
地址:https://www.kancloud.cn/yunye...

{
  // `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) {
  })
}

index.js 文件代碼以下:

//引入fetch.js文件
import { fetch } from './fetch' 
//定義獲取數據的函數getData(),其中url,type,data對應fetch(config)中的config
export  function getData(url,type,data) {
//若是type爲空，默認爲post方法，也能夠本身改爲get
    if(type==='')
      type = 'post';
    return fetch({
//這裏的url爲baseURL下接口地址，如baseURL爲'www.baidu.com',接口地址爲'www.baidu.com/api/getdata',那麼url裏就寫'api/getdata'
      url: url,
      method: type,
      data: data,
    })
}

這樣基本的功能就有了，而後在頁面上使用的代碼以下(假設頁面爲home.vue，在src/pages目錄下):

<script>
import { getData } from './../axios'
export default {
    created: function () {
        //a,b等於1，2
        this.foo(1,2)
    }
    methods: {
        foo: function(a,b) {
            //a,b爲用戶傳入的參數，中間方法爲''，默認'post'
            getData('api/getdata', '', {a, b}).then(res => {
                  console.log(res);
              }, err => {
                  console.log(err);
              })
        }
    }
}

</script>

至此代碼就都ok了，基本的功能都能用了。關於攔截器和錯誤處理，官方都有詳細說明，並且不少大佬進行了更詳盡的封裝。剛接觸vue的新手,若是上面有錯誤的地方，歡迎你們指出。

原文地址：https://segmentfault.com/a/1190000012743382