axios使用详解

文档

1. 拦截器

1.1 请求拦截器

  • 基本格式
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
}, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
});
  • 可以添加一些头部信息
// 判读用户token是否存在
export const uaFlag = function () {
  return true
  // let idToken = localStore.getLocalStore('token')
  // if (idToken) {
  //   return true
  // } else {
  //   console.warn('require user_auth')
  //   window.location.href = LOGIN_URL(true)
  //   return false
  // }
}

// 统一设置token信息
// const idToken = localStore.getLocalStore('token')
// if(idToken){
//   axios.defaults.headers.common['AUTHORIZATION'] = idToken
// }

// request
// POST传参序列化(添加请求拦截器)
axios.interceptors.request.use((config) => {
  if (config.method === 'post') {
    // 序列化
    // config.data = qs.stringify(config.data);
  }
  if (uaFlag) {
    // 上面统一设置了token,也可以在这里设置
    // let idToken = localStore.getLocalStore('token')
    // config.headers['AUTHORIZATION'] = idToken
  }
  return config
}, (error) => {
  return Promise.reject(error)
})


1.2 响应拦截器

  • axios响应时,基本信息的捕获
axios.interceptors.response.use((response) => {
  // 请求已发出,服务器响应的状态码在 2xx 范围内的都会在这里
  console.log(response.status);
  console.log(response.statusText);
  console.log(response.headers);
  console.log(response.config);
  return response
}, (error) => {
  if (error.response) {
    // 请求已发出,但服务器响应的状态码不在 2xx 范围内
    console.log(error.response.data); // 一般错误信息会放在data.message下
    console.log(error.response.status);
    console.log(error.response.headers);
  } else {
    // Something happened in setting up the request that triggered an Error
    // 超时等会在这里触发,获取错误信息,直接使用error.message即可
    console.log('Error', error.message);
  }
  console.log(error.config)
  return Promise.reject(error);
}
  • 改造
// response
// 返回状态判断(添加响应拦截器)
axios.interceptors.response.use((response) => {
  // 一般restful规范的接口在这里接收到的都是正确数据,直接返回数据即可
  return response.data
  
  // 不是restfull规范的接口,错误信息也是通过200状态码返回的,里面的格式一般会是
  // success
  // {
  //   code: 0,
  //   data: [],
  //   message: 'ok'
  // }
  // // error
  // {
  //   code: -1,
  //   message: '错误信息'
  // }
  // console.log(response.data);
  // if (response.data.code !== 0) {
  //   return Promise.reject(response.data.message)
  // } else {
  //   return response.data.data
  // }
}, (error) => {
  if (error.response) {
    if (error.response.status === 401) { // 未登陆
      vm.$router.push({
        name: 'login'
      })
    }
    // 一般的错误信息都会放在data.message中,对于restful规范的接口,错误信息可能不在这里,需要根据实际情况捕获。如:有的在response.text中
    return Promise.reject(error.response.data.message)
  } else {
    // Something happened in setting up the request that triggered an Error
    // 超时等会在这里触发,获取错误信息,直接使用error.message即可
    return Promise.reject(error.message)
  }
})


export const _get = (url, params = null) => {
  const promise = axios.get(url, { params: params })
  return new Promise((resolve, reject) => {
    promise.then((result) => {
      resolve(result)
    }).catch((error) => {
      // 一般会有弹框显示错误信息
      // 如果没有特殊要求,在这里打印错误即可,在调用处不用捕获错误信息,因为在调用处捕获到错误一般也只是打印一下错误信息。
      reject(error) // 拦截器已过滤,这里是错误信息内容
    })
  })
}


2. 一个完整的api-util.js文件

import axios from 'axios'
// import qs from 'qs'
import Vue from 'vue'
import router from '@/router'

// import localStore from './localStore'

let vm = new Vue({ router })
const ENV = process.env.NODE_ENV

const baseUrl = ENV === 'development'
  ? 'http://www.imooc.com/api'
  : ENV === 'production'
    ? 'http://www.imooc.com/api'
    : 'http://www.imooc.com/api'
axios.defaults.baseURL = baseUrl

axios.defaults.timeout = 10000
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'
// 防止ie缓存
if (navigator.userAgent.indexOf('MSIE 9') > -1) {
  axios.defaults.headers.common['If-Modified-Since'] = '0'
}

export const uaFlag = function () {
  return true
  // let idToken = localStore.getLocalStore('token')
  // if (idToken) {
  //   return true
  // } else {
  //   console.warn('require user_auth')
  //   window.location.href = LOGIN_URL(true)
  //   return false
  // }
}

// 统一设置token信息
// const idToken = localStore.getLocalStore('token')
// if(idToken){
//   axios.defaults.headers.common['AUTHORIZATION'] = idToken
// }

// request
// POST传参序列化(添加请求拦截器)
axios.interceptors.request.use((config) => {
  if (config.method === 'post') {
    // 序列化
    // config.data = qs.stringify(config.data);
  }
  if (uaFlag) {
    // 上面统一设置了token,也可以在这里设置
    // let idToken = localStore.getLocalStore('token')
    // config.headers['AUTHORIZATION'] = idToken
  }
  return config
}, (error) => {
  return Promise.reject(error)
})

// response
// 返回状态判断(添加响应拦截器)
axios.interceptors.response.use((res) => {
  return res.data
}, (error) => {
  if (error.response) {
    if (error.response.status === 401) { // 未登陆
      vm.$router.push({
        name: 'login'
      })
    }
    return Promise.reject(error.response.data.message)
  } else {
    return Promise.reject(error.message)
  }
})

export const joinURL = function (...urls) {
  return '/' + urls.join('/')
}

export const _get = (url, params = null) => {
  const promise = axios.get(url, { params: params })
  return new Promise((resolve, reject) => {
    promise.then((result) => {
      resolve(result)
    }).catch((error) => {
      // 一般会有弹框显示错误信息
      reject(error) // 拦截器已过滤,这里是错误信息
    })
  })
}

export const _post = (url, data) => {
  const promise = axios.post(url, data)
  return new Promise((resolve, reject) => {
    promise.then((result) => {
      resolve(result)
    }).catch((error) => {
      // 一般会有弹框显示错误信息
      reject(error) // 拦截器已过滤,这里是错误信息
    })
  })
}

export const _patch = (url, data) => {
  const promise = axios.patch(url, data)
  return new Promise((resolve, reject) => {
    promise.then((result) => {
      resolve(result)
    }).catch((error) => {
      // 一般会有弹框显示错误信息
      reject(error) // 拦截器已过滤,这里是错误信息
    })
  })
}

export const _delete = (url) => {
  const promise = axios.delete(url)
  return new Promise((resolve, reject) => {
    promise.then((result) => {
      resolve(result)
    }).catch((error) => {
      // 一般会有弹框显示错误信息
      reject(error) // 拦截器已过滤,这里是错误信息
    })
  })
}

3. api.js文件

import {
  _get,
  _post,
  joinURL
} from './util'

export default {
  login (data) {
    let url = '/login'
    return _post(url, data)
  },

  listUser () {
    let url = joinURL('users')
    return _get(url)
  },

  listHomeSlider () {
    let url = joinURL('home', 'sliders')
    return _get(url)
  }
}

4. 组件中使用

import api '@/api/api'
...

methods: {
    getSlider () {
        this.sliderLoading = true
        api.listHomeSlider().then(res => {
            this.sliderLoading = false
            if (res.code === 0) {
                this.sliders = res.slider
            } else {
                this.sliders = []
                console.log('获取数据失败', res.message)
            }
        }).catch(() => {
            this.sliderLoading = false
            this.sliders = []
        })
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,884评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,212评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,351评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,412评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,438评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,127评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,714评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,636评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,173评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,264评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,402评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,073评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,763评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,253评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,382评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,749评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,403评论 2 358

推荐阅读更多精彩内容