码迷,mamicode.com
首页 > 移动开发 > 详细

前端扯犊子之一Axios

时间:2021-05-24 04:35:06      阅读:0      评论:0      收藏:0      [点我收藏+]

标签:get   请求   特殊   and   eth   别名   ogr   efault   序列化   

看到一个分析源码的,写在前面,附上网址:
https://www.jianshu.com/p/5ecd21af5ed7
Web跨域请求及其解决方案以及XSRF:
https://blog.csdn.net/ppxin/article/details/94717173#1. 什么是跨域请求(Cross-domain Request)

一、概述

Axios 是一个基于 promise (即基于状态确定)的 HTTP 库,它以基于Promise的方式封装了浏览器的XMLHttpRequest和服务器端node http请求,使得我们可以用es6推荐的异步方式处理网络请求。可以用在浏览器和 node.js 中。在Vue中常用axios来做前后端的交互。

安装:可npm也可cdn
常用请求方式:get / post / 并发(axios.all、axios.spread 方法。axios.spread方法是接收一个函数作为参数,返回一个新的函数。接收的参数函数的参数是axios.all方法中每个请求返回的响应。)

请求方法的别名

为方便起见,为所有支持的请求方法提供了别名

axios.request(配置)
axios.get(网址[,配置])
axios.delete(URL [,config])
axios.head(URL [,config])
axios.post(网址[,数据[,配置]])
axios.put(网址[,数据[,配置]])
axios.patch(URL [,data [,config]])
创建实例

一个使用自定义配置新建一个axios实例

axios.create([config])
var instance = axios.create({
  baseURL: ‘https://some-domain.com/api/‘,
  timeout: 1000,
  headers: {‘X-Custom-Header‘: ‘foobar‘}
});

二、特性

1、从浏览器中创建 XMLHttpRequests
2、从 node.js 创建 http 请求
3、支持 Promise API
4、拦截请求和响应
5、转换请求数据和响应数据
6、取消请求
7、自动转换 JSON 数据
8、客户端支持防御 XSRF

三、使用

1、拦截请求与响应

axios拦截器(interceptors)分为请求拦截器(request)和响应拦截器(response)。

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // Do something before request is sent
    return config;
  }, function (error) {
    // Do something with request error
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // Do something with response data
    return response;
  }, function (error) {
    // Do something with response error
    return Promise.reject(error);
  });

移除已经设置的拦截器

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

给自定义的axios实例添加拦截器

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

interceptors中的request和response两者都是通过一个InterceptorManager的对象进行管理,InterceptorManager的对象中是通过handlers数组变量存储拦截器,数组每项同时包含了分别作为Promise中resolve和reject的回调。InterceptorManager类中还包含了对该数组变量的添加、移除、遍历方法。

值得一提的是,移除方法是通过直接将该项设为null实现的,而不是用splice剪切该数组,遍历方法中也增加了相应的null值处理。这样做一方面使得每一项ID保持为项的数组索引不变,另一方面也避免了重新剪切拼接数组的性能损失。

2、转换请求与响应数据

通过transformRequest和transformResponse,可链式的传递函数数组对数据进行转换

{
  // 转换请求数据,注意只有‘PUT‘, ‘POST‘, 和‘PATCH‘有请求体
  // 最后一个转换函数必须返回合法的请求数据类型
  transformRequest: [function (data) {
    // Do whatever you want to transform the data
    return data;
  }],

  // 转换返回数据,将在then回调之前执行
  transformResponse: [function (data) {
    // Do whatever you want to transform the data
    return data;
  }],
}

3、自动转换JSON数据

在默认情况下,axios将会自动的将传入的data对象序列化为JSON字符串,将响应数据中的JSON字符串转换为JavaScript对象。

4、支持客户端XSRF攻击防护

XSRF攻击,即“跨站请求伪造”(Cross Site Request Forgery)攻击。通过窃取用户cookie,让用户在本机(即拥有身份 cookie 的浏览器端)发起用户所不知道的请求。防护XSRF攻击的一种方法是设置特殊的xsrf token,axios实现了对这种方法的支持。

补充:请求配置

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

  // `method` 是创建请求时使用的方法
  method: ‘get‘, // 默认是 get

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

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

  // `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‘, // 默认的

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

  // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: ‘X-XSRF-TOKEN‘, // 默认的

  // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `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; // 默认的
  },

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

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

参考链接:
https://blog.csdn.net/bangbanggangan/article/details/85796589
https://zhuanlan.zhihu.com/p/28396592
https://www.kancloud.cn/yunye/axios/234845

前端扯犊子之一Axios

标签:get   请求   特殊   and   eth   别名   ogr   efault   序列化   

原文地址:https://www.cnblogs.com/qjawsg/p/14751847.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!