axios简单使用

学习笔记

一、简介

1. axios 是一个基于 Promise 的 HTTP 库，可以用在浏览器和node.js中。

2. 本质：发送请求，获得相对应的响应结果并处理。

3. 设计理念：为了实现对页面的无刷新更新数据操作。

4. Vue.js 2.0 推荐使用 axios 来完成 ajax 请求。

5. then 里面是成功后返回的数据，而 catch 则是 404 之类的响应。

6. axios VS ajax：axios是局部的ajax，而ajax拥有的axios不一定拥有。

   axios	ajax
   组件化设置，导入体积小	基于JQuery，需全部导入，体积大

---

二、安装方法

1. cdn

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

2. 使用npm

   npm install axios
   1

---

三、简单使用

1. get请求

   • response.data可以读取JSON数据。例如：response.data.studentName

   axios.get('/csdn/count')
       .then(function (response) {
           console.log(response);
       })
       .catch(function (error) {
           console.log(error);
       });
   1
   2
   3
   4
   5
   6
   7

   • 传参（两种方式，相当于方法重载）：
     1. 利用 url 拼接
     2. 使用 Param 进行参数设置

   axios.get('/user?ID=12345')......
   
   axios.get('/user', {
       params: {
         ID: 12345
       }
     })
   1
   2
   3
   4
   5
   6
   7

2. POST请求

   • 不带参

   axios.post('/csdn/posts').then(response => {
       console.log(response)
   }).catch(error => {
       console.log(error)
   });
   1
   2
   3
   4
   5

   • 带参（没有Param对象，所以这里跟Get还是有点不一样的）

   function post() {
     	let params = new FormData();
   		params.append("url", 'aaa');
     
       axios.post('/csdn/posts', params).then(response => {
           console.log(response)
       }).catch(error => {
           console.log(error)
       });
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10

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) {
       // 两个请求现在都执行完成
     }));
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11

---

四、axios API

1. 简介：可以通过向 axios 传递相关配置来创建请求。

2. 发送Get请求

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

3. 发送POST请求

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

4. 请求方法别名

   • 可以直接使用别名来发起请求（简化操作）
   • 在使用别名的时候，url、method、data这些属性都不必在配置中指定。

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

5. 处理并发

   axios.all(iterable)
   axios.spread(callback)
   1
   2

6. 关于实例的使用方式

   • 创建实例（创建标准模板）

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

   • 使用实例

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

7. 代理的一些注意事项

   // "proxy" 定义代理服务器的主机名称和端口
   // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
   // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
   
     proxy: {
       host: "127.0.0.1",
       port: 9000,
       auth: : {
         username: "mikeymike",
         password: "rapunz3l"
       }
     },
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12

---

五、响应数据

1. 说明：

   • 使用axios来发送请求会返回固定格式数据。
   • 所以说then语句中的response对象拥有的“大”的属性是固定的。

   {
     // `data` 由服务器提供的响应
     data: {},
   
     // `status`  HTTP 状态码
     status: 200,
   
     // `statusText` 来自服务器响应的 HTTP 状态信息
     statusText: "OK",
   
     // `headers` 服务器响应的头
     headers: {},
   
     // `config` 是为请求提供的配置信息
     config: {}
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16

   <!-- 测试打印 -->
   axios.get("/user/12345")
     .then(function(response) {
       console.log(response);
     });
   1
   2
   3
   4
   5

---

六、axios全局配置

1. 简介

   • 可在 js 代码第一行设置全局配置，对全局生效。
   • 有用，比如baseURL、timeout（实测生效）。
   • 就近原则，越近越优先。

   axios.defaults.baseURL = 'https://api.example.com';
   axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
   axios.defaults.headers.post['Content-Type'] = 'xxx';
   axios.defaults.timeout = 1000;
   1
   2
   3
   4

2. **编写思想：**其实只要将普通的配置加上默认前缀即可

   axios.defaults.
   1

---

七、拦截器

​ axios存在【拦截器】机制，可以在发送请求前及后对请求或响应进行拦截。常用于对模板的配置

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

---

附录：请求配置

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