Axios-指南

前言

前端程序与服务器通信的最常见方式是通过HTTP协议。在我们没有接触 React、Angular、Vue 这类 MVVM 的前端框架之前， Jquery 除了优秀的前端 DOM 元素操作性以外，它的$.ajax()函数还能够非常便捷的发起 http 请求。现在我们已经开始使用 MVVM框架进行前端开发，抛弃了对页面 DOM 元素的操作，难道为了方便的发起 http 请求，还需要在项目中加载 jquery 或者是手动创建 http 请求吗？答案当然是不用的，随着 Vue 作者尤雨溪宣布不再维护 vue-resource，转而推荐大家使用 axios，目前在 Vue 社区中 axios 开始占据 http 库的主导地位，所以这一章我们就介绍下如何使用 axios 发起 http 请求。

一、axios

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中

二、特点

• 支持从浏览器中创建 XMLHttpRequests
• 支持从 node.js 创建 http 请求
• 支持 Promise API
• 能拦截请求和响应
• 能转换请求数据和响应数据
• 能取消请求
• 自动转换 JSON 数据
• 客户端支持防御 XSRF

三、安装

    // 使用 npm 安装
    npm install axios

    // 使用 bower安装
    bower install axios

    // 使用 cdn 引入
    < script src = "https://unpkg.com/axios/dist/axios.min.js" ></script>

 

四、例子

【1】发送一个 get 请求

// 通过给定的ID来发送请求
axios.get('/user?ID=12345')
  .then(function (response) {
    // 成功返回操作
    console.log(response); 
  })
  .catch(function (error) {
    // 失败返回操作
    console.log(error);
  });


// 以上请求也可以通过这种方式来发送
axios.get('/user',{
  params:{
    ID:12345
  }
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});

【2】发送一个POST请求

axios.post('/user',{
  firstName: 'Fred',
  lastName: 'Flintstone'
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});

【3】同时发起多个请求

function getUserAccount() {
  return axios.get('/user/12345');
};
function getUserPermissions() {
  return axios.get('/user/12345/permissions');
};
axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // 当这两个请求都完成的时候会触发这个函数，两个参数分别代表返回的结果
  }));

五、axios的API

axios可以通过配置（config）来发送请求

【1】axios(config)

// 发送一个 POST 请求
axios({
  method: 'POST',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

// 获取远程图片
axios({
  method:'get',
  url:'http://bit.ly/2mTM3nY',
  responseType:'stream'
})
  .then(function(response) {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
});

【2】axios(url[, config])

// 发起一个GET请求（GET是默认的请求方法）
axios('/user/12345');

六、请求方法别名 

为了方便，为所有支持的请求方法均提供了别名。当使用别名方法时，url，method和data等属性不用在config重复声明

axios.request(url);
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]]);

七、并发(Concurrency)

以下两个用来处理同时发生多个请求的辅助函数

// iterable是一个可以迭代的参数，如数组等
axios.all(iterable)

// callback要等到所有请求都完成才会执行
axios.spread(callback)

八、创建实例 

可以使用自定义配置新建一个 axios 实例 axios.create([config])

let instance = axios.cerate({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header':'foobar'}
});

九、实例方法

以下是所有可用的实例方法，额外声明的配置将与利用create创建的实例配置合并

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]])

十、请求的配置（request config）

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 get 方法。

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

十一、响应组成（请求返回的内容）

response由以下几部分信息组成

   {
      // data 由服务器提供的响应
      data: {},

      // status 来自服务器响应的 HTTP 状态码
      status: 200,

      // statusText 来自服务器响应的 HTTP 状态信息
      statusText: 'OK',

      // headers 服务器响应的头
      headers: {},

      // config 是为请求提供的配置信息
      config: {},
      
      // 'request'
      // request is the request that generated this response
      // It is the last ClientRequest instance in node.js (in redirects)
      // and an XMLHttpRequest instance the browser
      request: {}
    }

使用 then 时，你将接收下面这样的响应

axios.get('/user/12345')
  .then(function(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  })

十二、默认配置值

你可以指定将被用在各个请求的配置默认值

【1】全局修改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';

【2】自定义实例默认设置

// 创建实例时修改配置
var instance = axios.create({
  baseURL: 'https://api.example.com'
});

// 实例创建之后修改配置
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

【3】配置的优先级

配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者

// 创建一个实例，这时的超时时间为系统默认的 0
var instance = axios.create();

// 通过instance.defaults重新设置超时时间为2.5s，因为优先级比系统默认高
instance.defaults.timeout = 2500;

// 通过request config重新设置超时时间为5s，因为优先级比instance.defaults和系统默认都高
instance.get('/longRequest', {
  timeout: 5000
});

十三、拦截器

可以在then和catch之前拦截请求和响应

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
  });

移除拦截器

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

为axios实例添加一个拦截器

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

十四、错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 发送请求后，服务端返回的响应码不是 2xx   
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // 发送请求但是没有响应返回
      console.log(error.request);
    } else {
      // 其他错误
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

可以用 validateStatus  定义一个http状态码返回的范围

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

十五、取消请求

可以通过cancel token来取消一个请求

可以通过CancelToken.source工厂函数来创建一个cancel token

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.');

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

const CancelToken = axios.CancelToken;
let cancel;

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

// cancel the request
cancel();

十六、vue中Axios的封装

原文：https://juejin.cn/post/6844903652881072141

十七、参考

axios中文文档： http://www.axios-js.com/zh-cn/docs/

 

文章每周持续更新，可以微信搜索「 前端大集锦 」第一时间阅读，回复【视频】【书籍】领取200G视频资料和30本PDF书籍资料

​