走马观花之Axios

1 Axios是什么

一个基于 Promise 的HTTP库，异步，用于浏览器和nodejs

API：https://www.kancloud.cn/yunye/axios/234845

功能：

• 创建XMLHttpRequests
• nodejs创建http请求
• 支持Promise API
• 拦截请求和响应
• 对req和res数据转换
• 取消请求
• 自动json转换
• 客户端支持防御XSRF

2 安装

npm i axios

导入：
import axios from 'axios'

3 典型用法

GET

axios.get(url[, config])

// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});
// 可选地，上面的请求可以这样做
axios.get('/user', {
  params: {
    ID: 12345
  }
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});

then用于成功回调
catch用于失败回调

POST

axios.post(url[, data[, config]])

axios.post('/user', {
  firstName: 'Fred',
  lastName: 'Flintstone'
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});

创建通用请求

axios(config)

axios({
  methods: 'post',
  url: 'http://jsonplaceholder.typicode.com/users',
  data: {
  name: 'qiurx'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })

多并发请求

  function getUserAccount() {
    return axios.get('/user/12345');   //请求1
  }
  
  function getUserPermissions() {
    return axios.get('/user/12345/permissions');   //请求2
  }
  
  axios.all([getUserAccount(), getUserPermissions()])   //两个请求放到数组中传递给all()
    .then(axios.spread(function (acct, perms) {   //多个请求都发送完毕，拿到返回的数据
      // 两个请求现在都执行完成
    }));

注意：可以使用axios.spread来将数组结果展开，但是也可以不展开，自己for循环拿或者使用数组解构

数组解构：
let names= [ ‘p’, ‘q’, ‘x’ ]
let [ a, b, c ] = names
可以将names中的变量直接赋值到前面的abc变量中

4 全局配置

有些时候请求的url前缀是重复的或者说某些请求的属性是重复的，可以配置全局axios配置来简化：

axios.defaults.baseURL = 'http://10.2.2.1:8888'
axios.defaults.headers.post['Content-Type'] = 'appliaction/x-www-form-urlencode'

5 自定义axios实例

由于全局配置会让所有请求的属性保持一致，但是实际上对不同功能可能属性要求不一样，创建axios实例可以有效避免这种情况，每个实例可以有自己的属性，以此来区分！！

// config中放的当前实例的全局配置
axios.create(config)
 
//create创建一个新的实例对象
var instance = axios.create({
  url: 'http://jsonplaceholder.typicode.com/users',
  timeout: 3000,
  method: 'post'
});
//即可调用方法，和axios实例同
instance.get('http://jsonplaceholder.typicode.com/users').then(Response=>{
  console.log(Response);
});

6 响应体结构

  {
    // `data` 由服务器提供的响应
    data: {},
  
    // `status` XMLHttpRequest添加的响应的 HTTP 状态码
    status: 200,
  
    // `statusText` XMLHttpRequest添加的 HTTP 状态信息
    statusText: 'OK',
  
    // `headers` XMLHttpRequest添加的响应的头
    headers: {},
  
    // `config` 是为请求提供的配置信息
    config: {}
  }

7 请求取消

可以使用 CancelToken.source 工厂方法创建 cancel token，像这样：

var CancelToken = axios.CancelToken;
var source = CancelToken.source();
//访问链接，传入一个token，一般放在请求连接button上
axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // 处理错误
  }
});
// 取消请求（message 参数是可选的），一般放在取消请求button上
source.cancel('Operation canceled by the user.');

还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token：

var CancelToken = axios.CancelToken;
var cancel;
axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});
// 取消请求
cancel();

Note : 可以使用同一个 cancel token 取消多个请求

8 拦截器

会在then和catch前处理，可以用于请求动画：
请求拦截：axios.interceptors.request.use(func1,func2)
响应拦截：axios.interceptors.response.use(func1,func2)
其中，func1是成功的回调，参数为axios的config，func2是失败的回调，参数为error

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
  // 在发送请求之前做些什么，比如查看当前某些请求中是否有token，没有的话就重定向到登录
  return config;
}, function (error) {
  // 对请求错误做些什么
  return Promise.reject(error);
});

axios.interceptors.response.use(res=>{
  // 在响应时获取服务器的响应，不需要XMLRequest添加的其他信息，故拿到其中的data即可
  return res.data;
}, err=> {
  // 对请求错误做些什么
  return Promise.reject(err);
});

移除拦截器：

var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

9 错误处理

只要不是2xx内都会被捕获

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 {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

可以使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 状态码在大于或等于500时才会 reject
  }
})

10 配置config

  {
    // `url` 是用于请求的服务器 URL
    url: '/user',
  
    // `method` 是创建请求时使用的方法
    method: 'get', // 默认是 get
  
    // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
    // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
    baseURL: 'https://some-domain.com/api/',
  
    // `transformRequest` 允许在向服务器发送前，修改请求数据
    // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
    // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
    transformRequest: [function (data) {
      // 对 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, // 默认的
  
    // `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', // 默认的
  
    // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
    xsrfCookieName: 'XSRF-TOKEN', // default
  
    // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
    xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
  
    // `onUploadProgress` 允许为上传处理进度事件
    onUploadProgress: function (progressEvent) {
      // 对原生进度事件的处理
    },
  
    // `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; // 默认的
    },
  
    // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
    // 如果设置为0，将不会 follow 任何重定向
    maxRedirects: 5, // 默认的
  
    // `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) {
    })
  }

11 封装Axios

为了防止项目各模块各组件对第三方包的过度依赖，可以自己封装一个接口，然后在组件中使用自己封装的文件，这样在替换第三方包的时候就可以只改动自己封装的文件即可！

封装axios有很多方式：

方式1：创建自己的request.js文件，文件中定义多个axios实例，每个实例接收config并返回结果，传入回调函数和axios的config

export function request(config){
	const instance = axios.create({
		// 定义当前实例的全局属性
		baseURL: 'http://1.1.1.1',
		timeout: 5000
	})
	instance(config.baseConfig)
	.then(res=>config.success(res))
	.catch(err=>config.failure(err))
}
// 使用
request({
	baseConfig:{},
	success:function(){},
	failure:function(){}
})

方式2：使用promise

export function request(config){
	return new Promise((resolve,reject)=>{
		const instance = axios.create({
			baseURL: 'http://1.1.1.1',
			timeout: 5000
		})
		instance(config)
		.then(res=>resolve(res))
		.catch(err=>reject(res))
	}
}
// 使用
request({...})
.then()
.catch()

方式3：直接返回（因为axios返回的就是promise，无需再封装一层）

export function request(config){
	const instance = axios.create({
		baseURL: 'http://1.1.1.1',
		timeout: 5000
	})
	
	instance.interceptors.request.use(config=>{},err=>{})
	instance.interceptors.response.use(res=>{},err=>{})
	return instance(config)
}
// 使用
request({...})
.then()
.catch()

---

参考文档：
https://www.kancloud.cn/yunye/axios/234845

12 前端接收后端的二进制流下载

https://blog.youkuaiyun.com/xiapi3/article/details/113869990