動態Axios配置

推薦使用Vue-cli工具來創建和管理項目,就算剛開始不熟悉,用著用著便可知曉其中的奧妙。前一段時間官方所推薦的數據請求插件還是Vue-resource,但現在已經變了,變成了Axios,不用知道為什么變了,反正這個用起來比那個好一些,用就是了,下面是一些封裝axios請求的一些經驗,不對之處,還望多多指教!

#01

創建文件,Vue項目初始化之后,在src目錄下再創建一個util工具文件夾,一般就是用來存放一些封裝的函數方法,現在讓我們在util文件目錄下創建一個http.js文件,封裝axios方法。

#02

直接上代碼(常規版),代碼中有詳細的注釋

import axios from 'axios' //引用axios
import {Promise} from 'es6-promise'   //引入Promise

// axios 配置
axios.defaults.timeout = 5000;  //設置超時時間
axios.defaults.baseURL = 'http://localhost:4000/api/v1/'; //這是調用數據接口

// http request 攔截器(所有發送的請求都要從這兒過一次),通過這個,我們就可以把token傳到后臺,我這里是使用sessionStorage來存儲token等權限信息和用戶信息,若要使用cookie可以自己封裝一個函數并import便可使用
axios.interceptors.request.use(
    config => {
        const token = sessionStorage.getItem("token"); //獲取存儲在本地的token
        config.data = JSON.stringify(config.data);
        config.headers = {
            'Content-Type':'application/json' //設置跨域頭部,雖然很多瀏覽器默認都是使用json傳數據,但咱要考慮IE瀏覽器。
        };
        if (token) {
            config.headers.Authorization = "Token " + token; //攜帶權限參數
        }
        return config;
    },
    err => {
        return Promise.reject(err);
    }
);


// http response 攔截器(所有接收到的請求都要從這兒過一次)
axios.interceptors.response.use(
    response => {
//response.status===401是我和后臺約定的權限丟失或者權限不夠返回的狀態碼,這個可以自己和后臺約定,約定返回某個自定義字段也是可以的
        if(response.status == 401) {
            router.push({ //push后面是一個參數對象,可以攜帶很多參數,具體可以去vue-router上查看,例如query字段表示攜帶的參數
                path: '/login' 
            })
        }
        return response;
    },
    error => {
        return Promise.reject(error.response.data)
    });

export default axios;

/**
 * fetch 請求方法
 * @param url
 * @param params
 * @returns {Promise}
 */
export function fetch(url, params = {}) {

    return new Promise((resolve, reject) => {
        axios.get(url, {
            params: params
        })
        .then(response => {
            resolve(response.data);
        })
        .catch(err => {
            reject(err)
        })
    })
}

/**
 * post 請求方法
 * @param url
 * @param data
 * @returns {Promise}
 */
export function post(url, data = {}) {
    return new Promise((resolve, reject) => {
        axios.post(url, data)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err);
            })
    })
}

/**
 * patch 方法封裝
 * @param url
 * @param data
 * @returns {Promise}
 */
export function patch(url, data = {}) {
    return new Promise((resolve, reject) => {
        axios.patch(url, data)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err);
            })
    })
}

/**
 * put 方法封裝
 * @param url
 * @param data
 * @returns {Promise}
 */
export function put(url, data = {}) {
    return new Promise((resolve, reject) => {
        axios.put(url, data)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err);
            })
    })
}

#03

(動態版)axios的攔截器不是必要的,不是每個項目都需要,而且headers里面的Content-TypeAuthorization不止一種,這時就需要使用另一種方法。

util/http.js

import axios from 'axios' //引用axios
import {Promise} from 'es6-promise'   //引入Promise

// axios 配置和攔截器都不用了,這里我使用了一個動態配置數據請求地址,在App.vue中,代碼在下面,這個也不是必須的。


//^_^下面都設置一個默認的頭部,使用的時候可以傳入數據覆蓋^_^,例如使用fetch(GET)方法時,沒有請求數據,但是請求頭有變化,則應寫成 fetch("地址", {}, {"這里寫頭部的內容"})   記住沒數據用一個空對象占位置
/**
 * fetch 請求方法
 * @param url
 * @param params
 * @returns {Promise}
 */
export function fetch(url, params = {}, headers = {
    'Content-Type': 'application/json', //設置跨域頭部
    "Authorization": 'JWT ' + sessionStorage.getItem("authToken")
}) {

    return new Promise((resolve, reject) => {
        axios.get(url, {
            params: params,
            headers: headers
        })
        .then(response => {
            resolve(response.data);
        })
        .catch(err => {
            reject(err.response)
        })
    })
}

/**
 * post 請求方法
 * @param url
 * @param data
 * @returns {Promise}
 */
export function post(url, data = {}, config = {
    "headers": {
        'Content-Type': 'application/json', //設置跨域頭部
        "Authorization": 'JWT ' + sessionStorage.getItem("authToken")
    }
}) {
    return new Promise((resolve, reject) => {
        axios.post(url, data, config)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err.response);
            })
    })
}

/**
 * patch 方法封裝
 * @param url
 * @param data
 * @returns {Promise}
 */
export function patch(url, data = {}, config = {
    "headers": {
        'Content-Type': 'application/json', //設置跨域頭部
        "Authorization": 'JWT ' + sessionStorage.getItem("authToken")
    }
}) {
    return new Promise((resolve, reject) => {
        axios.patch(url, data, config)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err.response);
            })
    })
}

/**
 * put 方法封裝
 * @param url
 * @param data
 * @returns {Promise}
 */
export function put(url, data = {}, config = {
    "headers": {
        'Content-Type': 'application/json', //設置跨域頭部
        "Authorization": 'JWT ' + sessionStorage.getItem("authToken")
    }
}) {
    return new Promise((resolve, reject) => {
        axios.put(url, data, config)
            .then(response => {
                resolve(response.data);
            }, err => {
                reject(err.response);
            })
    })
}

App.vue(這是在src目錄下的程序入口文件)

<template>
  <div id="app">
    <router-view/>
  </div>
</template>

<script>
import axios from 'axios';
let protocol = window.location.protocol; //協議
let host = window.location.host; //主機
let reg = /^localhost+/;
if(reg.test(host)) {
  //若本地項目調試使用
  axios.defaults.baseURL = 'http://10.0.xx.xxx:xxxx/api/';
} else {
  //動態請求地址
  axios.defaults.baseURL = protocol + "http://" + host + "/api/";
}
axios.defaults.timeout = 30000;
export default {
  name: 'app',
  axios   //這里記得導出,若請求地址永久固定一個,則就按照`普通版`配置一個baserURL就可以了
}
</script>

<style lang="scss">  //這里我使用的是scss
@import '~@/style/style'
</style>

04

總結

  • 常見問題

    • 在使用動態版時,為什么稱為動態呢,是因為訪問地址和請求地址是同一個地址可端口號,例如我通過http://www.cmgos.com(默認端口80)訪問項目,那么我的baseURL會自動的變為http:www.cmgos.com:80/api/,這么做的原因是當某一天項目遷移或者http改為https時,不用你再去更改請求地址,程序自動就完成了
    • 數據請求地址配置不正確?如果你配置了baseURL,那么你封裝的函數在使用時僅需傳入基于baseURL的請求地址,例如傳入login/那么請求地址會自動變為http:www.cmgos.com:80/api/login/,若未配置,那么可以直接傳入整個請求地址
  • 注意事項

    • 在使用動態版時,由于沒有使用攔截器,所以下面封裝的函數在返回錯誤的時候需要寫成err.response.data來獲取返回的數據,但我寫的是err.response,因為這樣可以拿到(status)狀態碼等信息,若不需要判斷返回的狀態碼,則改為err.response.data便可

博客地址:http://www.keyup.top

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,106評論 6 542
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,441評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,211評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,736評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,475評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,834評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,829評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,009評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,559評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,306評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,516評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,038評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,728評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,132評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,443評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,249評論 3 399
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,484評論 2 379

推薦閱讀更多精彩內容