时间戳

首页 > 技术文章 > axios 基础知识点

axios 基础知识点

-LemonWater- 2021-11-03 17:22 原文

axios 基础

请求基础配置

{
  url: '/user',
  method: 'get', 
  baseURL: 'https://some-domain.com/api/',
  headers: {'X-Requested-With': 'XMLHttpRequest'},
  params: {ID: 12345},
  data: {firstName: 'Fred'},
  timeout: 1000,
  auth: { username: 'janedoe', password: 's00pers3cret' },
}

实例全局配置

// npm i axios
import axios from 'axios'
const http = axios.create({
    baseURL: process.env.VUE_API_APP_URL,
    timeout: 1000,
})

拦截器

// 添加请求拦截器
const reqInterceptor = axios.interceptors.request.use(function (config) {
    return config;
  }, function (error) {
    return Promise.reject(error);
  });

// 添加响应拦截器
const resInterceptor = axios.interceptors.response.use(function (response) {
    return response;
  }, function (error) {
    return Promise.reject(error);
  });
// 移除拦截器
axios.interceptors.request.eject(reqInterceptor);
axios.interceptors.request.eject(resInterceptor);

错误捕获

// 直接捕获错误
axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      console.log(error.response);
    } else if (error.request) {
      console.log(error.request);
    } else {
      console.log('Error', error.message);
    }
    console.log(error.config);
  });
// 校验HTTP 状态码的错误范围
axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // Reject only if the status code is greater than or equal to 500
  }
})

取消请求

注意: 可以使用同一个 cancel token 取消多个请求
const CancelToken = axios.CancelToken;
let cancel;

axios.get('/user?id=1', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数作为参数，这里的 参数c 就是 cancel 函数
    cancel = c;
  })
});

axios.post('/user?id=1',{firstName:'Water',lastName:'White'}, {
  cancelToken: new CancelToken(function executor(c) {
    cancel = c;
  })
});

// cancel the request
cancel();

基础方法

axios.get(url[, config])
// 地址传参的两种方法
axios.get('/api/user?id=1')
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})

axios.get('/api/user',{params:{id:1}})
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})
axios.delete(url[, config])
axios.delete(`/api/user?id=${id}`)
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})
axios.post(url[, data[, config]])
axios.post('/api/user',{firstName: 'Water',lastName: 'White'})
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})
axios.put(url[, data[, config]])

一般用于全部更新，要求前端提供的一定是一个完整的资源对象

axios.put(`/api/user?id=${id}`,{firstName: 'Open-Water',lastName: 'White'})
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})
axios.patch(url[, data[, config]])

一般用于局部更新

axios.patch(`/api/user?id=${id}`,{firstName: 'Open-Water'})
    .then(res=>{console.log(res)})
    .catch(err=>{console.log(err)})
axios.head(url[, config])
axios.options(url[, config])

这两个没用过

注意

在使用别名方法时， url、method、data 这些属性都不必在 config 中指定。

并发

处理并发请求的助手函数

axios.all(iterable)
axios.spread(callback)
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) {
    // 两个请求现在都执行完成
    console.log('req-1:',acct);console.log('req-2:',perms);
  }));

请求详细配置

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

  // `method` 是创建请求时使用的方法
  method: 'get', // default; ['get'|'post'|'put'|'delete'|'head'|'options'|'patch'|'all'|'spread']

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

  // `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是即将与请求一起发送的 URL 参数
  // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: {ID: 12345},

  // `data` 是作为请求主体被发送的数据
  // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
  // 在没有设置 `transformRequest` 时，必须是以下类型之一：
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属：FormData, File, Blob
  // - Node 专属： Stream
  data: {firstName: 'Fred'},

  // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  // 如果请求话费了超过 `timeout` 的时间，请求将被中断
  timeout: 1000,
      
  // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
  // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  auth: { username: 'janedoe', password: 's00pers3cret' },

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data, headers) {
    // 对 data 进行任意转换处理
    return data;
  }],

  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对 data 进行任意转换处理
    return data;
  }],

   // `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'})
  },
   
  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default

  // `adapter` 允许自定义处理请求，以使测试更轻松
  // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

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

原文链接： http://www.axios-js.com/zh-cn/docs/

推荐阅读