axios在vue-cli項目中的封裝使用

axios是一個promise實現(xiàn)的http庫匈子,符合最新的ES規(guī)范蛀恩。我們?yōu)樯兑眠@個東西呢让歼,主要有以下幾個原因:

  • 從瀏覽器中創(chuàng)建 XMLHttpRequests
  • 從 node.js 創(chuàng)建 http 請求
  • 攔截請求和響應
  • 轉換請求數(shù)據(jù)和響應數(shù)據(jù)
  • 支持 Promise API(可以配合ES7的async await使用,解決回調地獄)
  • 客戶端支持防止CSRF
  • 提供了一些并發(fā)請求的接口
  • 輕量箕般,體積小

搞起

要想把axios裝項目甸昏,攏共分3部:

  1. IE兼容性處理
  2. 封裝顽分、配置axios
  3. 把他掛到vue的prototype上(這樣就不用每個文件都引入了)

IE兼容處理

axios是promise實現(xiàn)的,提到promise施蜜,首先應該想到IE不支持卒蘸,所以應該先加個墊片,給IE做下兼容性處理
npm install --save babel-polyfill

然后再main.js中引入

import 'babel-polyfill'

封裝axios

先安裝axios
npm install --save axios

然后建議在src下新建一個文件夾api專門用來存放接口相關的文件和配置翻默,貼一下我的目錄結構

src
├── ...
├── main.js
├── App.vue
├── api
    ├── unsplash
        ├── index.js
        └── urls.js
    ├── apiList.js
    ├── axios.js
    ├── index.js
    └── install.js
└── common    #工具文件夾
    ├── utils.js
    └── browser.js

下面是請求和響應攔截等相關配置
需要的同學點這個看代碼browser.js
src/api/axios.js

import axios from 'axios'
import browser from '../common/browser'

// 創(chuàng)建 axios 實例
let http = axios.create({
  // headers: {'Content-Type': 'application/json'},
  timeout: 60000
})

// 設置 post缸沃、put 默認 Content-Type
http.defaults.headers.post['Content-Type'] = 'application/json'
http.defaults.headers.put['Content-Type'] = 'application/json'

// 添加請求攔截器
http.interceptors.request.use(config => {
  if (config.method === 'post' || config.method === 'put') {
    // post、put 提交時修械,將對象轉換為string, 為處理Java后臺解析問題
    config.data = JSON.stringify(config.data)
  } else if (config.method === 'get' && browser.isIE) {
    // 給GET 請求后追加時間戳案糙, 解決IE GET 請求緩存問題
    let symbol = config.url.indexOf('?') >= 0 ? '&' : '?'
    config.url += symbol + '_=' + Date.now()
  }
  // 請求發(fā)送前進行處理
  return config
}, error => {
  // 請求錯誤處理
  return Promise.reject(error)
})

// 添加響應攔截器
http.interceptors.response.use(response => {
  let {data} = response
  return data
}, error => {
  let info = {}
  let {status, statusText, data} = error.response
  if (!error.response) {
    info = {
      code: 5000,
      msg: 'Network Error'
    }
  } else {
    // 此處整理錯誤信息格式
    info = {
      code: status,
      data: data,
      msg: statusText
    }
  }
  return Promise.reject(info)
})

/**
 * 創(chuàng)建統(tǒng)一封裝過的 axios 實例
 * @return {AxiosInstance}
 */
export default function () {
  return http
}

如果需要前端做登陸校驗的签则,可以在上面的請求攔截器中添加相關邏輯
其他配置項還有很多遣臼,具體可以查看axios中文說明


封裝常用請求方法
src/api/index.js

import axios from './axios'

let instance = axios()
export default {
  get (url, params, headers) {
    let options = {}
    if (params) {
      options.params = params
    }
    if (headers) {
      options.headers = headers
    }
    return instance.get(url, options)
  },
  post (url, params, headers) {
    let options = {}
    if (headers) {
      options.headers = headers
    }
    return instance.post(url, params, options)
  },
  put  (url, params, headers) {
    let options = {}
    if (headers) {
      options.headers = headers
    }
    return instance.put(url, params, options)
  },
  delete (url, params, headers) {
    let options = {}
    if (params) {
      options.params = params
    }
    if (headers) {
      options.headers = headers
    }
    return instance.delete(url, options)
  }
}

到此axios就封裝好了


接下來我們把接口的URL和調用方法也寫在這個文件夾里彩届,建議按模塊劃分文件夾。下面用圖片網(wǎng)站unsplash的api舉例說明蹦渣,此處肯定要涉及到跨域問題哄芜,如果對跨域問題不了解,推薦一篇文章剂桥,講的很棒忠烛。
unsplash的做法是CORS属提,全稱是"跨域資源共享"(Cross-origin resource sharing)跨域資源共享 CORS 詳解权逗,前端啥也不用做美尸,正常發(fā)請求就ok了

src/api/unsplash/url.js(這個文件存放所有模塊相關URL地址)

const baseUrl = 'https://api.unsplash.com'

export default {
  // 圖片列表
  photos: baseUrl + '/photos'
}

src/api/unsplash/index.js

import api from '../index'
import urls from './urls'
// import { formatUrl } from '../../common/utils'
// 這個東西是unsplash要求加在header里的驗證,有興趣的同學可以去看他的api斟薇,此處不再贅述
const header = {
  'Authorization': 'Client-ID xxxxxxx'
}

export default {
  viewPhotos (params) {
    // return出去了一個promise
    return api.get(urls.photos, params, header)
  }
}

這些都做完之后师坎,把所有模塊的調用都整合到一個文件里,(這里拆這么細堪滨,項目比較大胯陋,模塊比較多的時候就會體現(xiàn)出好處,方便統(tǒng)一管理)

src/api/apiList.js

// 有多少import多少
import unsplash from './unsplash'

export default {
  unsplash
}

掛到Vue的prototype

該配的該寫的都整完了袱箱,最后一步把大象裝冰箱遏乔。。啊不发笔,是把他掛prototype上

src/api/install.js

// 導入模塊
import apiList from './apiList'

const install = function (Vue) {
  if (install.installed) return
  install.installed = true
  Object.defineProperties(Vue.prototype, {
    $api: {
      get () {
        return apiList
      },
      enumerable: false, // 不可枚舉
      configurable: false // 不可重寫
    }
  })
}

export default {
  install
}

最后把這個install.js在main.js里引一下盟萨,再use一下就ok了

import 'babel-polyfill'
import Vue from 'vue'
import api from './api/install'
import App from './App'
import router from './router'
import store from './store'

Vue.use(api)
/* eslint-disable no-new */
new Vue({
  el: '#app',
  router,
  store,
  template: '<App/>',
  components: { App }
})

接下來我們就可以愉快地使用了

隨便找個頁面

<template>
  <div class="waterfall">
  </div>
</template>

<script>
  export default {
    name: 'waterfall',
    data () {
      return {
        photosList: []
      }
    },
    created () {
      this.getPhotos()
    },
    mounted () {
    },
    computed: {
    },
    watch: {
    },
    methods: {
      // async await 是ES7新特性,本質上是generator函數(shù)的語法糖
      async getPhotos () {
        // 這里用try catch包裹了讨,請求失敗的時候就執(zhí)行catch里的
        try {
          let params = {
            page: 1,
            per_page: 1,
            order_by: 'latest'
          }
          let res = await this.$api.unsplash.viewPhotos(params)
          this.photosList = res
          console.log(res)
        } catch (e) {
          console.log(e)
        }
      }

    }
  }
</script>

<style lang="less">
</style>

如果報了async await的錯捻激,就還得配一下根目錄的.babelrc,先安裝
npm install --save-dev babel-plugin-transform-runtime
npm install --save-dev babel-preset-stage-0

.babelrc

{
  "presets": [
    ["env", { "modules": false }],
    "stage-0"
  ],
  "plugins": [[
    "transform-runtime",
    {
      "helpers": false,
      "polyfill": false,
      "regenerator": true,
      "moduleName": "babel-runtime"
    }
  ]]
}

總結

以上就是把axios整合進項目的全部步驟前计,一般項目配置這些就夠用了胞谭,要想玩兒的更6,還是得擼文檔啊男杈。丈屹。

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市伶棒,隨后出現(xiàn)的幾起案子泉瞻,更是在濱河造成了極大的恐慌,老刑警劉巖苞冯,帶你破解...
    沈念sama閱讀 211,639評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件袖牙,死亡現(xiàn)場離奇詭異,居然都是意外死亡舅锄,警方通過查閱死者的電腦和手機鞭达,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,277評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來皇忿,“玉大人畴蹭,你說我怎么就攤上這事△⑺福” “怎么了叨襟?”我有些...
    開封第一講書人閱讀 157,221評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長幔荒。 經(jīng)常有香客問我糊闽,道長梳玫,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,474評論 1 283
  • 正文 為了忘掉前任右犹,我火速辦了婚禮提澎,結果婚禮上,老公的妹妹穿的比我還像新娘念链。我一直安慰自己盼忌,他們只是感情好,可當我...
    茶點故事閱讀 65,570評論 6 386
  • 文/花漫 我一把揭開白布掂墓。 她就那樣靜靜地躺著谦纱,像睡著了一般。 火紅的嫁衣襯著肌膚如雪君编。 梳的紋絲不亂的頭發(fā)上服协,一...
    開封第一講書人閱讀 49,816評論 1 290
  • 那天,我揣著相機與錄音啦粹,去河邊找鬼偿荷。 笑死,一個胖子當著我的面吹牛唠椭,可吹牛的內(nèi)容都是我干的跳纳。 我是一名探鬼主播,決...
    沈念sama閱讀 38,957評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼贪嫂,長吁一口氣:“原來是場噩夢啊……” “哼寺庄!你這毒婦竟也來了?” 一聲冷哼從身側響起力崇,我...
    開封第一講書人閱讀 37,718評論 0 266
  • 序言:老撾萬榮一對情侶失蹤斗塘,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后亮靴,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體馍盟,經(jīng)...
    沈念sama閱讀 44,176評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,511評論 2 327
  • 正文 我和宋清朗相戀三年茧吊,在試婚紗的時候發(fā)現(xiàn)自己被綠了贞岭。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,646評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡搓侄,死狀恐怖瞄桨,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情讶踪,我是刑警寧澤芯侥,帶...
    沈念sama閱讀 34,322評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站乳讥,受9級特大地震影響柱查,放射性物質發(fā)生泄漏廓俭。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,934評論 3 313
  • 文/蒙蒙 一物赶、第九天 我趴在偏房一處隱蔽的房頂上張望白指。 院中可真熱鬧留晚,春花似錦酵紫、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,755評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至赋焕,卻和暖如春参歹,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背隆判。 一陣腳步聲響...
    開封第一講書人閱讀 31,987評論 1 266
  • 我被黑心中介騙來泰國打工犬庇, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人侨嘀。 一個月前我還...
    沈念sama閱讀 46,358評論 2 360
  • 正文 我出身青樓臭挽,卻偏偏與公主長得像,于是被迫代替她去往敵國和親咬腕。 傳聞我的和親對象是個殘疾皇子欢峰,可洞房花燭夜當晚...
    茶點故事閱讀 43,514評論 2 348

推薦閱讀更多精彩內(nèi)容