axios簡單封裝
阿新 • • 發佈:2018-11-14
寫在最前面
新手前端剛剛接觸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的新手,如果上面有錯誤的地方,歡迎大家指出。