axios是什么？

• Axios 是一个基于 promise 的网络请求库，可以用于浏览器和 node.js。前端最流行的ajax请求库，react/vue官方都推荐使用axios发ajax请求。

• 文档地址： http://www.axios-js.com/

axios特点

1. 基于promise的异步ajax请求库

2. 浏览器端/node端都可以使用

3. 支持请求／响应拦截器

4. 支持请求取消

5. 请求/响应数据转换

6. 批量发送多个请求

axios常用语法

axios(config): 通用/最本质的发任意类型请求的方式

axios(url[, config]): 可以只指定url发get请求

axios.get(url[, config]): 发get请求

axios.delete(url[, config]): 发delete请求

axios.post(url[, data, config]): 发post请求

axios.put(url[, data, config]): 发put请求

axios.defaults.xxx: 请求的默认全局配置

axios.interceptors.request.use(): 添加请求拦截器

axios.interceptors.response.use(): 添加响应拦截器

axios.create([config]): 创建一个新的axios(它没有下面的功能)

axios.Cancel(): 用于创建取消请求的错误对象

axios.CancelToken(): 用于创建取消请求的token对象

axios.isCancel(): 是否是一个取消请求的错误

axios.all(promises): 用于批量执行多个异步请求

axios 基本请求

基本请求

axios(config): 通用/最本质的发任意类型请求的方式

 axios({
   url:"/list",
   method:"get",
   params:{
      a:10,
      b:20
   }
 }).then(res=>{
   let {data} = res;
   console.log(data);
 })

axios(url[, config]): 可以只指定url发get请求

 btn2.onclick = async function(){
   let {data} = await axios("/post",{
     method:"post",
     data:{
       a:10,
       b:20
     }
   })
   console.log(data);
 }

请求别名

axios.get(url[, config]): 发get请求

 axios.get("/list",{
   params:{
     a:1,
     b:2
   }
 }).then(res=>{
   console.log(res);
 })

axios.post(url[, data, config]): 发post请求

  axios.post("/post",{a:1,b:2}).then(res=>{
                console.log(res);
   })

axios.delete(url[, config]): 发delete请求

axios.delete("/delete",{
  params:{
    x:1,
    y:2
  }
}).then(res=>{
  console.log(res);
})

axios.put(url[, data, config]): 发put请求

 axios.put("/put",{
     x:1,
     y:2
   }
 ).then(res=>{
   console.log(res);
 })

发起多个请求（并发请求）

• axios.all(promises): 用于批量执行多个异步请求

 axios.all([axios.get("/api1"),axios.get("/api2")]).then(res=>{
   console.log(res);
 })

请求配置（config）

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

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

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

  // `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`
  // (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', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送，key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值，则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default

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

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

  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属：'blob'
  responseType: 'json', // 默认值

  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值

  // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值

  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值

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

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

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

  // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,

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

  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0，则不会进行重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定，这使用 `socketPath` 。
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // `proxy` 定义了代理服务器的主机名，端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
  }),

  decompress: true // 默认值  指示是否应自动压缩 只能再node.js设置

}

常用配置解读

• url：url 是用于请求的服务器 URL

• method: 'get', 请求方式

• baseURL: 'https://some-domain.com/api/' ： 自动添加请求到url上

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

• params: { ID: 12345 } :params 是与请求一起发送的 URL 参数

• data: {firstName: 'Fred' } 作为请求体发送数据

• timeout: 1000, // 请求超时时间， 默认值是 0 (永不超时)

• cancelToken :取消axios请求

响应结构

axios响应包含如下信息

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

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

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

  // `headers` 是服务器响应头
  // 所有的 header 名称都是小写，而且可以使用方括号语法访问
  // 例如: `response.headers['content-type']`
  headers: {},

  // `config` 是 `axios` 请求的配置信息
  config: {},

  // `request` 是生成此响应的请求
  // 在node.js中它是最后一个ClientRequest实例 (in redirects)，
  // 在浏览器中则是 XMLHttpRequest 实例
  request: {}
}

axios 实例创建

axios.create([config]): 创建一个新的axios

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

创建实例为了处理项目中的多个请求

axios 默认配置参数

• 全局默认配置

axios.defaults.xxx: 请求的默认全局配置

实例默认配置

 const instance = axios.create();
 instance.defaults.timeout = 2500;
    // 重写默认配置 
 instance.get('/longRequest', {
  timeout: 5000
});

axios拦截器interceptors

请求拦截器

   axios.interceptors.request.use(function(config){
            console.log(111);
            return config;
        })

返还拦截器

 axios.interceptors.response.use(function(response){
            console.log(22);
            return config;
        })

axios 取消请求

axios.CancelToken(): 用于创建取消请求的token对象

 let cancel;
cancelToken:new axios.CancelToken(function(c){
                        if(cancel){
                            cancel();
                        }
                        cancel = c;
 })

axios.isCancel(): 是否是一个取消请求的错误

console.log( axios.isCancel(err));