一、Promise的使用

ES6 中一个非常重要和好用的特性就是 Promise，Promise 是异步编程的一种解决方案，一种很常见的场景应该就是网络请求了。

1. 基本语法

这里使用一个定时器来模拟异步事件，Promise 的基本语法如下：

new Promise 对象，传入一个回调函数，在执行传入的回调函数时，会传入两个参数，resolve、reject，这两个参数本身又是函数
当请求成功，调用 resolve() 时，执行 then() 中的方法
当请求失败，调用 reject() 时，执行 catch() 中的方法

一种写法，链式写法：

new Promise((resolve, reject) => {
  setTimeout(() => {
    // 成功的时候调用resolve
    resolve('Hello World')

    // 失败的时候调用reject
    reject('error message')
  }, 1000)
}).then((data) => {
  console.log(data);
}).catch((err) => {
  console.log(err);
})

另一种写法，new Promise 时传入三个函数：

new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('Hello Vuejs')
    reject('error message')
  }, 1000)
}).then(data => {
  console.log(data);
}, err => {
  console.log(err);
})

2. Promise三种状态

在这里插入图片描述

当我们开发中有异步操作时，就可以给异步操作包装一个 Promise。异步操作之后会有三种状态

pending：等待状态，比如正在进行网络请求，或者定时器没有到时间。
fulfill：满足状态，当我们主动回调了 resolve 时，就处于该状态，并且会回调 .then()
reject：拒绝状态，当我们主动回调了 reject 时，就处于该状态，并且会回调 .catch()

3. Promise链式调用

1. 基本写法

通过 return new Promise() 来发送第二次网络请求

new Promise((resolve, reject) => {

  // 第一次网络请求的代码
  setTimeout(() => {
    resolve()
  }, 1000)

}).then(() => {
  // 第一次拿到结果的处理代码
  console.log('111');

  // 在第一次处理中再次发送网络请求
  return new Promise((resolve, reject) => {

    // 第二次网络请求的代码
    setTimeout(() => {
      resolve()
    }, 1000)
  })
}).then(() => {

  // 第二次处理的代码
  console.log('222');

  return new Promise((resolve, reject) => {

    // 第三次网络请求的代码
    setTimeout(() => {
      resolve()
    })
  })
}).then(() => {

  // 第三处理的代码
  console.log('333');
})

2. 使用静态方法

Promise.resovle()：将数据包装成 Promise 对象，并且在内部回调 resolve() 函数
Promise.reject()：将数据包装成 Promise 对象，并且在内部回调 reject() 函数

new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('111')
  }, 1000)
}).then(res => {
  // 1.自己处理10行代码
  console.log(res, '第一层的10行处理代码');

  // 2.对结果进行第一次处理
  return Promise.resolve(res + '222')
}).then(res => {
  console.log(res, '第二层的10行处理代码');

  return Promise.resolve(res + '333')
}).then(res => {
  console.log(res, '第三层的10行处理代码');
})

3. 直接返回

使用 return data 来替代 return Promise.resovle(data)
使用 throw data 来替代 return Promise.reject(data)

new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('111')
  }, 1000)
}).then(res => {
  // 1.自己处理10行代码
  console.log(res, '第一层的10行处理代码');

  // 这里是直接返回字符串，相当于 Promise.resovle(res + '111')
  return res + '111';
}).then(res => {
  console.log(res, '第二层的10行处理代码');

  // 对结果进行第一次处理（出错）
  // 相当于 return Promise.reject('error message')
  throw 'error message'
}).then(res => {
  console.log(res, '第三层的10行处理代码');
}).catch(err => {
  console.log(err);
})

4. Promise.all

Promse.all 在处理多个异步处理时非常有用，在所有请求都成功后才执行 then，比如说需要等两个或多个异步操作的数据回来以后才正常显示。

成功时返回的是数组；失败时候返回最先被 reject 失败状态的值。

Promise.all([
  new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve('111')
    }, 2000)
  }),
  new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve('222')
    }, 1000)
  })
]).then(results => {
  console.log(results);	// ['111', '222']
})

5. Promise.race

Promse.race 就是赛跑的意思，意思就是说，Promise.race([p1, p2, p3]) 里面哪个结果获得的快，就返回那个结果，不管结果本身是成功状态还是失败状态。

二、Axios使用

官方网站：www.axios-js.com/ 官方文档：www.axios-js.com/zh-cn/docs/

Axios 是一个基于 Promise（ES6中用于处理异步的）的 HTTP 库，用于浏览器和 node.js 中。

1. 安装并引入

安装：
```
npm install axios --save
```
引入 axios：
```
import axios from 'axios'
```

2. 发送请求

Axios 支持多种请求方式，调用方式（中括号中的内容可省略）：

axios(config)

//请求方法的别名
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

==注意==：在使用别名方法时， url、method、data 这些属性都不必在配置中指定。

3. config配置

常用的一些配置有：

url：请求的服务器 URL
method：请求服务器时使用的方法，若没有指定方法，默认使用 get
baseURL：baseURL 将自动加在 url 前面
data/params：这两个都是用于传递数据的，不同的是 data 会把==数据放入请求体中==，params 会把==数据放入 URL中==，因此 method 为 POST/PUT/PATCH 时，使用 data，其余使用 params

==注意==：使用 data 传递值的时候，要使用 qs.stringify() 将对象序列化成URL的形式，否则后台接收不到值。详见第三章第2节
timeout：超时时间

config 配置大全（摘自官方文档：戳这里）：

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

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

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

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

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

4. 响应结构

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

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

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

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

  // `headers` 服务器响应的头
  headers: {},

   // `config` 是为请求提供的配置信息
  config: {},
 // 'request'
  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance the browser
  request: {}
}

5. 并发请求

使用 axios.all()，可以放入多个请求的数组，类似于 Promise.all。

axios.all([]) 返回的结果是一个数组，使用 axios.spread 可将数组 [res1,res2] 展开为 res1, res2

axios.all([axios({
  url: 'http://123.207.32.32:8000/home/multidata'
}), axios({
  url: 'http://123.207.32.32:8000/home/data',
  params: {
    type: 'sell',
    page: 5
  }
})]).then(results => {
  console.log(results);
  console.log(results[0]);
})

6. 全局配置

开发中可能很多参数都是固定的。这个时候我们就可以利用 axiox 的全局配置

axios.defaults.baseURL = ‘123.207.32.32:8000’
axios.defaults.headers.post[‘Content-Type’] = ‘application/x-www-form-urlencoded’;

6. 创建实例

当我们从 axios 模块中导入对象时，使用的实例是默认的实例。当给该实例设置一些默认配置时，这些配置就被固定下来了。但是后续开发中，某些配置可能会不太一样。比如某些请求需要使用特定的 baseURL 或者 timeout 或者 content-Type 等。

这个时候，我们就可以创建新的实例，并且传入属于该实例的配置信息

创建一个实例：

axios.create([config])

例如：

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

7. 实例方法

以下是可用的实例方法。指定的配置将与实例的配置合并。

axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#head(url[, config])
axios#options(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])

8. 拦截器

axios 提供了拦截器，用于我们在发送每次请求或者得到相应后，进行对应的处理。

请求拦截器

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

//为实例添加请求拦截器
const instance = axios.create();
instance.interceptors.request.use(function () {/*同上面*/});

发送请求前函数的使用场景：

当发送网络请求时，在页面中添加一个 loading 组件，作为动画
某些请求要求用户必须登录，判断用户是否有 token，如果没有 token 跳转到 login 页面
对请求的参数进行序例化

请求拦截中错误拦截应用：

如请求超时，可以将页面跳转到一个错误页面中

响应拦截器

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
  });

//为实例添加响应拦截器
const instance = axios.create();
instance.interceptors.response.use(function () {/*同上面*/});

响应的成功拦截中，主要是对数据进行过滤。

响应的失败拦截中，可以根据 status 判断报错的错误码，跳转到不同的错误提示页面。

9. Axios 封装

这是对 Axios 的一个简单的封装

import axios from 'axios'

export function request(config) {
  // 1.创建axios的实例
  const instance = axios.create({
    baseURL: 'http://123.207.32.32:8000',
    timeout: 5000
  })

  // 2.axios的拦截器
  // 2.1.请求拦截的作用
  instance.interceptors.request.use(config => {
    // console.log(config);
    // 1.比如config中的一些信息不符合服务器的要求

    // 2.比如每次发送网络请求时, 都希望在界面中显示一个请求的图标

    // 3.某些网络请求(比如登录(token)), 必须携带一些特殊的信息
    return config
  }, err => {
    // console.log(err);
  })

  // 2.2.响应拦截
  instance.interceptors.response.use(res => {
    // console.log(res);
    return res.data
  }, err => {
    console.log(err);
  })

  // 3.发送真正的网络请求
  return instance(config)
}

三、Axios 踩过的坑

1. 传递的参数为数组时的编码问题

引入：

import axios from 'axios'
import qs from 'qs'

get / delete请求方式解决方式如下

axios.get(url, {
    params: {
     ids: [1,2,3],
     type: 1
    },
    paramsSerializer: params => {
      return qs.stringify(params, { indices: false })
    }})

axios.delete(url, {
     params: {
     ids: [1,2,3],
     type: 1
    },
    paramsSerializer: params => {
      return qs.stringify(params, { indices: false })
    }})

post / put 请求方式解决方式如下

axios.post(url, qs.stringify(
    params: {
      ids: [1,2,3],
      type: 1
    }, { indices: false }))

 axios.put(url, qs.stringify(
   params: {
     ids: [1,2,3],
     type: 1
   }, { indices: false }))

转换的方式有四种：

qs.stringify({ids: [1, 2, 3]}, { indices: false })
 //形式： ids=1&ids=2&ids=3
qs.stringify({ids: [1, 2, 3]}, {arrayFormat: ‘indices‘})
 //形式： ids[0]=1&aids1]=2&ids[2]=3
qs.stringify({ids: [1, 2, 3]}, {arrayFormat: ‘brackets‘})
 //形式：ids[]=1&ids[]=2&ids[]=3
qs.stringify({ids: [1, 2, 3]}, {arrayFormat: ‘repeat‘}) 
//形式： ids=1&ids=2&ids=3

参考：axios传递数组参数爬坑总结

2. 使用 data 传递参数时的问题（使用qs）

问题描述：在用 Axios 发送 POST/PUT 请求时，参数是放在请求体中的，因此要使用 data 来传递值：

axios({
    method: 'post',
    url: '/api/lockServer/search',
    data: {
        "username": "test",
        "psd": "123456"
    } 
})

但是在后台（Tomact + SpringBoot + SpringMVC）接收参数的时候，接收不到。

解决方案：

用 qs.stringify() 将对象序列化成URL的形式，qs 是 axios 里面自带的，所以直接引入就可以了
设置请求头里的 Content-Type 为 application/x-www-form-urlencoded（实测不加也可以）

import qs from 'qs'
let data = {
    "username": "test",
    "psd": "123456"
}
 
axios({
    //headers: {
    //    'Content-Type': 'application/x-www-form-urlencoded'
    //},
    method: 'post',
    url: '/api/lockServer/search',
    data: qs.stringify(data)
})

axios qs

Axios使用详解