Axios 详解

一、axios简介

axios是一个基于promise的网络请求库，作用于nodejs和浏览器中；在服务端使用原生node中http模块发送请求，浏览器中使用xmlhttprequest请求；

1.1. 特点

• 支持浏览器和 node.js
• 支持 promise
• 能拦截请求和响应
• 能转换请求和响应数据
• 能取消请求
• 自动转换 json 数据
• 浏览器端支持防止 csrf (跨站请求伪造)

1.2. 安装

• 利用 npm 安装 npm install axios --save
• 利用 bower 安装 bower install axios --save
• 直接利用 cdn 引入
  <script src="https://cdn.jsdelivr.net/npm/axios@0.12.0/dist/axios.min.js"></script>

二、例子

2.1. 发送一个get请求

axios
  .get("/user?id=12345")
  .then(function (response) {
    console.log(response);
  })
  .catch(function (err) {
    console.log(err);
  });

以上请求也可以通过这种方式来发送

axios
  .get("/user", {
    params: {
      id: 12345,
    },
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (err) {
    console.log(err);
  });

2.2. 发送一个post请求

axios
  .post("/user", {
    firstname: "fred",
    lastname: "flintstone",
  })
  .then(function (res) {
    console.log(res);
  })
  .catch(function (err) {
    console.log(err);
  });

2.3. 一次性并发多个请求

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的api

3.1. axios可以通过配置（config）来发送请求

• axios(config)

//发送一个`post`请求
axios({
  method: "post",
  url: "/user/12345",
  data: {
    firstname: "fred",
    lastname: "flintstone",
  },
});

• axios(url[,config])

//发送一个`get`请求（默认的请求方式）
axios("/user/12345");

3.2. 请求方式的别名

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

3.3. 并发请求（concurrency）,即是帮助处理并发请求的辅助函数

//iterable是一个可以迭代的参数如数组等
axios.all(iterable);
//callback要等到所有请求都完成才会执行
axios.spread(callback);

3.4. 创建一个axios实例，并且可以自定义其配置

• axios.create([config])

const instance = axios.create({
  baseurl: "https://some-domain.com/api/",
  timeout: 1000,
  headers: { "x-custom-header": "foobar" },
});

四、请求的配置对象config说明

{
  //`url`是请求的服务器地址
  url: "/user",
  //`method`是请求资源的方式
  method: "get", //default
  //如果`url`不是绝对地址，那么`baseurl`将会加到`url`的前面
  //当`url`是相对地址的时候，设置`baseurl`会非常的方便
  baseurl: "https://some-domain.com/api/",
  //`transformrequest`选项允许我们在请求发送到服务器之前对请求的数据做出一些改动
  //该选项只适用于以下请求方式：`put/post/patch`
  //数组里面的最后一个函数必须返回一个字符串、-一个`arraybuffer`或者`stream`
  transformrequest: [
    function (data) {
      //在这里根据自己的需求改变数据
      return data;
    },
  ],
  //`transformresponse`选项允许我们在数据传送到`then/catch`方法之前对数据进行改动
  transformresponse: [
    function (data) {
      //在这里根据自己的需求改变数据
      return data;
    },
  ],
  //`headers`选项是需要被发送的自定义请求头信息
  headers: { "x-requested-with": "xmlhttprequest" },
  //`params`选项是要随请求一起发送的请求参数----一般链接在url后面
  //他的类型必须是一个纯对象或者是urlsearchparams对象
  params: {
    id: 12345,
  },
  //`paramsserializer`是一个可选的函数，起作用是让参数（params）序列化
  //例如(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`选项时dada必须是以下几种类型之一
  //string/plain/object/arraybuffer/arraybufferview/urlsearchparams
  //仅仅浏览器：formdata/file/bold
  //仅node:stream
  data: {
    firstname: "fred",
  },
  //`timeout`选项定义了请求发出的延迟毫秒数
  //如果请求花费的时间超过延迟的时间，那么请求会被终止

  timeout: 1000,
  //`withcredentails`选项表明了是否是跨域请求

  withcredentials: false, //default
  //`adapter`适配器选项允许自定义处理请求，这会使得测试变得方便
  //返回一个promise,并提供验证返回
  adapter: function (config) {
    /*..........*/
  },
  //`auth`表明http基础的认证应该被使用，并提供证书
  //这会设置一个authorization头（header）,并覆盖你在header设置的authorization头信息
  auth: {
    username: "zhangsan",
    password: "s00sdkf",
  },
  //返回数据的格式
  //其可选项是arraybuffer,blob,document,json,text,stream
  responsetype: "json", //default
  //
  xsrfcookiename: "xsrf-token", //default
  xsrfheadername: "x-xsrf-token", //default
  //`onuploadprogress`上传进度事件
  onuploadprogress: function (progressevent) {},
  //下载进度的事件
  ondownloadprogress: function (progressevent) {},
  //相应内容的最大值
  maxcontentlength: 2000,
  //`validatestatus`定义了是否根据http相应状态码，来resolve或者reject promise
  //如果`validatestatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态就是rejected
  //不配置默认status >= 200 && status < 300是resolved否则其状态就是rejected
  validatestatus: function (status) {
    return status >= 200 && status < 300; //default
  },
  //`maxredirects`定义了在nodejs中重定向的最大数量
  maxredirects: 5, //default
  //`httpagent/httpsagent`定义了当发送http/https请求要用到的自定义代理
  //keeyalive在选项中没有被默认激活
  httpagent: new http.agent({ keeyalive: true }),
  httpsagent: new https.agent({ keeyalive: true }),
  //proxy定义了主机名字和端口号，
  //`auth`表明http基本认证应该与proxy代理链接，并提供证书
  //这将会设置一个`proxy-authorization` header,并且会覆盖掉已经存在的`proxy-authorization`  header
  proxy: {
    host: "127.0.0.1",
    port: 9000,
    auth: {
      username: "skda",
      password: "radsd",
    },
  },
  //`canceltoken`定义了一个用于取消请求的cancel token
  //详见cancelation部分
  canceltoken: new canceltoken(function (cancel) {}),
};

五、请求成功返回的内容

{
  // `data` 由服务器提供的响应，会自动解析为json格式
  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: {},
};

六、默认的全局配置

//请求基础地址,比如设置为如下，那么我们在配置url属性的时候就只需要写基础地址之后的内容
//url: 'http://localhost:3000/title' => url: /title
axios.defaults.baseurl = 'https://localhost:3000';
axios.defaults.headers.common['authorization'] = auth_token;
//content-type来表示具体请求中的媒体类型信息，确切的来说是客户端告知服务端，
//自己即将发送的请求消息携带的数据结构类型，好让服务端接收后以合适的方式处理。
axios.defaults.headers.post['content-type'] = 'application/x-www-form-urlencoded';
//请求类型
axios.defaults.method = 'get';
//`validatestatus`定义了是否根据http相应状态码，来resolve或者reject promise
//如果`validatestatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态就是rejected
//不配置默认2xx认为是resolved否则其状态就是rejected
axios.defaults.validatestatus = function (status) {
  return status >= 200 && status <= 299; 
};

七、自定义的实例默认设置

// 创建实例时配置默认值
const instance = axios.create({
  baseurl: 'https://localhost:3000'
});
// 创建实例后修改默认值
instance.defaults.headers.common['authorization'] = auth_token;
 
//使用起来
instance({
  method: 'get',
  url: '/title/1'
}).then(res => {
  console.log(res)
})

八、配置中的有优先级

config配置将会以优先级别来合并

//创建一个实例的时候会使用libray目录中的默认配置
//在这里timeout配置的值为0，来自于libray的默认值
var instance = axios.create();
//回覆盖掉library的默认值
//现在所有的请求都要等2.5s之后才会发出
instance.defaults.timeout = 2500;
//这里的timeout回覆盖之前的2.5s变成5s
instance.get("/longrequest", {
  timeout: 5000,
});

九、拦截器

9.1. 请求拦截器和响应拦截器

• 请求与响应拦截器分别有成功与失败的回调函数
• 当请求拦截到请求失败的时候，对应的响应拦截器执行的就是响应失败的回调

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return promise.reject(error);
  });
 
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return promise.reject(error);
  });

9.2. 取消拦截器

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

9.3. 给自定义的axios实例添加拦截器

var instance = axios.create();
instance.interceptors.request.use(function () {});

十、错误处理

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.header);
  } else {
    //一些错误是在设置请求的时候触发
    console.log("error", error.message);
  }
  console.log(error.config);
});

十一、取消请求

11.1. 方法一

你可以通过canceltoken.source工厂函数来创建一个cancel token

var canceltoken = axios.canceltoken;
var source = canceltoken.source();

axios
  .get("/user/12345", {
    canceltoken: source.token,
  })
  .catch(function (thrown) {
    if (axios.iscancel(thrown)) {
      console.log("request canceled", thrown.message);
    } else {
      //handle error
    }
  });

//取消请求（信息的参数可以设置的）
source.cance("操作被用户取消");

11.2. 方法二

var canceltoken = axios.canceltoken;
var cance;
axios.get("/user/12345", {
  canceltoken: new canceltoken(function (c) {
    //这个executor函数接受一个cancel function作为参数
    cancel = c;
  }),
});
//取消请求
cancel();