Vue.js Ajax(axios)

Vue.js 2.0 版本推荐利用 axios 来完成 ajax 请求。
Axios 是一个基于 Promise 的 HTTP 库，可以用在浏览器和 node.js 中。
Github开源所在： https://github.com/axios/axios
安装方法

利用 cdn:

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

复制代码

或

1. <script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>

复制代码

利用 npm:

1. $ npm install axios

复制代码

利用 bower:

1. $ bower install axios

复制代码

利用 yarn:

1. $ yarn add axios

复制代码

GET 方法

我们可以简朴的读取 JSON 数据：
GET 实例

1. new Vue({
2.   el: '#app',
3.   data () {
4.     return {
5.       info: null
6.     }
7.   },
8.   mounted () {
9.     axios
10.       .get('https://www.runoob.com/try/ajax/json_demo.json')
11.       .then(response => (this.info = response))
12.       .catch(function (error) { // 请求失败处理
13.         console.log(error);
14.       });
15.   }
16. })

复制代码

利用 response.data 读取 JSON 数据：
GET 实例

1. <div id="app">
2.   <h1>网站列表</h1>
3.   <div
4.     v-for="site in info"
5.   >
6.     {{ site.name }}
7.   </div>
8. </div>
9. <script type = "text/javascript">
10. new Vue({
11.   el: '#app',
12.   data () {
13.     return {
14.       info: null
15.     }
16.   },
17.   mounted () {
18.     axios
19.       .get('https://www.runoob.com/try/ajax/json_demo.json')
20.       .then(response => (this.info = response.data.sites))
21.       .catch(function (error) { // 请求失败处理
22.         console.log(error);
23.       });
24.   }
25. })
26. </script>

复制代码

GET 方法传递参数格式如下：
传递参数说明

1. // 直接在 URL 上添加参数 ID=12345
2. axios.get('/user?ID=12345')
3.   .then(function (response) {
4.     console.log(response);
5.   })
6.   .catch(function (error) {
7.     console.log(error);
8.   });
10. // 也可以通过 params 设置参数：
11. axios.get('/user', {
12.     params: {
13.       ID: 12345
14.     }
15.   })
16.   .then(function (response) {
17.     console.log(response);
18.   })
19.   .catch(function (error) {
20.     console.log(error);
21.   });

复制代码

POST 方法

POST 实例

1. new Vue({
2.   el: '#app',
3.   data () {
4.     return {
5.       info: null
6.     }
7.   },
8.   mounted () {
9.     axios
10.       .post('https://www.runoob.com/try/ajax/demo_axios_post.php')
11.       .then(response => (this.info = response))
12.       .catch(function (error) { // 请求失败处理
13.         console.log(error);
14.       });
15.   }
16. })

复制代码

POST 方法传递参数格式如下：
传递参数说明

1. axios.post('/user', {
2.     firstName: 'Fred',        // 参数 firstName
3.     lastName: 'Flintstone'    // 参数 lastName
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. }
5. function getUserPermissions() {
6.   return axios.get('/user/12345/permissions');
7. }
8. axios.all([getUserAccount(), getUserPermissions()])
9.   .then(axios.spread(function (acct, perms) {
10.     // 两个请求现在都执行完成
11.   }));

复制代码

axios API

可以通过向 axios 传递相关设置来创建请求。
实例

1. axios(config)
2. // 发送 POST 请求
3. axios({
4.   method: 'post',
5.   url: '/user/12345',
6.   data: {
7.     firstName: 'Fred',
8.     lastName: 'Flintstone'
9.   }
10. });
11. //  GET 请求远程图片
12. axios({
13.   method:'get',
14.   url:'https://static.jyshare.com/images/runoob-logo.png',
15.   responseType:'stream'
16. })
17.   .then(function(response) {
18.   response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
19. });
20. axios(url[, config])
21. // 发送 GET 请求（默认的方法）
22. axios('/user/12345');

复制代码

请求方法的别名

为方便利用，官方为所有支持的请求方法提供了别名，可以直接利用别名来发起请求：

1. axios.request(config)
2. axios.get(url[, config])
3. axios.delete(url[, config])
4. axios.head(url[, config])
5. axios.post(url[, data[, config]])
6. axios.put(url[, data[, config]])
7. axios.patch(url[, data[, config]])

复制代码

注意：在利用别名方法时， url、method、data 这些属性都不必在设置中指定。
并发

处置惩罚并发请求的助手函数：

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

复制代码

创建实例

可以利用自定义设置新建一个 axios 实例：

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

复制代码

实例方法

以下是可用的实例方法。指定的设置将与实例的设置归并：

1. axios#request(config)
2. axios#get(url[, config])
3. axios#delete(url[, config])
4. axios#head(url[, config])
5. axios#post(url[, data[, config]])
6. axios#put(url[, data[, config]])
7. axios#patch(url[, data[, config]])

复制代码

请求设置项

下面是创建请求时可用的设置选项，注意只有 url 是必需的。如果没有指定 method，请求将默认利用 get 方法。

1. {
2.   // `url` 是用于请求的服务器 URL
3.   url: "/user",
5.   // `method` 是创建请求时使用的方法
6.   method: "get", // 默认是 get
8.   // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
9.   // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
10.   baseURL: "https://some-domain.com/api/",
12.   // `transformRequest` 允许在向服务器发送前，修改请求数据
13.   // 只能用在 "PUT", "POST" 和 "PATCH" 这几个请求方法
14.   // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
15.   transformRequest: [function (data) {
16.     // 对 data 进行任意转换处理
18.     return data;
19.   }],
21.   // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
22.   transformResponse: [function (data) {
23.     // 对 data 进行任意转换处理
25.     return data;
26.   }],
28.   // `headers` 是即将被发送的自定义请求头
29.   headers: {"X-Requested-With": "XMLHttpRequest"},
31.   // `params` 是即将与请求一起发送的 URL 参数
32.   // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
33.   params: {
34.     ID: 12345
35.   },
37.   // `paramsSerializer` 是一个负责 `params` 序列化的函数
38.   // (e.g. https://www.npmjs.com/package/qs, https://api.jquery.com/jquery.param/)
39.   paramsSerializer: function(params) {
40.     return Qs.stringify(params, {arrayFormat: "brackets"})
41.   },
43.   // `data` 是作为请求主体被发送的数据
44.   // 只适用于这些请求方法 "PUT", "POST", 和 "PATCH"
45.   // 在没有设置 `transformRequest` 时，必须是以下类型之一：
46.   // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
47.   // - 浏览器专属：FormData, File, Blob
48.   // - Node 专属： Stream
49.   data: {
50.     firstName: "Fred"
51.   },
53.   // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
54.   // 如果请求花费了超过 `timeout` 的时间，请求将被中断
55.   timeout: 1000,
57.   // `withCredentials` 表示跨域请求时是否需要使用凭证
58.   withCredentials: false, // 默认的
60.   // `adapter` 允许自定义处理请求，以使测试更轻松
61.   // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
62.   adapter: function (config) {
63.     /* ... */
64.   },
66.   // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
67.   // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
68.   auth: {
69.     username: "janedoe",
70.     password: "s00pers3cret"
71.   },
73.   // `responseType` 表示服务器响应的数据类型，可以是 "arraybuffer", "blob", "document", "json", "text", "stream"
74.   responseType: "json", // 默认的
76.   // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
77.   xsrfCookieName: "XSRF-TOKEN", // default
79.   // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
80.   xsrfHeaderName: "X-XSRF-TOKEN", // 默认的
82.   // `onUploadProgress` 允许为上传处理进度事件
83.   onUploadProgress: function (progressEvent) {
84.     // 对原生进度事件的处理
85.   },
87.   // `onDownloadProgress` 允许为下载处理进度事件
88.   onDownloadProgress: function (progressEvent) {
89.     // 对原生进度事件的处理
90.   },
92.   // `maxContentLength` 定义允许的响应内容的最大尺寸
93.   maxContentLength: 2000,
95.   // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
96.   validateStatus: function (status) {
97.     return status &gt;= 200 &amp;&amp; status &lt; 300; // 默认的
98.   },
100.   // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
101.   // 如果设置为0，将不会 follow 任何重定向
102.   maxRedirects: 5, // 默认的
104.   // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
105.   // `keepAlive` 默认没有启用
106.   httpAgent: new http.Agent({ keepAlive: true }),
107.   httpsAgent: new https.Agent({ keepAlive: true }),
109.   // "proxy" 定义代理服务器的主机名称和端口
110.   // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
111.   // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
112.   proxy: {
113.     host: "127.0.0.1",
114.     port: 9000,
115.     auth: : {
116.       username: "mikeymike",
117.       password: "rapunz3l"
118.     }
119.   },
121.   // `cancelToken` 指定用于取消请求的 cancel token
122.   // （查看后面的 Cancellation 这节了解更多）
123.   cancelToken: new CancelToken(function (cancel) {
124.   })
125. }

复制代码

相应结构

axios请求的相应包含以下信息：

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

复制代码

利用 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 时，或传递 rejection callback 作为 then 的第二个参数时，相应可以通过 error 对象可被利用。
设置的默认值

你可以指定将被用在各个请求的设置默认值。
全局的 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. var instance = axios.create({
3.   baseURL: 'https://api.example.com'
4. });
6. // 在实例已创建后修改默认值
7. instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

复制代码

设置的优先次序

设置会以一个优先次序举行归并。这个次序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

1. // 使用由库提供的配置的默认值来创建实例
2. // 此时超时配置的默认值是 `0`
3. var instance = axios.create();
5. // 覆写库的超时默认值
6. // 现在，在超时前，所有请求都会等待 2.5 秒
7. instance.defaults.timeout = 2500;
9. // 为已知需要花费很长时间的请求覆写超时设置
10. instance.get('/longRequest', {
11.   timeout: 5000
12. });

复制代码

拦截器

在请求或相应被 then 或 catch 处置惩罚前拦截它们。

1. // 添加请求拦截器
2. axios.interceptors.request.use(function (config) {
3.     // 在发送请求之前做些什么
4.     return config;
5.   }, function (error) {
6.     // 对请求错误做些什么
7.     return Promise.reject(error);
8.   });
10. // 添加响应拦截器
11. axios.interceptors.response.use(function (response) {
12.     // 对响应数据做点什么
13.     return response;
14.   }, function (error) {
15.     // 对响应错误做点什么
16.     return Promise.reject(error);
17.   });

复制代码

如果你想在稍后移除拦截器，可以这样：

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

复制代码

可以为自定义 axios 实例添加拦截器。

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

复制代码

错误处置惩罚：

1. axios.get('/user/12345')
2.   .catch(function (error) {
3.     if (error.response) {
4.       // 请求已发出，但服务器响应的状态码不在 2xx 范围内
5.       console.log(error.response.data);
6.       console.log(error.response.status);
7.       console.log(error.response.headers);
8.     } else {
9.       // Something happened in setting up the request that triggered an Error
10.       console.log('Error', error.message);
11.     }
12.     console.log(error.config);
13.   });

复制代码

可以利用 validateStatus 设置选项定义一个自定义 HTTP 状态码的错误范围。

1. axios.get('/user/12345', {
2.   validateStatus: function (status) {
3.     return status < 500; // 状态码在大于或等于500时才会 reject
4.   }
5. })

复制代码

取消

利用 cancel token 取消请求。
Axios 的 cancel token API 基于cancelable promises proposal
可以利用 CancelToken.source 工厂方法创建 cancel token，像这样：

1. var CancelToken = axios.CancelToken;
2. var source = CancelToken.source();
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.     // 处理错误
11.   }
12. });
14. // 取消请求（message 参数是可选的）
15. source.cancel('Operation canceled by the user.');

复制代码

还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token：

1. var CancelToken = axios.CancelToken;
2. var cancel;
4. axios.get('/user/12345', {
5.   cancelToken: new CancelToken(function executor(c) {
6.     // executor 函数接收一个 cancel 函数作为参数
7.     cancel = c;
8.   })
9. });
11. // 取消请求
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 不是所有的浏览器均支持。
除此之外，你可以利用 qs 库来编码数据:

1. const qs = require('qs');
2. axios.post('/foo', qs.stringify({ 'bar': 123 }));
4. // Or in another way (ES6),
6. import qs from 'qs';
7. const data = { 'bar': 123 };
8. const options = {
9.   method: 'POST',
10.   headers: { 'content-type': 'application/x-www-form-urlencoded' },
11.   data: qs.stringify(data),
12.   url,
13. };
14. axios(options);

复制代码

Node.js 环境

在 node.js里, 可以利用 querystring 模块:

1. const querystring = require('querystring');
2. axios.post('https://www.runoob.com/', querystring.stringify({ foo: 'bar' }));

复制代码

当然，同浏览器一样，你还可以利用 qs 库。
Promises

axios 依靠原生的 ES6 Promise 实现而被支持。
如果你的环境不支持 ES6 Promise，你可以利用 polyfill。
TypeScript支持

axios 包含 TypeScript 的定义。

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

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。