新手axios封裝

寫在最前面##

新手前端剛剛接觸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的新手厕妖。如果上面有錯誤的地方首尼,歡迎大家指出。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末言秸,一起剝皮案震驚了整個濱河市软能,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌举畸,老刑警劉巖查排,帶你破解...
    沈念sama閱讀 216,651評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異抄沮,居然都是意外死亡跋核,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評論 3 392
  • 文/潘曉璐 我一進店門叛买,熙熙樓的掌柜王于貴愁眉苦臉地迎上來砂代,“玉大人,你說我怎么就攤上這事率挣】桃粒” “怎么了?”我有些...
    開封第一講書人閱讀 162,931評論 0 353
  • 文/不壞的土叔 我叫張陵椒功,是天一觀的道長捶箱。 經(jīng)常有香客問我,道長动漾,這世上最難降的妖魔是什么丁屎? 我笑而不...
    開封第一講書人閱讀 58,218評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮旱眯,結(jié)果婚禮上晨川,老公的妹妹穿的比我還像新娘。我一直安慰自己删豺,他們只是感情好础爬,可當我...
    茶點故事閱讀 67,234評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著吼鳞,像睡著了一般看蚜。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上赔桌,一...
    開封第一講書人閱讀 51,198評論 1 299
  • 那天供炎,我揣著相機與錄音,去河邊找鬼疾党。 笑死音诫,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的雪位。 我是一名探鬼主播竭钝,決...
    沈念sama閱讀 40,084評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了香罐?” 一聲冷哼從身側(cè)響起卧波,我...
    開封第一講書人閱讀 38,926評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎庇茫,沒想到半個月后港粱,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,341評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡旦签,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,563評論 2 333
  • 正文 我和宋清朗相戀三年查坪,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宁炫。...
    茶點故事閱讀 39,731評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡偿曙,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出羔巢,到底是詐尸還是另有隱情遥昧,我是刑警寧澤,帶...
    沈念sama閱讀 35,430評論 5 343
  • 正文 年R本政府宣布朵纷,位于F島的核電站炭臭,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏袍辞。R本人自食惡果不足惜鞋仍,卻給世界環(huán)境...
    茶點故事閱讀 41,036評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望搅吁。 院中可真熱鬧威创,春花似錦、人聲如沸谎懦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,676評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽界拦。三九已至吸申,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間享甸,已是汗流浹背截碴。 一陣腳步聲響...
    開封第一講書人閱讀 32,829評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留蛉威,地道東北人日丹。 一個月前我還...
    沈念sama閱讀 47,743評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像蚯嫌,于是被迫代替她去往敵國和親哲虾。 傳聞我的和親對象是個殘疾皇子丙躏,可洞房花燭夜當晚...
    茶點故事閱讀 44,629評論 2 354

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