基于axios的请求函数封装

axios初识

axios是现代前端框架当中广泛应用的基于Promise的HTTP库，它可以运行在浏览器环境和node环境当中。它的优点特性包括：

• 支持Promise，减轻callback代码带来的阅读负担
• 能够对请求和相应进行拦截，能够进行更多的符合业务需求的操作
• 客户端环境当中支持防御XSRF

axios API

axios发起请求的最简单调用形式：

• axios(config)
• axios(url[, config])

另外，为了简化代码并且使得调用请求的方式更加语义化，axios为各种请求方式提供了快捷调用：

• axios.request(config)
• axios.get(url[, config])
• axios.delete(url[, config])
• axios.head(url[, config])
• axios.options(url[, config])
• axios.post(url[, data[, config]])
• axios.put(url[, data[, config]])
• axios.patch(url[, data[, config]])

以上的调用方式都是直接使用axios进行方法调用，axios提供了创建实例的方法，通过实例同样可以使用所有请求功能，并且可以根据需求进行相应的配置。

axios.create([config])

const BASEURL = 'https://www.chebaba.com';
const TIME_OUT = 10000;

const instance = axios.create({
  baseURL: BASEURL,
  timeout: TIME_OUT
});

axios请求提供的所有配置参数如下：

{
  // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // default

  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data, headers) {
    // 对 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, // default

  // `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', // default

  // `responseEncoding` indicates encoding to use for decoding responses
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

   // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

   // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `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; // default
  },

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // default

  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  socketPath: null, // default

  // `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) {
  })
}

axios封装

axios自身已经提供了许多的便利操作，但是在每个需要请求的地方都去书写config配置，这对快速的开发来说显得异常不合理，并且记忆大量的config配置对普通的前端开发人员来说是一种负担。为了简化请求操作就需要对已有的库提供的方法进行一层封装，使其在日常开发中更加合理。

设置拦截器

上文中已经展示了如何创建axios的实例，在此基础上为实例挂载请求与响应的拦截器，用来扩展我们需要的功能。

import QS from 'qs'

/** 设置请求拦截器 */
instance.interceptors.request.use(config => {
	if (config.method === 'post') {
		config.data = QS.stringify(config.data)
	}
	return config
})

/** 设置响应拦截器 */
instance.interceptors.response.use((response) => {
	return responseHandler(response)
}, (error) => {
	return errorHandler(error)
})

上面的代码中引入了qs库，它的主要功能是在post请求发起前对请求参数进行序列化。响应拦截器提供了两个回调，我们将需要扩展的操作分别交给responseHandler函数和errorHandler函数，这两个函数是由我们的需求去自定义的。

const ERRORTIP = {
	'401': '您还未登录，请先进行登录',
	'404': '对不起，未找到相关资源',
	'500': '服务器异常，请稍后重试',
	'504': '请求超时，请稍后重试'
}

/** 响应成功处理函数 */
const responseHandler = (res) => {
	if (res.status === 200) {
		return Promise.resolve(res.data)
	} else {
		return Promise.reject(res.statusText)
	}
}

/** 响应失败处理函数 */
const errorHandler = ({ response }) => {
	const errorResponse = {
		code: response.status,
		message: ERRORTIP[response.status]
	}
	return Promise.reject(errorResponse)
}

请求方法

/** 请求方法封装 */
const request = ({ url, method, headers = {}, params = {}, data = {}, isWithCredentials = false }) => {
	return new Promise((resolve, reject) => {
      instance({
          url,
          method,
          headers,
          params,
          data,
          withCredentials: isWithCredentials
      })
        .then(res => resolve(res))
        .catch(err => reject(err))
	})
}

该方法是通用的请求方法，isWithCredentials参数是发起请求是否携带cookie的开关。在此基础上可以做对应请求方式的进一步抽象，衍生出get和post常用方法。

/** get快捷方法封装 */
const get = (url, params, headers, isWithCredentials) => {
	return request({ url, method: 'GET', headers, params, isWithCredentials })
}

/** post快捷方法封装 */
const post = (url, data, headers, isWithCredentials) => {
	return request({ url, method: 'POST', headers, data, isWithCredentials })
}

vue当中使用该请求方法

首先引入该文件，将封装好的方法挂载至Vue的原型上，方便页面调用。

/** main.js */
import http from 'axiosRequest';

Vue.prototype.$http = http;

/** get调用示例 */
this.$http.get('api/test')

/** post调用示例 */
this.$http.post('api/test', {
  test: 'test'
})

以上只是为axios的应用提供基础的封装思路，使得请求过程能够做更多我们想做的事情，假设你需要公共的Loading、Error的轻提示可另外进行扩展。本文当中未记录，主要是希望保持方法的纯粹程度。如有错误或建议，可留言指正。