整理总结:关于Axios篇

安装引入

# 安装
npm install axios -D //保存到依赖里

# 项目引入
import axios from 'axios';
var axios = require('axios');

一、GET

//参数拼写在链接后面
axios.get('/user?ID=12345') 
  .then(function (response) {
    console.log(response);
    
    console.log(response.data); //由服务器提供的响应
    console.log(response.status); //服务器响应的 HTTP 状态码
    console.log(response.statusText); //响应的 HTTP 状态信息
    console.log(response.headers);  //服务器响应的头
    console.log(response.config);  //请求提供的配置信息
  })
  .catch(function (error) {
    console.log(error);
  });
  

// 上面的请求也可以这样做
axios.get('/user', {   
    params: {
      ID: 12345
    },
    header:{
      token:"abc"
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

二、POST

axios.post('/user', {  //和get不同的地方之一  没有params
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

三、执行并发请求

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) {
    // 两个请求现在都执行完成
  }));

四、配置写法 axios(config)

Get
// 获取远端图片
axios({
  method:'get',
  url:'http://bit.ly/2mTM3nY',
  responseType:'stream',
  params:{ //get的参数在这 或拼在url
        userId:"102"
  }
})
  .then(function(response) {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
});
Post
// 发送 POST 请求
axios({
  method: 'post',
  url: '/user/12345',
  data: { //post的参数在这
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

五、创建实例 axios.create([config])

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

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

六、配置选项

配置选项
{
  url: '/user', //请求链接
  method: 'get',  // 请求使用的方法,默认'get'

  // 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
  baseURL: 'https://some-domain.com/api/',

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

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

  // 自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // ** 与请求一起发送的 URL 参数
  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: 1000,

   // 跨域请求时是否需要使用凭证,默认false
  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', // 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) {
  })
}
全局的 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';
自定义实例默认值
// Set config defaults when creating the instance  
const instance = axios.create({  
baseURL: 'https://api.example.com'  
});  
  
// 在实例创建后 自定义实例默认值 
instance.defaults.headers.common\['Authorization'\] = AUTH\_TOKEN;
配置的优先顺序

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

七、拦截器

// 添加请求拦截器  所有请求前都在这里
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么 例如loading
    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 官网: http://www.axios-js.com/zh-cn...
fetch w3c官网: https://www.w3cschool.cn/fetc...
从ajax到fetch、axios: https://linxunzyf.cn/posts/92...
Jquery ajax, Axios, Fetch区别之我见:https://segmentfault.com/a/11...

阅读 602

推荐阅读
喈喱前端笔记
用户专栏

学习的付出 从不欺人

4 人关注
31 篇文章
专栏主页