Vue 封装axios

axios

Axios 是一个基于 promise 网络请求库，作用于node.js 和浏览器中。 它是 isomorphic 的(即同一套代码可以运行在浏览器和node.js中)。在服务端它使用原生 node.js http 模块, 而在客户端 (浏览端) 则使用 XMLHttpRequests。

安装

使用 npm:

$ npm install axios

使用 bower:

$ bower install axios

使用 yarn:

$ yarn add axios

使用 jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

请求配置

{ // `url` 是用于请求的服务器 URL
url: '/user', 
// `method` 是创建请求时使用的方法 
method: 'get', // 默认值 
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL 
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允许在向服务器发送前，修改请求数据 
// 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法 
// 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream 
// 你可以修改请求头。 
transformRequest: [function (data, headers) { 
// 对发送的 data 进行任意转换处理 return data; }], 
// `transformResponse` 在传递给 then/catch 前，允许修改响应数据 
transformResponse: [function (data) { 
// 对接收的 data 进行任意转换处理 return data; }], 
// 自定义请求头 
headers: {'X-Requested-With': 'XMLHttpRequest'}, 
// `params` 是与请求一起发送的 URL 参数 
// 必须是一个简单对象或 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', 'DELETE 和 'PATCH' 请求方法 
// 在没有设置 `transformRequest` 时，则必须是以下类型之一: 
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams 
// - 浏览器专属: FormData, File, Blob 
// - Node 专属: Stream, Buffer data: { firstName: 'Fred' }, 
// 发送请求体数据的可选语法 // 请求方式 post 
// 只有 value 会被发送，key 则不会 
data: 'Country=Brasil&City=Belo Horizonte', 
// `timeout` 指定请求超时的毫秒数。 
// 如果请求时间超过 `timeout` 的值，则请求会被中断 timeout: 1000, 
// 默认值是 `0` (永不超时) 
// `withCredentials` 表示跨域请求时是否需要使用凭证 
withCredentials: false, 
// default
// `adapter` 允许自定义处理请求，这使测试更加容易。
// 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。 
adapter: function (config) { /* ... */ }, 
// `auth` HTTP Basic Auth 
auth: { username: 'janedoe', password: 's00pers3cret' }, 
// `responseType` 表示浏览器将要响应的数据类型
// 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream' 
// 浏览器专属：'blob' 
responseType: 'json', // 默认值 
// `responseEncoding` 表示用于解码响应的编码 (Node.js 专属) 
// 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求 
// Note: Ignored for `responseType` of 'stream' or client-side requests 
responseEncoding: 'utf8', // 默认值 
// `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称 
xsrfCookieName: 'XSRF-TOKEN', // 默认值 
// `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称 xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值 
// `onUploadProgress` 允许为上传处理进度事件 
// 浏览器专属
onUploadProgress: function (progressEvent) {
// 处理原生进度事件 }, 
// `onDownloadProgress` 允许为下载处理进度事件 
// 浏览器专属 
onDownloadProgress: function (progressEvent) { 
// 处理原生进度事件 }, 
// `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数 
maxContentLength: 2000, 
// `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数 
maxBodyLength: 2000, 
// `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。 
// 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)， 
// 则promise 将会 resolved，否则是 rejected。
validateStatus: function (status) { 
    return status >= 200 && status < 300; // 默认值
 }, 
 // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。 
 // 如果设置为0，则不会进行重定向 
 maxRedirects: 5,// 默认值 
 // `socketPath` 定义了在node.js中使用的UNIX套接字。 
 // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。 
 // 只能指定 `socketPath` 或 `proxy` 。 
 // 若都指定，这使用 `socketPath` 。 
 socketPath: null, // default 
 // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http 
 // and https requests, respectively, in node.js. This allows options to be added like 
 // `keepAlive` that are not enabled by default.
 httpAgent: new http.Agent({ keepAlive: true }), 
 httpsAgent: new https.Agent({ keepAlive: true }), 
 // `proxy` 定义了代理服务器的主机名，端口和协议。 
 // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。 
 // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。 
 // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。 
 // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
 // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https` 
 proxy: { 
     protocol: 'https', 
     host: '127.0.0.1', 
     port: 9000, 
     auth: { username: 'mikeymike', password: 'rapunz3l' } 
 }, 
 
 // see https://axios-http.com/zh/docs/cancellation 
 cancelToken: new CancelToken(function (cancel) { }),
 // `decompress` indicates whether or not the response body should be decompressed 
 // automatically. If set to `true` will also remove the 'content-encoding' header
 // from the responses objects of all decompressed responses 
 // - Node only (XHR cannot turn off decompression) 
 decompress: true // 默认值 
}

响应结构

{ 
    // `data` 由服务器提供的响应 
    data: {}, 
    // `status` 来自服务器响应的 HTTP 状态码
    status: 200, 
    // `statusText` 来自服务器响应的 HTTP 状态信息 
    statusText: 'OK', 
    // `headers` 是服务器响应头 
    // 所有的 header 名称都是小写，而且可以使用方括号语法访问 
    // 例如: `response.headers['content-type']` 
    headers: {}, 
    // `config` 是 `axios` 请求的配置信息 
    config: {}, 
    // `request` 是生成此响应的请求 
    // 在node.js中它是最后一个ClientRequest实例 (in redirects)， 
    // 在浏览器中则是 XMLHttpRequest 实例 
    request: {} 
}

拦截器

    // 添加请求拦截器 
    axios.interceptors.request.use(
        function (config) { 
            // 在发送请求之前做些什么 
            return config; 
        }, 
        function (error) { 
        // 对请求错误做些什么 
            return Promise.reject(error); 
        }
    );
    
    // 添加响应拦截器 
    axios.interceptors.response.use(
        function (response) { 
            // 2xx 范围内的状态码都会触发该函数。 
            // 对响应数据做点什么 
            return response; 
        }, 
        function (error) { 
            // 超出 2xx 范围的状态码都会触发该函数。 
            // 对响应错误做点什么 
            return Promise.reject(error); 
        }
    );

如果你稍后需要移除拦截器，可以这样：

const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

错误处理

使用 validateStatus 配置选项，可以自定义抛出错误的 HTTP code。

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 处理状态码小于500的情况
  }
})

使用 toJSON 可以获取更多关于HTTP错误的信息。

axios.get('/user/12345')
  .catch(function (error) {
    console.log(error.toJSON());
  });

取消请求

AbortController

const controller = new AbortController(); 
axios.get('/foo/bar', { 
    signal: controller.signal 
}).then(function(response) { //... }); 
// 取消请求 
controller.abort()

CancelToken

此 API 从 v0.22.0 开始已被弃用，不应在新项目中使用。

const CancelToken = axios.CancelToken; 
const source = CancelToken.source(); 
axios.get('/user/12345', { 
    cancelToken: source.token 
}).catch(function (thrown) { 
    if (axios.isCancel(thrown)) { 
        console.log('Request canceled', thrown.message); 
     } else { // 处理错误 } 
});
axios.post('/user/12345', {
        name: 'new name' 
     }, {
       cancelToken: source.token
 }) // 取消请求（message 参数是可选的） 
 source.cancel('Operation canceled by the user.');

封装axios

在utils文件下创建request.js

request.js：

import axios from 'axios' //引入axios
import notification from 'ant-design-vue/es/notification'

// 创建 axios 实例
const request = axios.create({
  // API 请求的默认前缀
  baseURL: process.env.VUE_APP_API_BASE_URL,
  timeout: 60000 // 请求超时时间
})

// 异常拦截处理器 浏览器
const errorHandler = (error) => {
  if (error.response) {
    const data = error.response.data
    // 从 localstorage 获取 token
    const token = storage.get(ACCESS_TOKEN)
    if (error.response.status === 403) {
      if (token) {
        store.dispatch('Logout').then(() => {
          setTimeout(() => {
            window.location.reload()
          }, 1500)
        })
      }
    }
    if (error.response.status === 401 && !(data.result && data.result.isLogin)) {
      notification.error({
        message: '登录失效',
        description: data.message || '请重新登录'
      })
      if (token) {
        store.dispatch('Logout').then(() => {
          setTimeout(() => {
            window.location.reload()
          }, 1500)
        })
      }
    }
    if (error.response.status === 502) {
        notification.error({
          message: '服务暂时不可用，请稍后再试'
        })
      return
    }
    if (data.message && (data.message !== 'Internal Server Error')) {
      notification.error({
        message: '错误原因',
        description: data.message
      })
    } else {
      if (typeof data === 'object') {
        data.message = null
        // notificationError({
        //   message: '失败',
        //   description: '请重试'
        // })
      }
    }
    return Promise.reject(data)
  }
  return Promise.reject(error)
}

request.interceptors.request.use(config => {
  const token = storage.get(ACCESS_TOKEN)
  // 如果 token 存在
  // 让每个请求携带自定义 token 请根据实际情况自行修改
  if (token) {
    config.headers['Access-Token'] = token
  }
  return config
}, errorHandler)

// response interceptor
request.interceptors.response.use((response) => {
  if (response.data.code && response.data.code === 401) {
    store.dispatch('Logout2').then(() => {
      setTimeout(() => {
        window.location.reload()
      }, 500)
    })
    return response.data
  }
  if (response.data.code && response.data.code !== 200) {
    const errMsg = response.data.message
    if (errMsg && (errMsg !== 'Internal Server Error')) {
      notificationError({
        description: errMsg
      })
    } else {
      if (typeof response.data === 'object') {
        response.data.message = null
      }
    }
    return Promise.reject(response.data)
  }
  return response.data
}, errorHandler)

const installer = {
  vm: {},
  install (Vue) {
    Vue.use(VueAxios, request)
  }
}

export default request

若增加post、delete、可添加：

const requestDelete = (params) => {
  return request({
    ...params,
    method: 'delete'
  })
}

const post = (params) => {
  return request({
    ...params,
    method: 'post'
  })
}
export {
  post,
  requestDelete
}

使用

例如user.js

import request, { post, requestDelete } from '@/utils/request'
const UserApi = {
    GetUserList: '/api/get/user/list',
    SaveUser: '/api/save/user',
    DeleteUser: '/api/delete/user',
}

export function getUserList (parameter) {
  return request({
    url: UserApi.GetUserList,
    parameter
  })
}
export function saveUser (parameter) {
  return post({
    url: UserApi.SaveUser,
    data: parameter
  })
}
export function deleteUser (parameter) {
  return requestDelete({
    url: `${UserApi.DeleteUser}/${parameter}`
  })
}

vue中引用

例如saveUser.vue：

import { saveUser } from '@/api/user.js'
export default {
    methods: {
        saveUser (data) {
            saveUser(data).then(() => {
                this.$messageSuccess('保存成功')
            }).catch(err => {
                this.$messageError('保存失败')
            }).finally(() => {
                /* …… */
            })
        }
    }
}

若有不规范，后续会更新

参考起步 | Axios 中文文档 | Axios 中文网 (axios-http.cn)