《Axios》axios的初识与摘要

《Axios》axios的初识与摘要

Axios

简介

官方描述：Axios，基于 Promise 的 HTTP 客户端，可以工作于浏览器中，也可以在 node.js 中使用。本质上讲，也是对XHR进行了封装，不同的是axios使用Promise实现的，因此更符合ES规范；

Vue毫无疑问，大火，并且Vue 2.0之后，明确表示不再维护vue-resource，改而推荐使用Axios，从此Axios加入了Vue全家桶；

优点

和Fetch相比，兼容性好的多，Fetch由于是采用的新技术，而不是对XMLHttpRequest对象进行的封装，因此这代表它的兼容性稍差，如果项目要考虑一定的兼容性，那么使用Fetch要谨慎些；

和jQ的Ajax相比，jQ有个硬伤，就是不能单独使用jQ的Ajax，当然如果项目是基于jQ编写的，那么axios对项目而言，完全没用，jq封装的ajax其实相当的完善了，但是相信现在而言很多的项目是基于Vue，React等前端框架，在这些框架框架中其体系本身就已经很完善了，为了单单使用一个ajax就引入整个jQ好像不是很划算；

原生XMLHttpRequest对象

无论如何，原生JS实现的Ajax还是有必要了解的，虽然现实中不大使用，在jq风靡之后，由于jq中有ajax方法（该方法也是对原生进行的封装）并且大大简化了书写代码，基本上其使用的都是jq封装的Ajax方法；

var request = new XMLHttpRequest(); // 创建XMLHttpRequest对象

//ajax是异步的，设置回调函数
request.onreadystatechange = function () { // 状态发生变化时，函数被回调
    if (request.readyState === 4) { // 成功完成
        // 判断响应状态码
        if (request.status === 200) {
            // 成功，通过responseText拿到响应的文本:
            return success(request.responseText);
        } else {
            // 失败，根据响应码判断失败原因:
            return fail(request.status);
        }
    } else {
        // HTTP请求还在继续...
    }
}

// 发送请求:
request.open('GET', '/api/categories');
request.setRequestHeader("Content-Type", "application/json") //设置请求头
request.send();//到这一步，请求才正式发出

这个例子是从axios官网上拷贝下来的，代码量以及复杂程度远远超过了axios和jq的ajax，了解一下就好，平时相信用的人也不会太多，其实是我也不大了解，没法细写 = =！

安装

npm install axios	//推荐还是cnpm方式代替npm

或者cdn引入

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

简单使用

首先推荐一个mock数据的网址：http://jsonplaceholder.typicode.com/，上面可以提供get或者post方式的数据，还是挺好用的；

如果是使用cdn的方式引入的可以直接通过axios使用，比如

axios.get('http://jsonplaceholder.typicode.com/posts').then((res)=>{
    console.log(res)
})

如果是vue脚手架搭建的项目，那么就需要通过npm（或cnpm）安装，安装后引入，因为axios不是Vue的插件，因此需要将axios挂载到Vue的原型上，以便全局调用（当然，如果axios不需要全局调用，仅仅需要在某个组件内使用，那么就没必要全局挂载，哪个组件需要使用就哪个组件import）

//main.js文件
import axios from 'axios';
Vue.prototype.$axios = axios;

之后，就可以在任意组件内，通过this.$axios调用axios上的方法了，比如

//某组件内
this.$axios.get('http://jsonplaceholder.typicode.com/posts').then((res)=>{
  console.log(res)
})

请求拦截，响应拦截设置之类的这边先不记录，等介绍完了再补充完整，因为在我个人遇到的项目中axios还是需要进行一次封装的，具体就是将请求拦截，响应拦截，每次请求都携带token等等都封装在一起以及将对外的api接口作统一管理，这么做的好处就是，一方面大大简化了代码，另一方面，万一以后，突然间，产品告诉你，需要在请求中加入xxx，或者原来的xxx改成ooo，如果没有统一管理，而你有100个组件里都带有请求，这个时候你不想拿出40米的大刀，我敬你是条汉子…

方法示例

先看一下大致的使用方式，使用的时候基本就是这样

GET请求

// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

POST请求

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

多个并发请求

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

Axiso API

axios()

axios(config)

简单示例中的axios.post()，axios.get()其实都是使用的axios的别名，或者说是简写，其实完整的写法是将类型，地址，数据等等都写在config中，比如

// 发送 POST 请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

// 获取远端图片
axios({
  method:'get',
  url:'http://bit.ly/2mTM3nY',
  responseType:'stream'
})
  .then(function(response) {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
});

axios(url[,config])

另外axios可以仅传入一个url地址，代表将默认使用get的方式，向url请求数据

// 发送 GET 请求（默认的方法）
axios('/user/12345');

别名

具体的别名有

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]])

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

并发

同时处理多个请求的函数

axios.all(iterable)

axios.spread(callback)

实例

创建示例

通过axios.create([config])新创建axios的实例

//创建了一个axios的实例，instance，并且这个实例上有默认的三项设置
//1.设置请求的url的前缀，
//2.设置请求的超时时间是1000毫秒
//3.设置请求头
const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

配置默认值

全局添加

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';

为创建的实例添加

创建好实例后需要为实例设置默认值，一种是上面的通过创建时配置，另外一个则是和全局添加一样通过default添加进实例

// Set config defaults when creating the instance
const instance = axios.create({
  baseURL: 'https://api.example.com'
});

// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置的优先级

当请求发起的时候，如果发现有多个相同的配置，则会对配置进行合并，合并优先级如下：
请求时设置的confing > 实例上设置的默认值 > axios设置的系统默认值

// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();

// 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
  timeout: 5000
});

具体配置

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 get 方法。

{
  url: '/user',	//请求的服务器 URL
  method: 'get', 	// 请求时使用的方法，默认是get
  // 前缀地址，值将作为前缀添加到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: {'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) {
  })
}

响应结构

每个请求的响应都会包含一下信息

{
  data: {},	//由服务器提供的响应
  status: 200,	//来自服务器响应的 HTTP 状态码
  statusText: 'OK',	//来自服务器响应的 HTTP 状态信息
  headers: {},	//服务器响应的头
  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: {}
}

具体接收则通过then方法，比如

axios.get('/user/12345')
  .then(function(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

拦截器

顾名思义，拦截器就是会在每一次请求或者响应前都会对其进行拦截，并按设定好的要求做处理，比如，每一次请求前都需要判断当前token是否存在

请求拦截

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    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);

为创建的实例添加拦截

const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // The request was made and the server responded with a status code
      // that falls out of the range of 2xx
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // The request was made but no response was received
      // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
      // http.ClientRequest in node.js
      console.log(error.request);
    } else {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

案例示例

上面说的，一般axios在项目中是需要进过一次封装的，下面这个就是一个简单的示例，目的是想说明，一般使用还是按具体需求，将共用的，通用的一些配置，参数都封装在一起，独有的再每次调用的时候在确认（比如每次的请求方式，是post还是get，可以不封装），以Vue中为例，安装或者引入之后，

//引入axios
import axios from 'axios';
//引入elementUI
import { Message } from 'element-ui';

//设置默认地址
	const configBaseURL = '';

//创建一个axios实例,设置超时时间为10秒，
const service = axios.create({
    timeout:10000，  //超市时间
		baseUrl:configBaseURL
})

//设置请求拦截器
service.interceptors.request.use((config) => {
  	//如果使用了UI库，还可以在这边添加loading动画，效果就是每次请求的时候都会出现loading
  
    //if的作用：判断本地localStorage中存不存在token，如果存在，就给每一个http的header都加上token
    if(localStorage.tsToken){
        //设置自动给每一个header都加上token
        config.headers.Authorization = localStorage.tsToken;
    }
    return config;
},(err) => {
    Promise.reject(err);
})

//设置响应拦截，如果设置了loading动画，这里在响应中把loading关闭
service.interceptors.response.use((response) => {
    return response
},(err) => {
    let errMsg = "";
    if(err && err.response.status){
        switch (err.response.status){
            case 401:
                errMsg = '登录失效了，请重新登录';
                //返回401，说明token已经失效了，那么就跳转到登录页面
                localStorage.removeItem('tsToken');
                router.push('/login');
                break;

            case 403:
                errMsg = '拒绝访问';
                break;

            case 408:
                errMsg = '请求超时';
                break;

            case 500:
                errMsg = '服务器内部错误';
                break;

            case 501:
                errMsg = '服务未实现';
                break;

            case 502:
                errMsg = '网关错误';
                break;
            
            case 503:
                errMsg = '服务不可用';
                break;
                
            case 504:
                errMsg = '网关超时';
                break;
            
            case 505:
                errMsg = 'HTTP版本不受支持';
                break;

            default:
                errMsg = err.response.data.msg;
                break;
        }
    }
    else{
        errMsg = err;
    }
		//使用elementUI中的Message组件提示错误
    Message.error(errMsg);

    return Promise.reject(errMsg);
})

export default service;