「Axios」入门到精通

0.615字数 1213阅读 416

# 目录

  1. axios基础知识和使用办法
  2. 构造适用于自己系统的axios
  3. 在vue中使用vue-axios
  4. 请求失败重试机制

$ Axios 基础

  Axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端,本质上也是对原生XHR的封装,只不过它是Promise的实现版本,符合最新的ES规范。其优势明显,它支持

  • 从浏览器中创建XMLHttpRequests
  • Promise的API
  • 拦截请求与响应
  • 转换请求数据与响应数据
  • 取消请求
  • 自动转换JSON数据
  • 防御XSRF

  Axios支持大部分主流浏览器,如下

# 引入办法

npm安装:npm install axios
使用cdn:<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
 

# 简单用法

  在简单用法中,axios支持接收两个参数。第一个是uri,第二个是请求参数

GET请求

  axios灵活了get的使用办法,可以将参数追加在api上,也可以添加params选项追加参数。注意和post使用data选项追加参数区别。(如果没有添加方法如·axios('/user'),则默认为get请求)

axios.get('/user?name=liu').then((res) => {
  console.log(res)
}).catch((e) => {
  console.log(e)
})
axios.get('/user', params: {
  name: 'liu'
}).then((res) => {
  console.log(res)
}).catch((e) => {
  console.log(e)
})
POST请求

  post请求和普通的ajax相似

axios.post('/user', {
  name: 'liu'
}).then((res) => {
  console.log(res)
}).catch((e) => {
  console.log(e)
})

扩展】观察GET和POST不难发现,其区别在于请求主体参数传递上的区别,因此如果有需要封装一个公用的方法,可以用ES6的属性变量的办法,识别请求类型后设置,如下

// 伪代码
export default function(url, method, params = {}) {
  let data = method.toLocaleLowerCase() === 'get' ? 'params' : 'data';
    return axios({
        method,
        url,
        [data]: params // 差异点在于data的值
    }).then(res => {
      console.log(res.data)
    }).catch(e => {console.log(e)})
}
并发请求

  all请求支持aixos并发多个异步请求,使用数组将多个请求列出。只有当所有请求都执行完成才能继续往下执行
执行并发请求需要两个助手函数:axios.all(iterable) && axios.spread(callback)

function getAccount() {
  return axios.get('/user/liu')
}
function getAccess() {
  return axios.get('/user/liu/access')
}
axios.all([getAccount(). getAccess()])
  .then(axios.spread(function(acctRes, acceRes) {
    // 两个请求都执行完成
  }))

 

# 规范化请求

  axios允许开发者传入一个配置对象,指定请求实现更多的功能。【配置详解见后文】

axios(config)
# 发送post请求的标准写法
axios({
  method: 'post',
  url: '/user',
  data: {
    name: 'liu'
  }
})
# 发送get请求写入流方式获取远程图片的标准写法
axios({
  method: 'get',
  url: 'http://bit.ly/amTM3nY',
  responseType: 'stream'
}).then((res) => {
  res.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
})
axios(url[, config])
# 发送get请求的的默认方法
axios('/user')

# 支持的方法

  为了方便起见,axios提供了所支持请求的别名用法,在使用别名方法时,url,method,data这些属性都不必在配置中指定。支持的方法别名用法如下:

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实例

  使用axios.create()自定义配置一个新的实例,传入的配置对象将会和默认配置进行一个覆盖式合并,优先使用传入配置选项

const instance = axios.create({
  baseURL: 'https://some.domain.com/api/',
  timeout: 5000,
  headers: { 'X-Custom-Header': 'foobar' }
})

# 请求配置及含义

  如下是请求配置可使用的选项,除了url是必须的外,其余部分都是可选的。默认使用的是get方法

{
  url: '/user',  // 请求服务器的url
  method: 'get',  // 请求使用的方法
  baseURL: 'http://some.domain.com/api/',  // 若url不是绝对路径,baseURL将自动添加在url前
  headers: { 'X-Requested-With': 'XMLHttpRequest' },  // 添加请求头
  
  // 请求真正发起前,修改请求数据。只有POST,PUT,PATCH有效
  // 自身是数组类型,函数必须返回一个字符串,或ArrayBuffer,或Stream
  transformRequest: [function(data, headers) {
    // TODO: 请求数据的任意修改和处理
    return data
  }],
  // 响应数据的修改,执行再传递给.then和.catch之前,因此.then拿到时已经修改完成
  transformResponse: [function(data, headers) {
    return data
  }],
  # 将被添加在url上的请求参数
  params: {
    name: 'liu'
  },
  // 将请求参数序列化
  paramsSerializer: function() {
    return Qs.stringify(param, {arrayFormat: 'brackets'})
  },
  // 将被用作请求主体的参数,仅PUT,POST,PATCH有效
  data: {
    name: 'liu'
  },
  
  // 超时时间。如果超过改时间,请求将被中断。0-表示无超时时间
  timeout: 5000,
  // 跨域请求时是否需要使用凭证
  withCredentials: false,  // default

  // 自定义处理请求,方便测试
  adapter: function(config) {
    /*....*/
  },
  // 使用HTTP基础验证,并提供凭据。这将添加一个`Authorization`头,并覆盖现有`header`里的该选项
  auth: {
    uaername: 'janedoe',
    password: 's00pers3cret'
  },
  // 服务器响应的数据类型。
  responseType: 'json',
  responseEncoding: 'utf8',  // 响应编码,默认。
  xsrfCookieName: 'XSRF-TOKEN',  // xsrf token值的cookie名称,默认。
  xsrfHeaderName: 'X-XSRF-TOKEN', // xsrf token的值, 默认。

  onUploadProgress: function (progressEvent) {  // 为上传处理进度事件
    // 对原生进度事件的处理
  },
  onDownloadProgress: function(progressEvent) { // 为下载处理进度事件
    // 对原生进度事件的处理
  },

  // 允许响应的最大尺寸
  maxContentLength: 2000,

  // 自定义应该被resolve的promise的状态。改函数返回true/null/undefined,返回resolve;否者被rejected
  validateStatus: function(status) {
    return status >= 200 && status < 300;  // default
  },

  // node.js中follow的最大重定向数目
  maxRedirects: 5,  // default
  // node.js中使用的socket路径
  socketPath: null,
  
  // node.js中自定义执行http和https时使用的代理,keepAlive-表示没有启用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 代理服务器的主机名称和端口,可以用于本地开发解决跨域请求
  // `auth`表示HTTP基础验证应当用于连接代理,并提供凭据
  // 生成一个`Proxy-Authorization`头,覆盖header里自定义的该头
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: {
      userName: 'mikeymike',
      password: 'rapunz2l'
    }
  },

  // 取消请求的cancel token
  cancelToken: new CancelToken(function (canvel) { })
}

# 响应结构

  某个请求的响应包含以下信息:

{
  data: {},  // 服务器提供的响应数据
  status: 200,  // 响应的HTTP状态码
  statusText: 'Success',  // 响应的HTTP状态信息
  headers: {},  // 服务器响应头
  config: {},  // 为请求提供的配置信息
  request: {}  // 响应生成的请求
}

  有了以上结构,在执行.then时,我们能获取以下内容

axios.get('/user').then((res) => {
  let { data, status, statusText, headers, config } = res
  console.log(data, status, statusText, headers, config)
})

 

# 设置默认值

  axios允许开发者们设定全局的公用配置默认值

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

也可以自定义实例默认值

// 创建实例时设定默认配置
const instance = axios.create({
  baseURL: 'https://api.example.com'
});
// 创建后修改默认配置的办法
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

在不同的位置配置相同的默认选项,axios会以一定的优先顺序覆盖合并,规则为
lib/defaults.js < 实例 default 属性 < 请求的 config 参数
 

# 拦截器

  开发者们可以在请求发起前,及请求响应到then或catch前拦截它们,并执行一些预处理

# 添加请求拦截器
axios.interceptors.request.use(function (config) {
  // 在发送请求之前处理一些事情,如添加header,token等
  return config
}, function (error) {
  // 如果请求错误,添加处理逻辑
  return Promise.reject(error);
})
# 添加响应拦截器
axios.interceptors.response.use(function (response) {
  // 数据已经返回,但未传递给.then和.catch。添加处理逻辑
  return response;
}, function (error) {
  return Promise.reject(error);
})

  拦截器添加之后,也可以手动移除

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

对于自定义的axios实例,创建拦截器时如下

const instance = axios.create()
instance.intereptors.request.use(function () {/*...*/})

# 错误处理

axios.get('/user')
  .catch((err) => {
    if (err.response) {
      let { data, status, headers } = err.resonse
      console.log(data, status, headers)
    } else if (err.request) {
      console.log(err.request)
    } else {
      ocnsole.log('Error: ', error.message)
    }
    console.log(error.config)
  })

  也可以使用validateStatus配置选项定义一个自定义的HTTP状态码的错误范围

axios.get('user', {
  validateStatus: function (status) {
    return status < 500;
  }
})

# 取消请求

  axios允许开发者们使用cancel token取消请求

Axios 的cancel token API基于cancelable promise proposal, 它还处于第一阶段

可以使用cancelToken.source工厂方法创建cancel token,如下

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

  还可以通过传递一个 executor 函数传递到CancelToken的够造函数来创建cancel token

const CancelToken = axios.CancelToken
let cancel;

axios.get('user/liu', {
  cancelToken: new CancelToken(function executor(c) {
    // excutor 函数接收一个 cancel 函数作为参数
    cancel = c
  })
})
cancel()

注意:可以使用同一个cancel token 取消多个请求

# Node.js

  在node.js中,您可以使用querystring模块,如下所示:

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));

也可以使用qs库
 


# vue中使用vue-axios

  vue框架建议使用axios执行异步请求,而vue-axios是axios基于vuejs的轻度封装

模块化安装
npm install --save axios vue-axios

在vue中引入vue-axios

import Vue from 'vue';
import axios from 'axios'
import vueAxios from 'vue-axios'

Vue.use(VusAxios, axios)
用法
Vue.axios.get(api).then((response) => {
  console.log(response.data)
})

this.axios.get(api).then((response) => {
  console.log(response.data)
})
this.$http.get(api).then((response) => {
  console.log(response.data)
})


# 请求失败重试机制

  失败重试的请求,我们使用axios-retry插件来实现,首先,模块化安装这个插件

npm install axios-retry
使用
// 使用CommonJS引入
const axiosRetry = require('axios-retry');

// ES6方式引入
import axiosRetry from 'axios.retry';

// 第一个请求失败,第二次请求成功
axios.get('http://example.com/test').then(res => {
  console.log(result.data)   // 'OK'
})
// 设置重试间隔随着重试次数按指数形式递增
axiosRetry(axios, { axiosDelay: axiosRetry.exponentialDelay })

// 也可以自定义重试间隔
axiosRetry(axios, { retryDelay: (retryCount) => {
  return retryCount * 1000;
}})
自定义的axios实例用法
const client= axios.create({
  baseURL: 'http://example.com'
});
// 定义重试次数3次
axiosRetry(client, { retries: 3 }); 

client.get('/test').then(res => {
  console.log(result.data);  // ok
})

// 除了设置默认值外,每个请求也可以单独设置进行覆盖合并
client.get('/test', {
  'axios.retry': { retries: 0 }
}).then(res => {
   console.log(result.data);
}).catch(e => {
  console.log(error !== undefined)  // 如果请求失败,输出true
})

】除非shouldResetTimeout被设置,该插件将请求超时解释为全局值,不是针对某一个请求,而是全局的设置。

更多的配置
名称 类型 默认值 描述
retries number 3 重试次数
retryCondition Function isNetworkOrIdempotentRequestError 应该重试的请求情况,如果是幂等请求的网络错误或5xx ,将会重试
shouldResetTimeout Boolean false 设置请求超时是否需要重试
retryDelay Function function noDelay() {return 0} 重试间隔控制

推荐阅读更多精彩内容