要了解的关于vue里面axios的基本知识都在这里

研究过vue.js的童鞋，对于axios肯定会有些了解，它基于Promise的HTTP客户端，用于浏览器和node.js。那如何去应用它呢？我们一起从最基础的学习起吧。

特征

首先了解下axios的一些主要特征应用：

1、从浏览器发出XMLHttpRequests

2、从node.js发出HTTP请求

3、支持Promise API

4、拦截请求和响应

5、转换请求和响应数据

6、取消请求

7、JSON数据的自动转换

8、客户端支持以防止XSRF

如何安装anios

使用npm：

$ npm install axios

使用bower:

$ bower install axios

使用yarn：

$ yarn add axios

使用cdn：

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

安装很简单的，接下来我们来看些如何在实际项目中的应用。

实例应用

注意：CommonJS用法

为了在将CommonJS导入与require（）一起使用时获得TypeScript类型（用于智能/自动完成），请使用以下方法：

1. const axios = require(‘axios’).default;
2. // axios。<method>现在将提供自动完成和参数输入

执行GET请求

1. const axios = require(‘axios’);
2.  
3. // Make a request for a user with a given ID
4. axios.get(‘/user?ID=12345’)
5.   .then(function (response) {
6.     // handle success
7.     console.log(response);
8.   })
9.   .catch(function (error) {
10.     // handle error
11.     console.log(error);
12.   })
13.   .finally(function () {
14.     // always executed
15.   });
16.  
17. // Optionally the request above could also be done as
18. axios.get(‘/user’, {
19.     params: {
20.       ID: 12345
21.     }
22.   })
23.   .then(function (response) {
24.     console.log(response);
25.   })
26.   .catch(function (error) {
27.     console.log(error);
28.   })
29.   .finally(function () {
30.     // always executed
31.   });  
32.  
33. // Want to use async/await? Add the `async` keyword to your outer function/method.
34. async function getUser() {
35.   try {
36.     const response = await axios.get(‘/user?ID=12345’);
37.     console.log(response);
38.   } catch (error) {
39.     console.error(error);
40.   }
41. }

注意：async / await是ECMAScript 2017的一部分，并且Internet Explorer和旧版浏览器不支持async / await，因此请谨慎使用。

执行POST请求

1. axios.post(‘/user’, {
2.     firstName: ‘Fred’,
3.     lastName: ‘Flintstone’
4.   })
5.   .then(function (response) {
6.     console.log(response);
7.   })
8.   .catch(function (error) {
9.     console.log(error);
10.   });

执行多个并发请求

1. function getUserAccount() {
2.   return axios.get(‘/user/12345’);
3. }
4.  
5. function getUserPermissions() {
6.   return axios.get(‘/user/12345/permissions’);
7. }
8.  
9. axios.all([getUserAccount(), getUserPermissions()])
10.   .then(axios.spread(function (acct, perms) {
11.     // Both requests are now complete
12.   }));

axios API

可以通过将相关配置传递给axios来发出请求。

axios（配置）

1. // Send a POST request
2. axios({
3.   method: ‘post’,
4.   url: ‘/user/12345’,
5.   data: {
6.     firstName: ‘Fred’,
7.     lastName: ‘Flintstone’
8.   }
9. });

1. // GET request for remote image
2. axios({
3.   method: ‘get’,
4.   url: ‘http://bit.ly/2mTM3nY’,
5.   responseType: ‘stream’
6. })
7.   .then(function (response) {
8.     response.data.pipe(fs.createWriteStream(‘ada_lovelace.jpg’))
9.   });

axios（URL [，config]）

1. // Send a GET request (default method)
2. axios(‘/user/12345’);

Request method aliases

为了方便起见，aliases已为所有受支持的请求方法。

1. axios.request（配置）
2. axios.get（URL [，config]）
3. axios.delete（url [，config]）
4. axios.head（url [，config]）
5. axios.options（url [，config]）
6. axios.post（URL [，data [，config]]）
7. axios.put（URL [，data [，config]]）
8. axios.patch（url [，data [，config]]）

注意

使用别名方法时，无需在config中指定url，method和data属性。

并发

帮助程序功能，用于处理并发请求。

1. axios.all（可迭代）
2. axios.spread（回调）

创建一个实例

您可以使用自定义配置创建axios的新实例。

axios.create（[config]）

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

实例方法

可用的实例方法在下面列出。指定的配置将与实例配置合并。

1. axios＃request（config）
2. axios＃get（URL [，config]）
3. axios＃delete（url [，config]）
4. axios＃head（url [，config]）
5. axios＃options（url [，config]）
6. axios＃post（url [，data [，config]]）
7. axios＃put（url [，data [，config]]）
8. axios＃patch（url [，data [，config]]）
9. axios＃getUri（[config]）

请求配置

这些是发出请求的可用配置选项。仅URL是必需的。如果未指定method，则请求将默认为GET。

1. {
2.   // `url` is the server URL that will be used for the request
3.   url: ‘/user’,
4.  
5.   // `method` is the request method to be used when making the request
6.   method: ‘get’, // default
7.  
8.   // `baseURL` will be prepended to `url` unless `url` is absolute.
9.   // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
10.   // to methods of that instance.
11.   baseURL: ‘https://some-domain.com/api/’,
12.  
13.   // `transformRequest` allows changes to the request data before it is sent to the server
14.   // This is only applicable for request methods ‘PUT’, ‘POST’, ‘PATCH’ and ‘DELETE’
15.   // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
16.   // FormData or Stream
17.   // You may modify the headers object.
18.   transformRequest: [function (data, headers) {
19.     // Do whatever you want to transform the data
20.  
21.     return data;
22.   }],
23.  
24.   // `transformResponse` allows changes to the response data to be made before
25.   // it is passed to then/catch
26.   transformResponse: [function (data) {
27.     // Do whatever you want to transform the data
28.  
29.     return data;
30.   }],
31.  
32.   // `headers` are custom headers to be sent
33.   headers: {‘X-Requested-With’: ‘XMLHttpRequest’},
34.  
35.   // `params` are the URL parameters to be sent with the request
36.   // Must be a plain object or a URLSearchParams object
37.   params: {
38.     ID: 12345
39.   },
40.  
41.   // `paramsSerializer` is an optional function in charge of serializing `params`
42.   // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
43.   paramsSerializer: function (params) {
44.     return Qs.stringify(params, {arrayFormat: ‘brackets’})
45.   },
46.  
47.   // `data` is the data to be sent as the request body
48.   // Only applicable for request methods ‘PUT’, ‘POST’, and ‘PATCH’
49.   // When no `transformRequest` is set, must be of one of the following types:
50.   // – string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
51.   // – Browser only: FormData, File, Blob
52.   // – Node only: Stream, Buffer
53.   data: {
54.     firstName: ‘Fred’
55.   },
56.   
57.   // syntax alternative to send data into the body
58.   // method post
59.   // only the value is sent, not the key
60.   data: ‘Country=Brasil&City=Belo Horizonte’,
61.  
62.   // `timeout` specifies the number of milliseconds before the request times out.
63.   // If the request takes longer than `timeout`, the request will be aborted.
64.   timeout: 1000, // default is `0` (no timeout)
65.  
66.   // `withCredentials` indicates whether or not cross-site Access-Control requests
67.   // should be made using credentials
68.   withCredentials: false, // default
69.  
70.   // `adapter` allows custom handling of requests which makes testing easier.
71.   // Return a promise and supply a valid response (see lib/adapters/README.md).
72.   adapter: function (config) {
73.     /* … */
74.   },
75.  
76.   // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
77.   // This will set an `Authorization` header, overwriting any existing
78.   // `Authorization` custom headers you have set using `headers`.
79.   // Please note that only HTTP Basic auth is configurable through this parameter.
80.   // For Bearer tokens and such, use `Authorization` custom headers instead.
81.   auth: {
82.     username: ‘janedoe’,
83.     password: ‘s00pers3cret’
84.   },
85.  
86.   // `responseType` indicates the type of data that the server will respond with
87.   // options are: ‘arraybuffer’, ‘document’, ‘json’, ‘text’, ‘stream’
88.   //   browser only: ‘blob’
89.   responseType: ‘json’, // default
90.  
91.   // `responseEncoding` indicates encoding to use for decoding responses
92.   // Note: Ignored for `responseType` of ‘stream’ or client-side requests
93.   responseEncoding: ‘utf8’, // default
94.  
95.   // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
96.   xsrfCookieName: ‘XSRF-TOKEN’, // default
97.  
98.   // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
99.   xsrfHeaderName: ‘X-XSRF-TOKEN’, // default
100.  
101.   // `onUploadProgress` allows handling of progress events for uploads
102.   onUploadProgress: function (progressEvent) {
103.     // Do whatever you want with the native progress event
104.   },
105.  
106.   // `onDownloadProgress` allows handling of progress events for downloads
107.   onDownloadProgress: function (progressEvent) {
108.     // Do whatever you want with the native progress event
109.   },
110.  
111.   // `maxContentLength` defines the max size of the http response content in bytes allowed
112.   maxContentLength: 2000,
113.  
114.   // `validateStatus` defines whether to resolve or reject the promise for a given
115.   // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
116.   // or `undefined`), the promise will be resolved; otherwise, the promise will be
117.   // rejected.
118.   validateStatus: function (status) {
119.     return status >= 200 && status < 300; // default
120.   },
121.  
122.   // `maxRedirects` defines the maximum number of redirects to follow in node.js.
123.   // If set to 0, no redirects will be followed.
124.   maxRedirects: 5, // default
125.  
126.   // `socketPath` defines a UNIX Socket to be used in node.js.
127.   // e.g. ‘/var/run/docker.sock’ to send requests to the docker daemon.
128.   // Only either `socketPath` or `proxy` can be specified.
129.   // If both are specified, `socketPath` is used.
130.   socketPath: null, // default
131.  
132.   // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
133.   // and https requests, respectively, in node.js. This allows options to be added like
134.   // `keepAlive` that are not enabled by default.
135.   httpAgent: new http.Agent({ keepAlive: true }),
136.   httpsAgent: new https.Agent({ keepAlive: true }),
137.  
138.   // ‘proxy’ defines the hostname and port of the proxy server.
139.   // You can also define your proxy using the conventional `http_proxy` and
140.   // `https_proxy` environment variables. If you are using environment variables
141.   // for your proxy configuration, you can also define a `no_proxy` environment
142.   // variable as a comma-separated list of domains that should not be proxied.
143.   // Use `false` to disable proxies, ignoring environment variables.
144.   // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
145.   // supplies credentials.
146.   // This will set an `Proxy-Authorization` header, overwriting any existing
147.   // `Proxy-Authorization` custom headers you have set using `headers`.
148.   proxy: {
149.     host: ‘127.0.0.1’,
150.     port: 9000,
151.     auth: {
152.       username: ‘mikeymike’,
153.       password: ‘rapunz3l’
154.     }
155.   },
156.  
157.   // `cancelToken` specifies a cancel token that can be used to cancel the request
158.   // (see Cancellation section below for details)
159.   cancelToken: new CancelToken(function (cancel) {
160.   })
161. }

响应模式

请求的响应包含以下信息。

1. {
2.   // `data` is the response that was provided by the server
3.   data: {},
4.  
5.   // `status` is the HTTP status code from the server response
6.   status: 200,
7.  
8.   // `statusText` is the HTTP status message from the server response
9.   statusText: ‘OK’,
10.  
11.   // `headers` the headers that the server responded with
12.   // All header names are lower cased
13.   headers: {},
14.  
15.   // `config` is the config that was provided to `axios` for the request
16.   config: {},
17.  
18.   // `request` is the request that generated this response
19.   // It is the last ClientRequest instance in node.js (in redirects)
20.   // and an XMLHttpRequest instance in the browser
21.   request: {}
22. }

使用then时，您将收到如下响应：

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

当使用catch或将拒绝回调作为then的第二个参数传递时，响应将通过错误对象提供，如“处理错误”部分所述。

配置默认值

您可以指定将应用于每个请求的配置默认值。

全局axios默认值

1. axios.defaults.baseURL = ‘https://api.example.com’;
2. axios.defaults.headers.common[‘Authorization’] = AUTH_TOKEN;
3. axios.defaults.headers.post[‘Content-Type’] = ‘application/x-www-form-urlencoded’;

自定义实例默认值

1. //创建实例时设置默认配置
2. const instance = axios.create（{
3.   baseURL：“ https://api.example.com”
4. }）;
5.  
6. //创建实例后更改默认值
7. instance.defaults.headers.common [‘Authorization’] = AUTH_TOKEN;

配置优先顺序

Config将以优先顺序合并。顺序是在lib / defaults.js中找到库默认值，然后是实例的defaults属性，最后是请求的config参数。后者将优先于前者。这是一个例子。

1. //使用库提供的配置默认值创建实例
2. //此时，超时配置值为0，这是库的默认值
3. const instance = axios.create（）;
4.  
5. //默认情况下，库的超时超时
6. //现在使用此实例的所有请求将等待2.5秒，然后再超时
7. instance.defaults.timeout = 2500;
8.  
9. //覆盖此请求的超时时间，因为它需要花费很长时间
10. instance.get（‘/ longRequest’，{
11.   timeout：5000
12. }）;

拦截器

您可以先拦截请求或响应，然后再进行捕获或捕获。

1. //添加请求拦截器
2. axios.interceptors.request.use(function (config) {
3.      //在发送请求之前先做点事
4.     return config;
5.   }, function (error) {
6.     //发生请求错误
7.     return Promise.reject(error);
8.   });
9.  
10. //添加响应拦截器
11. axios.interceptors.response.use(function (response) {
12.     //处于2xx范围内的任何状态代码都会导致此函数触发
13.     //对响应数据进行处理
14.     return response;
15.   }, function (error) {
16.     //任何超出2xx范围的状态代码都会触发此函数
17.     //做一些响应错误
18.     return Promise.reject(error);
19. });

如果以后需要删除拦截器，则可以。

1. const myInterceptor = axios.interceptors.request.use（function（）{/*…*/}）;
2. axios.interceptors.request.eject（myInterceptor）;

您可以将拦截器添加到axios的自定义实例中。

1. const instance = axios.create（）;
2. instance.interceptors.request.use（function（）{/*…*/}）;

处理错误

1. axios.get(‘/user/12345’)
2.   .catch(function (error) {
3.     if (error.response) {
4.       //发出了请求，服务器返回了状态码
5.       //不在2xx范围内
6.       console.log(error.response.data);
7.       console.log(error.response.status);
8.       console.log(error.response.headers);
9.     } else if (error.request) {
10.       //已发出请求，但未收到响应
11.       //`error.request`是浏览器中XMLHttpRequest的实例，也是
12.       // node.js中的http.ClientRequest
13.       console.log(error.request);
14.     } else {
15.       //设置触发错误的请求时发生了什么
16.       console.log(‘Error’, error.message);
17.     }
18.     console.log(error.config);
19.   });

使用validateStatus config选项，您可以定义应该引发错误的HTTP代码。

1. axios.get(‘/user/12345’, {
2.   validateStatus: function (status) {
3.     return status < 500; //仅在状态码大于或等于500时拒绝
4.   }
5. })

使用toJSON，您将获得一个对象，其中包含有关HTTP错误的更多信息。

1. axios.get(‘/user/12345’)
2.   .catch(function (error) {
3.     console.log(error.toJSON());
4. });

Cancellation

您可以使用cancel token取消请求。

axios取消tokenAPI基于撤回的可取消承诺提议。

您可以使用CancelToken.source工厂创建一个cancel  token，如下所示：

1. const CancelToken = axios.CancelToken;
2. const source = CancelToken.source();
3.  
4. axios.get(‘/user/12345’, {
5.   cancelToken: source.token
6. }).catch(function (thrown) {
7.   if (axios.isCancel(thrown)) {
8.     console.log(‘Request canceled’, thrown.message);
9.   } else {
10.     // handle error
11.   }
12. });
13.  
14. axios.post(‘/user/12345’, {
15.   name: ‘new name’
16. }, {
17.   cancelToken: source.token
18. })
19.  
20. //取消请求（message参数是可选的）
21. source.cancel(‘Operation canceled by the user.’);

您还可以通过将执行程序函数传递给CancelToken构造函数来创建cancel token：

1. const CancelToken = axios.CancelToken;
2. let cancel;
3.  
4. axios.get(‘/user/12345’, {
5.   cancelToken: new CancelToken(function executor(c) {
6.     // An executor function receives a cancel function as a parameter
7.     cancel = c;
8.   })
9. });
10.  
11. // cancel the request
12. cancel();

注意：您可以使用相同的cancel token取消多个请求。

使用application / x-www-form-urlencoded格式

默认情况下，axios将JavaScript对象序列化为JSON。要改为以application / x-www-form-urlencoded格式发送数据，可以使用以下选项之一。

浏览器

在浏览器中，可以如下使用URLSearchParams API：

1. const params = new URLSearchParams();
2. params.append(‘param1’, ‘value1’);
3. params.append(‘param2’, ‘value2’);
4. axios.post(‘/foo’, params);

请注意，并非所有浏览器都支持URLSearchParams（请参见caniuse.com），但是有可用的polyfill（确保对全局环境进行polyfill）。

另外，您可以使用qs库对数据进行编码：

1. const qs = require（‘qs’）;
2. axios.post（‘/ foo’，qs.stringify（{‘bar’：123}））;

或以另一种方式（ES6），

1. import qs from ‘qs’;
2. const data = { ‘bar’: 123 };
3. const options = {
4.   method: ‘POST’,
5.   headers: { ‘content-type’: ‘application/x-www-form-urlencoded’ },
6.   data: qs.stringify(data),
7.   url,
8. };
9. axios(options);

Node.js

在node.js中，可以按以下方式使用querystring模块：

1. const querystring = require（‘querystring’）;
2. axios.post（‘http://something.com/’，querystring.stringify（{foo：‘bar’}）））;

您也可以使用qs库。

注意: 如果需要对嵌套对象进行字符串化处理，则最好使用qs库，因为querystring方法存在该用例的已知问题（https://github.com/nodejs/node-v0.x-archive/issues/1665）。

Promises

axios取决于要支持的本机ES6 Promise实现。如果您的环境不支持ES6 Promises，则可以进行polyfill。

TypeScript

axios包括TypeScript定义。

1. import axios from ‘axios’;
2. axios.get(‘/user?ID=12345’);