axios使用

axios 使用

基本介绍

是什么？

axios 是基于 promise（诺言）用于浏览器和 node.js 是 http 客户端。

作用

axios 主要是用于向后台发起请求的，还有在请求中做更多是可控功能。

特点

  • 支持浏览器和 node.js
  • 支持 promise
  • 能拦截请求和响应
  • 能转换请求和响应数据
  • 能取消请求
  • 自动转换 JSON 数据
  • 浏览器支持防止 CSRF（跨站请求伪造）

基本使用方法

执行 GET 请求

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 给给定id的user创建请求
axios.get('/user?id=123')
  .then(function (response)){
    console.log(response);
  }
  .catch(function (error){
    console.log(error);
  })
// 可选项，上面的请求可以这样做
axios.get('/user',{
    params:{id:123}
  })
  .then(function (response)){
    console.log(response);
  }
  .catch(function (error){
    console.log(error);
  })

执行 POST 请求

1
2
3
4
5
6
7
8
9
10
axios.post('/user',{
    name:'zhangsan',
    age:25
  })
  .then(function (response)){
    console.log(response);
  }
  .catch(function (error){
    console.log(error);
  });

执行多个并发请求

1
2
3
4
5
6
7
8
9
10
11
12
13
function getUserAccount() {
  return axios.get("/user/123");
}

function getUserPermissions() {
  return axios.get("/user/123/permissions");
}

axios.all([getUserAccount(), getUserPermissions()]).then(
  axios.spread(function (acct, perms) {
    // 当这两个请求都完成的时候会触发这个函数，两个参数分别代表返回的结果
  })
);

axios 的 API

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

  • axios(config)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    //发送一个`POST`请求
    axios({
      method: "POST",
      url: "/user/12345",
      data: {
        firstName: "Fred",
        lastName: "Flintstone",
      },
    });

  • axios(url[,config])

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

请求方式的别名，这里对所有已经支持的请求方式都提供了方便的别名

1
2
3
4
5
6
7
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 这几个参数不需要在配置中声明

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

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

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

  • axios.create([config])

    1
    2
    3
    4
    5
    var instance = axios.create({
      baseURL: "https://some-domain.com/api/",
      timeout: 1000,
      headers: { "X-Custom-Header": "foobar" },
    });

  • 实例的方法
    以下是实例方法，注意已经定义的配置将和利用 create 创建的实例的配置合并

    1
    2
    3
    4
    5
    6
    7
    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]])

请求的配置（request config）

以下就是请求的配置选项，只有 url 选项是必须的，如果 method 选项未定义，那么它默认是以 GET 的方式发出请求

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
  //`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
  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){})
}

请求返回的内容

1
2
3
4
5
6
7
8
9
10
{
  data:{},
  status:200,
  //从服务器返回的http状态文本
  statusText:'OK',
  //响应头信息
  headers: {},
  //`config`是在请求的时候的一些配置信息
  config: {}
}

获取响应信息

1
2
3
4
5
6
7
axios.get("/user/12345").then(function (res) {
  console.log(res.data);
  console.log(res.status);
  console.log(res.statusText);
  console.log(res.headers);
  console.log(res.config);
});

默认配置

你可以设置默认配置，对所有请求都有效

全局默认配置

1
2
3
4
axios.defaults.baseURL = "http://api.exmple.com";
axios.defaults.headers.common["Authorization"] = AUTH_TOKEN;
axios.defaults.headers.post["content-Type"] =
  "appliction/x-www-form-urlencoded";

自定义的实例默认设置

1
2
3
4
5
6
7
//当创建实例的时候配置默认配置
var instance = axios.create({
  baseURL: "https://api.example.com",
});

//当实例创建时候修改配置
instance.defaults.headers.common["Authorization"] = AUTH_TOKEN;

配置中的有优先级

config 配置将会以优先级别来合并，顺序是 lib/defauts.js 中的默认配置，然后是实例中的默认配置，最后是请求中的 config 参数的配置，越往后等级越高，后面的会覆盖前面的例子。

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

拦截器

  • 在请求或响应被 then 或 catch 处理前拦截它们
  • 拦截器可以做什么：在请求或者响应时拦截下来进行处理
  • 拦截器分为请求拦截器和响应拦截器
    1. 请求拦截器（interceptors.requst）是指可以拦截每次或指定 HTTP 请求，并可修改配置项。
    2. 响应拦截器（interceptors.response）可以在每次 HTTP 请求后拦截住每次或指定 HTTP 请求，并可修改返回结果项。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//添加一个请求拦截器
axios.interceptors.request.use(
  function (config) {
    //在请求发出之前进行一些操作
    return config;
  },
  function (err) {
    //Do something with request error
    return Promise.reject(error);
  }
);
//添加一个响应拦截器
axios.interceptors.response.use(
  function (res) {
    //在这里对返回的数据进行处理
    return res;
  },
  function (err) {
    //Do something with response error
    return Promise.reject(error);
  }
);

取消拦截器

1
2
3
4
var myInterceptor = axios.interceptor.request.use(function () {
  /*....*/
});
axios.interceptors.request.eject(myInterceptor);

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

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

错误处理

1
2
3
4
5
6
7
8
9
10
11
12
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);
});

取消

你可以通过一个 cancel token 来取消一个请求

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    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.cancel("操作被用户取消");

  • 你可以给 cancelToken 构造函数传递一个 executor function 来创建一个 cancel token

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    var cancelToken = axios.CancelToken;
    var cancel;
    axios.get("/user/12345", {
      cancelToken: new CancelToken(function (c) {
        //这个executor函数接受一个cancel function作为参数
        cancel = c;
      }),
    });
    //取消请求
    cancel();

应用于 vue 封装 request 方法

  • 创建实例
    放置默认配置 baseURL 等
  • 增加拦截器
    可以对访问请求 与 响应拦截操作 对数据进行二次加工
  • 返回网络请求
    1. 返回 promise 对象 完成封装
    2. 在外部使用.then()继续实现下一步操作
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
export function request(config) {
  //1.创建axios实例
  const instance = axios.create({
    baseURL: "",
    timeout: 5000,
  });

  //2.axios拦截器
  //2.1请求拦截
  instance.interceptors.request.use(
    (config) => {
      //拦截操作
      return config; //必须返回回去 否则调用处取不到
    },
    (err) => {
      //console.log(err)
    }
  );
  //2.2响应拦截
  instance.interceptors.response.use(
    (res) => {
      //拦截操作
      return res; //必须返回回去 否则调用处取不到
    },
    (err) => {
      //console.log(err)
    }
  );

  //3发送真正的网络请求【返回promise对象】
  return instance(config);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// 引入axios
import axios from "axios";

// 创建axios实例
const httpService = axios.create({
  // url前缀-'https://some-domain.com/api/'
  baseURL: process.env.BASE_API, // 需自定义
  // 请求超时时间
  timeout: 3000, // 需自定义
});

// request拦截器
httpService.interceptors.request.use(
  (config) => {
    // 根据条件加入token-安全携带
    if (true) {
      // 需自定义
      // 让每个请求携带token
      config.headers["User-Token"] = "";
    }
    return config;
  },
  (error) => {
    // 请求错误处理
    Promise.reject(error);
  }
);

// respone拦截器
httpService.interceptors.response.use(
  (response) => {
    // 统一处理状态
    const res = response.data;
    if (res.statuscode != 1) {
      // 需自定义
      // 返回异常
      return Promise.reject({
        status: res.statuscode,
        message: res.message,
      });
    } else {
      return response.data;
    }
  },
  // 处理处理
  (error) => {
    if (error && error.response) {
      switch (error.response.status) {
        case 400:
          error.message = "错误请求";
          break;
        case 401:
          error.message = "未授权，请重新登录";
          break;
        case 403:
          error.message = "拒绝访问";
          break;
        case 404:
          error.message = "请求错误,未找到该资源";
          break;
        case 405:
          error.message = "请求方法未允许";
          break;
        case 408:
          error.message = "请求超时";
          break;
        case 500:
          error.message = "服务器端出错";
          break;
        case 501:
          error.message = "网络未实现";
          break;
        case 502:
          error.message = "网络错误";
          break;
        case 503:
          error.message = "服务不可用";
          break;
        case 504:
          error.message = "网络超时";
          break;
        case 505:
          error.message = "http版本不支持该请求";
          break;
        default:
          error.message = `未知错误${error.response.status}`;
      }
    } else {
      error.message = "连接到服务器失败";
    }
    return Promise.reject(error);
  }
);

/*网络请求部分*/

/*
 *  get请求
 *  url:请求地址
 *  params:参数
 * */
export function get(url, params = {}) {
  return new Promise((resolve, reject) => {
    httpService({
      url: url,
      method: "get",
      params: params,
    })
      .then((response) => {
        resolve(response);
      })
      .catch((error) => {
        reject(error);
      });
  });
}

/*
 *  post请求
 *  url:请求地址
 *  params:参数
 * */
export function post(url, params = {}) {
  return new Promise((resolve, reject) => {
    httpService({
      url: url,
      method: "post",
      data: params,
    })
      .then((response) => {
        resolve(response);
      })
      .catch((error) => {
        reject(error);
      });
  });
}

/*
 *  文件上传
 *  url:请求地址
 *  params:参数
 * */
export function fileUpload(url, params = {}) {
  return new Promise((resolve, reject) => {
    httpService({
      url: url,
      method: "post",
      data: params,
      headers: { "Content-Type": "multipart/form-data" },
    })
      .then((response) => {
        resolve(response);
      })
      .catch((error) => {
        reject(error);
      });
  });
}

export default {
  get,
  post,
  fileUpload,
};

案例

本地 data.json(放在 src 同级)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "seller": {
    "name": "粥品香坊（回龙观）",
    "description": "蜂鸟专送",
    "deliveryTime": 38,
    "score": 4.2,
    "serviceScore": 4.1,
    "foodScore": 4.3,
    "rankRate": 69.2,
    "minPrice": 20,
    "deliveryPrice": 4,
    "ratingCount": 24,
    "sellCount": 90,
    "bulletin": "粥品香坊其烹饪粥料的秘方源于中国千年古法，在融和现代制作工艺，由世界烹饪大师屈浩先生领衔研发。坚守纯天然、0添加的良心品质深得消费者青睐，发展至今成为粥类的引领品牌。是2008年奥运会和2013年园博会指定餐饮服务商。",
    "supports": [
      {
        "type": 0,
        "description": "在线支付满28减5"
      },
      {
        "type": 1,
        "description": "VC无限橙果汁全场8折"
      },
      {
        "type": 2,
        "description": "单人精彩套餐"
      },
      {
        "type": 3,
        "description": "该商家支持发票,请下单写好发票抬头"
      },
      {
        "type": 4,
        "description": "已加入“外卖保”计划,食品安全保障"
      }
    ],
    "avatar": "http://static.galileo.xiaojukeji.com/static/tms/seller_avatar_256px.jpg",
    "pics": [
      "http://fuss10.elemecdn.com/8/71/c5cf5715740998d5040dda6e66abfjpeg.jpeg?imageView2/1/w/180/h/180",
      "http://fuss10.elemecdn.com/b/6c/75bd250e5ba69868f3b1178afbda3jpeg.jpeg?imageView2/1/w/180/h/180",
      "http://fuss10.elemecdn.com/f/96/3d608c5811bc2d902fc9ab9a5baa7jpeg.jpeg?imageView2/1/w/180/h/180",
      "http://fuss10.elemecdn.com/6/ad/779f8620ff49f701cd4c58f6448b6jpeg.jpeg?imageView2/1/w/180/h/180"
    ],
    "infos": [
      "该商家支持发票,请下单写好发票抬头",
      "品类:其他菜系,包子粥店",
      "北京市昌平区回龙观西大街龙观置业大厦底商B座102单元1340",
      "营业时间:10:00-20:30"
    ]
  }
}

修改 webpack-dev-conf.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
//第一步
const express = require('express')
const app = express()//请求server
var appData = require('../data.json')//加载本地数据文件
var seller = appData.seller //获取对应的本地数据
var goods = appData.goods
var ratings = appData.ratings
var apiRoutes = express.Router()
app.use('/api', apiRoutes)//通过路由请求数据

//第二步
before(app) {
	app.get('/api/seller', (req, res) => {
		res.json({
			// 这里是你的json内容
			errno: 0,
			data: seller
		})
	}),
	app.post('/api/seller', (req, res) => {
		res.json({
			// 这里是你的json内容
			errno: 0,
			data: seller
		})
	})
}

axios.vue

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<template>
  <div>
    <h1>axios基础介绍</h1>
    <button @click="get">get请求</button>
    <button @click="post">post请求</button>
    <button @click="http">aixos</button>
    <p>{{ msg }}</p>
  </div>
</template>

<script>
import axios from "axios";
export default {
  data() {
    return {
      msg: "",
    };
  },
  created() {
    //全局拦截器
    axios.interceptors.request.use(
      function (config) {
        // 在发送请求之前做些什么
        console.log("config");
        console.log(config);
        return config;
      },
      function (error) {
        // 对请求错误做些什么
        return Promise.reject(error);
      }
    );
  },
  methods: {
    get() {
      //1.简单的获取
      // axios.get("/api/seller").then(res =>{
      // 	this.msg = res;
      // })
      //2.传参数
      axios
        .get("/api/seller", {
          //传参数
          params: { userid: "999" },
          //请求头部
          headers: {
            token: "jack",
          },
        })
        .then((res) => {
          this.msg = res;
        })
        .catch(function (error) {
          //获取错误
          console.log("error:" + error);
        });
    },
    post() {
      axios
        .post(
          "/api/seller",
          {
            //传参数
            userid: "888",
          },
          {
            headers: {
              //请求头部
              token: "tom",
            },
          }
        )
        .then((res) => {
          this.msg = res;
        })
        .catch(function (error) {
          //获取错误
          console.log("error:" + error);
        });
    },
    http() {
      //注意：get  传参是params   post传参是data
      axios({
        url: "/api/seller",
        methods: "get",
        params: {
          userid: "101",
        },
        headers: {
          token: "http-test",
        },
      }).then((res) => {
        this.msg = res;
      });
    },
  },
};
</script>

<style lang="scss"></style>