基於axios請求封裝的vue應用

什麼是axios？

Axios 是一個基於 promise 的 HTTP 庫，可以用在瀏覽器和 node.js 中。

特性：

從瀏覽器中建立 XMLHttpRequests
從 node.js 建立 http 請求
支援 Promise API
攔截請求和響應
轉換請求資料和響應資料
取消請求
自動轉換 JSON 資料
使用者端支援防禦 XSRF

Promises

axios 依賴原生的 ES6 Promise 實現而被支援. 如果你的環境不支援 ES6 Promise，你可以使用 polyfill.

axios的請求型別？

安裝好node的一套環境：

一下三種參照方式:
npm install axios -先在node中安裝axios，api封裝中引入axios即可
bower install axios --npm中安裝 bower，在bower中引入axios包

bower：
Bower可以管理包含HTML，CSS，JavaScript，字型甚至影象檔案的元件。Bower不會串聯或縮小程式碼或執行其他任何操作-只會安裝所需的正確版本的軟體包及其依賴項。
直接vue中引入js檔案
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

axios封裝預設的自定義設定

const instance = axios.create({
{
   // `url` 是用於請求的伺服器 URL
  url: '/user',

  // `method` 是建立請求時使用的方法
  method: 'get', // default

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

  // `transformRequest` 允許在向伺服器傳送前，修改請求資料
  // 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法
  // 後面陣列中的函數必須返回一個字串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data, headers) {
    // 對 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, // default

  // `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', // default

  // `responseEncoding` indicates encoding to use for decoding responses
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

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

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

   // `onUploadProgress` 允許為上傳處理進度事件
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `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; // default
  },

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

  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  socketPath: null, // default

  // `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) {
  })
}
}).then(function(response){
// `data` 由伺服器提供的響應
  data: {},

  // `status` 來自伺服器響應的 HTTP 狀態碼
  status: 200,

  // `statusText` 來自伺服器響應的 HTTP 狀態資訊
  statusText: 'OK',

  // `headers` 伺服器響應的頭
  headers: {},

   // `config` 是為請求提供的設定資訊
  config: {},
 // 'request'
  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance the browser
  request: {}
});

設定的載入優先順序

高到低順序：

第一步：設定預設值
在請求中設定的設定項

instance.get('/longRequest', {
 timeout: 5000
});

第二部：全域性的 axios 預設值
在api檔案中設定的設定項

instance.defaults.timeout = 2500;

第三步：自定義範例預設值
在建立axios範例中設定的設定項

var instance = axios.create();

攔截器

// 新增請求攔截器
axios.interceptors.request.use(function (config) {
    // 在傳送請求之前做些什麼
    return config;
  }, function (error) {
    // 對請求錯誤做些什麼
    return Promise.reject(error);
  });

// 新增響應攔截器
axios.interceptors.response.use(function (response) {
    // 對響應資料做點什麼
    return response;
  }, function (error) {
    switch (err.response.status) {
      case 400:
        err.message = '錯誤請求';
        break;
      case 401:
        err.message = '未授權，請重新登入';
        break;
      case 403:
        err.message = '拒絕存取';
        break;
      case 404:
        err.message = '請求錯誤,未找到該資源';
        break;
      case 405:
        err.message = '請求方法未允許';
        break;
      case 408:
        err.message = '請求超時';
        break;
       case 415:
        err.message = '伺服器無法處理請求附帶的媒體格式';
        break;
      case 500:
        err.message = '伺服器出錯';
        break;
      case 501:
        err.message = '網路未實現';
        break;
      case 502:
        err.message = '網路錯誤';
        break;
      case 503:
        err.message = '服務不可用';
        break;
      case 504:
        err.message = '網路超時';
        break;
      case 505:
        err.message = 'http版本不支援該請求';
        break;
      default:
        err.message = `連線錯誤${err.response.status}`;
    }
  } else {
    err.message = '連線到伺服器失敗';
  }
  return Promise.resolve(err.response);
  });

import Vue from ‘vue’;
import axios from ‘axios’;

get請求

axios.get({
	method:'get',
	url:'xxxx',
	reponseType:'',//相應型別
	parems:{//入參
	}
}).then(function(response){
	....
})

post請求

axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
}).then(function(res){

});

delete請求

axios({
  method: 'delete',
  url: '/user/12345',
 //入參一：掛載到請求後面
 parmes：{
 }
 //入參二：掛載到請求體內
 data{
}
}).then(function(res){

});

put請求：更新整個物件資源

axios({
  method: 'put',
  url: '/user/12345',
 data{
}
}).then(function(res){

});

patch請求：更新物件的區域性資源

axios({
  method: 'patch',
  url: '/user/12345',
 data{
}
}).then(function(res){

});

提供封裝後的另一種寫法：
axios.get(url[, config])
axios.delete(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

並行請求

axios.all(iterable)
axios.spread(callback)
function getUserAccount() {
return axios.get(’/user/12345’);
}

function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}
//請求陣列
axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {//對應請求的響應體
    // 兩個請求現在都執行完成
  }));

axios與ajax的區別？

axios：
從 node.js 建立 http 請求
支援 Promise API
使用者端支援防止CSRF
提供了一些並行請求的介面（重要，方便了很多的操作）
ajax：
3.JQuery整個專案太大，單純使用ajax卻要引入整個JQuery非常的不合理（採取個性化打包的方案又不能享受CDN服務）

axios怎樣自定義封裝？

1、建立介面請求封裝、響應、攔截、認證、等基礎組態檔 index.js

引入靜態資源
import axios from 'axios';
 import qs from 'qs';
import apiMap from './apiMap';

設定全域性預設引數
axios.defaults.withCredentials = false;
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8';

設定請求預設引數
const instance = axios.create({
    baseURL: process.env.API_ROOT,
    timeout: 15 * 1000,
    auth: {
    	...
    },
    headers: {
      'Content-Type': 'application/json;charset=utf-8',
      'X-Requested-With': 'XMLHttpRequest',
    },
  },
);
設定請求攔截：
instance.interceptors.request.use(function (config) {
...
})
設定相應攔截：
// 響應攔截器即例外處理
instance.interceptors.response.use(response =>
   response
, (err) => {
  if (err && err.response) {
    switch (err.response.status) {
      case 400:
        err.message = '錯誤請求';
        break;
      case 401:
        err.message = '未授權，請重新登入';
        break;
      case 403:
        err.message = '拒絕存取';
        break;
      case 404:
        err.message = '請求錯誤,未找到該資源';
        break;
      case 405:
        err.message = '請求方法未允許';
        break;
      case 408:
        err.message = '請求超時';
        break;
       case 415:
        err.message = '伺服器無法處理請求附帶的媒體格式';
        break;
      case 500:
        err.message = '伺服器出錯';
        break;
      case 501:
        err.message = '網路未實現';
        break;
      case 502:
        err.message = '網路錯誤';
        break;
      case 503:
        err.message = '服務不可用';
        break;
      case 504:
        err.message = '網路超時';
        break;
      case 505:
        err.message = 'http版本不支援該請求';
        break;
      default:
        err.message = `連線錯誤${err.response.status}`;
    }
  } else {
    err.message = '連線到伺服器失敗';
  }
  return Promise.resolve(err.response);
});
封裝介面請求：
let api={
	/**
	
	* get 方法封裝
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	get (url, params = {}) {
	  return new Promise((resolve, reject) => {
		  instance.get(apiMap[url],params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* post
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	post (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.post(apiMap[url], params)
	      .then(res => {
	        resolve(res.data)
	      }, err => {
	        reject(err)
	      })
	  })
	},
	
	/**
	
	* delete 方法封裝
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	delete (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.delete(apiMap[url] ,params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* put 方法封裝
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	put (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.put(apiMap[url], params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* patch 方法封裝
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	patch (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.patch(apiMap[url], params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	}
}

export default api;

2、建立一個key-vlue形式的介面檔案，方便介面請求管理 apiMap.js

export default {
  // 主題列表
  key: 'path'
};

3、將index檔案引入vue入口檔案中

引入vue資源
import Vue from 'vue'
引入viewui外掛
import ViewUI from 'view-design';
引入viewuicss檔案
import 'view-design/dist/styles/iview.css';
匯入檔案|預設不需要加檔案字尾
import Api from '/index';
全域性繫結|$ 為範例屬性設定作用域
Vue.prototype.$api = Api;

全域性引數設定：

建立組態檔index.js：
import Vue from 'vue';
import Vuex from 'vuex';
import State from './state';
Vue.use(Vuex);
const store = new Vuex.Store(State);
export default store;
建立全域性引數詳細檔案state.js
export default {
	state: {   //這裡放全域性引數
		test: 0
	},
	mutations:{   //設定值
		test(state,value)=>state.test=value;
	},
	getters:{//返回值
		test: state =>state.test;
	}
};
呼叫方式：
var data = this.$store.getter.test;
var data = this.$store.commit('test',資料);

Vue.use(Vuex);
判斷vue是否已經註冊過vuex外掛；
將vuexInit函數混入到vue的beforeCreate生命週期中;
範例化vue時，會在vue每個範例上新增$store屬性，並將vuex的實例綁定到$store屬性上。