vue項目axios使用及axios的配置介紹

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

http://www.axios-js.com/zh-cn/docs/index.html

以下主要是Vue項目使用方式的介紹

一、axios的使用介紹

1、下載該組件

npm install axios

2、在main.js引入

import * as axios from './axios/'
Vue.prototype.$axios = axios

3、新建axios文件統一設置axios配置（下面是簡單使用，更多配置查看下面內容）

//axios文件
import axios from 'axios'
const base = '/api'
//接口申明
//post請求
const getSms = params => {
    return service.post(base + '/code', params)
}
//get請求
const getSms2 = params => {
    return service.get(base + '/code', {params})
}
//接口導出
export {
    getSms，
    getSms2
}

4、組件使用：

//這裏在main.js文件統一引入了接口，所以可以使用this.$axios直接調用
let res = await this.$axios.getSms({ phone: this.phoneNum })

二、axios的項目的基本配置

1、設置全局的 axios 默認值

直接使用axios設置
axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded’;
2. 或者創建實例，設置實例默認值
const service = axios.create({
    timeout: 10000,
    baseURL: `/`
})

2、接口返回即響應

某個請求的響應包含以下信息
{
  // `data` 由服務器提供的響應
  data: {},
  // `status` 來自服務器響應的 HTTP 狀態碼
  status: 200,
  // `statusText` 來自服務器響應的 HTTP 狀態信息
  statusText: 'OK',
  // `headers` 服務器響應的頭
  headers: {},
  // `config` 是爲請求提供的配置信息
  config: {}
}

3、axios攔截器使用

// 添加請求攔截器，對請求信息做統一處理
service.interceptors.request.use(
config => {
// 在發送請求之前做些什麼
console.log('config', config)
// 比如根據token統一設置請求header頭
return config
},
error => {
// 對請求錯誤做些什麼
console.log('接口請求錯誤')
return Promise.reject(error)
})
// 添加響應攔截器，對接口的返回數據做統一的處理
service.interceptors.response.use(res => {
// 對響應數據做點什麼
if (res.data.code === 22000) {
console.log('接口返回成功')
} else if (res.data.code === 22001) {
console.log('接口返回有誤')
}
// 根據接口code做不同處理
switch (res.data.code) {
case 22000:
console.log('接口返回正常')
break
case 22001:
console.log(res.data.message)
break
case 22002:
break
case 22003:
break
case 22004:
break
default:
console.log('默認')
}
return res
}, error => {
// 對響應錯誤做點什麼
console.log('接口返回錯誤信息：', error)
return Promise.reject(error)
})

三、請求配置參數介紹

只有url屬性是必須的其他都是非必須，默認是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) {
  })
}