寫在最前面##
新手前端剛剛接觸vue,感覺真的好用定嗓。項目中需要使用axios蜕琴,然后學習了一下。借鑒網(wǎng)上一些大佬的經(jīng)驗宵溅,現(xiàn)在分享一下axios的簡單封裝凌简,如果有什么錯誤的地方,請大家指出恃逻。
axios安裝##
npm install axios --save
最最簡單的使用##
首先在src目錄下創(chuàng)建axios文件夾雏搂,然后創(chuàng)建index.js和fetch.js兩個文件。
fetch.js文件代碼如下:
import axios from 'axios'
//定義fetch函數(shù)寇损,config為配置
export function fetch(config){
//返回promise對象
return new Promise((resolve,reject) =>{
//創(chuàng)建axios實例凸郑,把基本的配置放進去
const instance = axios.create({
//定義請求文件類型
headers:{
'Content-Type': 'application/json',
},
timeout: 3000,
//定義請求根目錄
baseURL: 'http://www.xxx.com/'
});
//請求成功后執(zhí)行的函數(shù)
instance(config).then(res =>{
console.log(res);
resolve(res);
//失敗后執(zhí)行的函數(shù)
}).catch(err => {
console.log(err);
reject(err);
})
});
}
關(guān)于自定義const instance = axios.create({ }) 可以有很多配置,我只是寫了最基本的幾個矛市,官方都給了詳細說明芙沥,我這里也貼一下。
地址:https://www.kancloud.cn/yunye/axios/234845
{
// `url` 是用于請求的服務器 URL
url: '/user',
// `method` 是創(chuàng)建請求時使用的方法
method: 'get', // 默認是 get
// `baseURL` 將自動加在 `url` 前面,除非 `url` 是一個絕對 URL而昨。
// 它可以通過設置一個 `baseURL` 便于為 axios 實例的方法傳遞相對 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允許在向服務器發(fā)送前救氯,修改請求數(shù)據(jù)
// 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法
// 后面數(shù)組中的函數(shù)必須返回一個字符串,或 ArrayBuffer歌憨,或 Stream
transformRequest: [function (data) {
// 對 data 進行任意轉(zhuǎn)換處理
return data;
}],
// `transformResponse` 在傳遞給 then/catch 前着憨,允許修改響應數(shù)據(jù)
transformResponse: [function (data) {
// 對 data 進行任意轉(zhuǎn)換處理
return data;
}],
// `headers` 是即將被發(fā)送的自定義請求頭
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即將與請求一起發(fā)送的 URL 參數(shù)
// 必須是一個無格式對象(plain object)或 URLSearchParams 對象
params: {
ID: 12345
},
// `paramsSerializer` 是一個負責 `params` 序列化的函數(shù)
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function(params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
},
// `data` 是作為請求主體被發(fā)送的數(shù)據(jù)
// 只適用于這些請求方法 'PUT', 'POST', 和 'PATCH'
// 在沒有設置 `transformRequest` 時,必須是以下類型之一:
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 瀏覽器專屬:FormData, File, Blob
// - Node 專屬: Stream
data: {
firstName: 'Fred'
},
// `timeout` 指定請求超時的毫秒數(shù)(0 表示無超時時間)
// 如果請求話費了超過 `timeout` 的時間务嫡,請求將被中斷
timeout: 1000,
// `withCredentials` 表示跨域請求時是否需要使用憑證
withCredentials: false, // 默認的
// `adapter` 允許自定義處理請求享扔,以使測試更輕松
// 返回一個 promise 并應用一個有效的響應 (查閱 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示應該使用 HTTP 基礎驗證,并提供憑據(jù)
// 這將設置一個 `Authorization` 頭植袍,覆寫掉現(xiàn)有的任意使用 `headers` 設置的自定義 `Authorization`頭
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服務器響應的數(shù)據(jù)類型惧眠,可以是 '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` 定義允許的響應內(nèi)容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定義對于給定的HTTP 響應狀態(tài)碼是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者設置為 `null` 或 `undefined`)于个,promise 將被 resolve; 否則氛魁,promise 將被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // 默認的
},
// `maxRedirects` 定義在 node.js 中 follow 的最大重定向數(shù)目
// 如果設置為0,將不會 follow 任何重定向
maxRedirects: 5, // 默認的
// `httpAgent` 和 `httpsAgent` 分別在 node.js 中用于定義在執(zhí)行 http 和 https 時使用的自定義代理厅篓。允許像這樣配置選項:
// `keepAlive` 默認沒有啟用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// 'proxy' 定義代理服務器的主機名稱和端口
// `auth` 表示 HTTP 基礎驗證應當用于連接代理秀存,并提供憑據(jù)
// 這將會設置一個 `Proxy-Authorization` 頭,覆寫掉已有的通過使用 `header` 設置的自定義 `Proxy-Authorization` 頭羽氮。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: : {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消請求的 cancel token
// (查看后面的 Cancellation 這節(jié)了解更多)
cancelToken: new CancelToken(function (cancel) {
})
}
index.js 文件代碼如下:
//引入fetch.js文件
import { fetch } from './fetch'
//定義獲取數(shù)據(jù)的函數(shù)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為用戶傳入的參數(shù)叼耙,中間方法為'',默認'post'
getData('api/getdata', '', {a, b}).then(res => {
console.log(res);
}, err => {
console.log(err);
})
}
}
}
</script>
至此代碼就都ok了粒没,基本的功能都能用了筛婉。關(guān)于攔截器和錯誤處理,官方都有詳細說明癞松,而且很多大佬進行了更詳盡的封裝爽撒。我自己也是一知半解,還在學習响蓉,這里就不貼了硕勿。我本身也是個剛接觸前端,剛接觸vue的新手厕妖。如果上面有錯誤的地方首尼,歡迎大家指出。