对于Axios的理解

1. 什么是 axios?

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

2. 特性

  • 在浏览器中创建 XMLHttpRequests
  • 从 node.js 中创建请求
  • 支持 Promise API
  • 拦截请求和响应
  • 转换请求数据数据与响应数据
  • 取消请求
  • 自动转换 JOSN 数据
  • 客户端支持防御 CSRF 攻击

3. 请求配置

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

 {
  url: '/user',  // `url` 是用于请求的服务器 URL
  method: 'get',  // `method` 是创建请求时使用的方法,默认get
  baseURL: 'https://some-domain.com/api/',  //加在 `url` 前面,便于为 axios 实例的方法传递相对 URL
  
  // `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`的可选方法
  paramsSerializer: function (params) { 
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },
  
  // `data` 是作为请求体被发送的数据
  // 当请求方式为 post时,data: 'Country=Brasil&City=Belo Horizonte',只有 value 会被发送,key 则不会
  data: {
    firstName: 'Fred'
  },
  
  timeout: 1000, // `timeout` 指定请求超时的毫秒数,超时会中断,默认值是 `0` (永不超时)
  withCredentials: false, // // `withCredentials` 表示跨域请求时是否需要使用凭证在

  // `adapter` 允许自定义处理请求,这使测试更加容易。返回一个 promise 并提供一个有效的响应 (参见 lib/adapters/README.md)。
  adapter: function (config) {
    /* ... */
  },

  // `auth` HTTP Basic Auth
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  responseType: 'json', // `responseType` 表示浏览器将要响应的数据类型,默认
  responseEncoding: 'utf8', // 默认值,用于解码响应的编码
  xsrfCookieName: 'XSRF-TOKEN', // 默认值,是 xsrf token 的值,被用作 cookie 的名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值,是带有 xsrf token 值的http 请求头名称

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

  // `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  maxContentLength: 2000, // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxBodyLength: 2000, //定义允许的http请求内容的最大字节数

  // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),则promise 将会 resolved,否则是 rejected。
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认值
  },

  maxRedirects: 5, // 默认值,定义了在node.js中要遵循的最大重定向数,若为0,则不会进行重定向
  socketPath: null, // default,定义了在node.js中使用的UNIX套接字,只能指定 `socketPath` 或 `proxy`,若都指定,则使用 `socketPath`
  httpAgent: new http.Agent({ keepAlive: true }), 
  httpsAgent: new https.Agent({ keepAlive: true }), // 定义在node.js中分别执行HTTP和HTTPS请求时使用的自定义代理,允许添加像“keepAlive”这样的默认不启用的选项

  /*  分割线  */
  proxy: {
    protocol: 'https', //环境变量
    host: '127.0.0.1', //代理服务器的主机名
    port: 9000, //端口和协议
    auth: {  // `auth`表示应使用HTTP Basic auth连接到代理,并且提供凭据。
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },
  cancelToken: new CancelToken(function (cancel) {
  }),
  decompress: true // 默认值,是否自动解压缩响应体,如果设置为' true '将从所有解压缩的responsesNode的响应对象中删除'content-encoding'头(XHR不能关闭解压缩)
}

4.响应结构

一个请求的响应包含以下信息。

{
  data: {}, // 由服务器提供的响应
  status: 200, //来自服务器响应的 HTTP 状态码
  statusText: 'OK', //来自服务器响应的 HTTP 状态信息
  headers: {}, //服务器响应头
  config: {}, // `axios` 请求的配置信息
  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);
  });

当使用 catch,或者传递一个rejection callback作为 then 的第二个参数时,响应可以通过 error 对象被使用,正如在错误处理部分解释的那样。

5.默认配置

  • 全局 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;

6. 拦截器

在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器
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);

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

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

7. 错误处理

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) {
      // 请求已经成功发起,但没有收到响应( `error.request` 在浏览器中是 XMLHttpRequest 的实例,而在node.js中是 http.ClientRequest 的实例)
      console.log(error.request);
    } else {
      // 发送请求时出了点问题
      console.log('Error', error.message);
    }
    console.log(error.config);
    console.log(error.toJSON()); //使用 toJSON 可以获取更多关于HTTP错误的信息
  });

8. 取消请求

  1. Axios 支持以 fetch API 方式—— AbortController 取消请求
const controller = new AbortController();

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

2.可以使用 CancelToken.source 工厂方法创建一个 cancel token List item( 此 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.');
  1. 也可以通过传递一个 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();

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

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值