axios 官网速通

前言：参考 AXIOS 中文文档
一 起步

1. 介绍

1.1 Axios 是什么？

   Axios 是一个基于 promise 网络哀求库，作用于 node.js 和欣赏器中。在服务端使用 node.js 的 http 模块, 在客户端 (欣赏端) 使用 XMLHttpRequests。
  1.2 安装

1. $ npm install axios
2. # or
3. $ yarn add axios
4. # or
5. $ pnpm add axios

复制代码

2. 用例

2.1 发起 GET 哀求

1. const axios = require("axios");
3. // 向给定ID的用户发起请求
4. axios
5.   .get("/user?ID=12345")
6.   .then(function (response) {
7.     // 处理成功情况
8.     console.log(response);
9.   })
10.   .catch(function (error) {
11.     // 处理错误情况
12.     console.log(error);
13.   })
14.   .finally(function () {
15.     // 总是会执行
16.   });
18. // 上述请求等同于如下
19. axios
20.   .get("/user", {
21.     params: {
22.       ID: 12345,
23.     },
24.   })
25.   .then(function (response) {
26.     console.log(response);
27.   })
28.   .catch(function (error) {
29.     console.log(error);
30.   })
31.   .finally(function () {
32.     // 总是会执行
33.   });
35. // 支持async/await用法
36. async function getUser() {
37.   try {
38.     const response = await axios.get("/user?ID=12345");
39.     console.log(response);
40.   } catch (error) {
41.     console.error(error);
42.   }
43. }

复制代码

2.2 发起 POST 哀求

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

复制代码

2.3 发起多个并发哀求

1. function getUserAccount() {
2.   return axios.get("/user/12345");
3. }
5. function getUserPermissions() {
6.   return axios.get("/user/12345/permissions");
7. }
9. const [acct, perm] = await Promise.all([
10.   getUserAccount(),
11.   getUserPermissions(),
12. ]);
14. // OR
16. Promise.all([getUserAccount(), getUserPermissions()]).then(function ([
17.   acct,
18.   perm,
19. ]) {
20.   // ...
21. });

复制代码

2.4 将 HTML Form 转换成 JSON 进行哀求

1. const { data } = await axios.post("/user", document.querySelector("#my-form"), {
2.   headers: {
3.     "Content-Type": "application/json",
4.   },
5. });

复制代码

3. Forms

3.1 Multipart (multipart/form-data)

1. const { data } = await axios.post(
2.   "https://httpbin.org/post",
3.   {
4.     firstName: "Fred",
5.     lastName: "Flintstone",
6.     orders: [1, 2, 3],
7.     photo: document.querySelector("#fileInput").files,
8.   },
9.   {
10.     headers: {
11.       "Content-Type": "multipart/form-data",
12.     },
13.   }
14. );

复制代码

3.2 URL encoded form (application/x-www-form-urlencoded)

1. const { data } = await axios.post(
2.   "https://httpbin.org/post",
3.   {
4.     firstName: "Fred",
5.     lastName: "Flintstone",
6.     orders: [1, 2, 3],
7.   },
8.   {
9.     headers: {
10.       "Content-Type": "application/x-www-form-urlencoded",
11.     },
12.   }
13. );

复制代码

二 Axios API

1. Axios API

可以向 axios 通报相干配置来创建哀求，axios(config)：

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

复制代码

axios(url[, config])：

1. // 发起一个 GET 请求 (默认请求方式)
2. axios("/user/12345");

复制代码

1.1 哀求方式别名

   为了方便起见，已经为所有支持的哀求方法提供了别名：
  
  
  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]])
  axios.postForm(url[, data[, config]])
  axios.putForm(url[, data[, config]])
  axios.patchForm(url[, data[, config]])
  
  tips：在使用别名方法时，url、method、data 这些属性都不必在配置中指定。
  2. 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. });

复制代码

3. 哀求配置

配置选项中只有 url 是必需，method 默认使用 GET 方法：

1. {
2.   // `url` 是用于请求的服务器 URL
3.   url: '/user',
5.   // `method` 是创建请求时使用的方法
6.   method: 'get', // 默认值
8.   // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
9.   // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
10.   baseURL: 'https://some-domain.com/api/',
12.   // `transformRequest` 允许在向服务器发送前，修改请求数据
13.   // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
14.   // 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream
15.   // 你可以修改请求头。
16.   transformRequest: [function (data, headers) {
17.     // 对发送的 data 进行任意转换处理
19.     return data;
20.   }],
22.   // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
23.   transformResponse: [function (data) {
24.     // 对接收的 data 进行任意转换处理
26.     return data;
27.   }],
29.   // 自定义请求头
30.   headers: {'X-Requested-With': 'XMLHttpRequest'},
32.   // `params` 是与请求一起发送的 URL 参数
33.   // 必须是一个简单对象或 URLSearchParams 对象
34.   params: {
35.     ID: 12345
36.   },
38.   // `paramsSerializer`是可选方法，主要用于序列化`params`
39.   // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
40.   paramsSerializer: function (params) {
41.     return Qs.stringify(params, {arrayFormat: 'brackets'})
42.   },
44.   // `data` 是作为请求体被发送的数据
45.   // 仅适用 'PUT', 'POST', 'DELETE 和 'PATCH' 请求方法
46.   // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
47.   // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
48.   // - 浏览器专属: FormData, File, Blob
49.   // - Node 专属: Stream, Buffer
50.   data: {
51.     firstName: 'Fred'
52.   },
54.   // 发送请求体数据的可选语法
55.   // 请求方式 post
56.   // 只有 value 会被发送，key 则不会
57.   data: 'Country=Brasil&City=Belo Horizonte',
59.   // `timeout` 指定请求超时的毫秒数。
60.   // 如果请求时间超过 `timeout` 的值，则请求会被中断
61.   timeout: 1000, // 默认值是 `0` (永不超时)
63.   // `withCredentials` 表示跨域请求时是否需要使用凭证
64.   withCredentials: false, // default
66.   // `adapter` 允许自定义处理请求，这使测试更加容易。
67.   // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
68.   adapter: function (config) {
69.     /* ... */
70.   },
72.   // `auth` HTTP Basic Auth
73.   auth: {
74.     username: 'janedoe',
75.     password: 's00pers3cret'
76.   },
78.   // `responseType` 表示浏览器将要响应的数据类型
79.   // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
80.   // 浏览器专属：'blob'
81.   responseType: 'json', // 默认值
83.   // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
84.   // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
85.   // Note: Ignored for `responseType` of 'stream' or client-side requests
86.   responseEncoding: 'utf8', // 默认值
88.   // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
89.   xsrfCookieName: 'XSRF-TOKEN', // 默认值
91.   // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
92.   xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值
94.   // `onUploadProgress` 允许为上传处理进度事件
95.   // 浏览器专属
96.   onUploadProgress: function (progressEvent) {
97.     // 处理原生进度事件
98.   },
100.   // `onDownloadProgress` 允许为下载处理进度事件
101.   // 浏览器专属
102.   onDownloadProgress: function (progressEvent) {
103.     // 处理原生进度事件
104.   },
106.   // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
107.   maxContentLength: 2000,
109.   // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
110.   maxBodyLength: 2000,
112.   // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
113.   // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
114.   // 则promise 将会 resolved，否则是 rejected。
115.   validateStatus: function (status) {
116.     return status >= 200 && status < 300; // 默认值
117.   },
119.   // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
120.   // 如果设置为0，则不会进行重定向
121.   maxRedirects: 5, // 默认值
123.   // `socketPath` 定义了在node.js中使用的UNIX套接字。
124.   // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
125.   // 只能指定 `socketPath` 或 `proxy` 。
126.   // 若都指定，这使用 `socketPath` 。
127.   socketPath: null, // default
129.   // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
130.   // and https requests, respectively, in node.js. This allows options to be added like
131.   // `keepAlive` that are not enabled by default.
132.   httpAgent: new http.Agent({ keepAlive: true }),
133.   httpsAgent: new https.Agent({ keepAlive: true }),
135.   // `proxy` 定义了代理服务器的主机名，端口和协议。
136.   // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
137.   // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
138.   // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
139.   // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
140.   // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
141.   proxy: {
142.     protocol: 'https',
143.     host: '127.0.0.1',
144.     port: 9000,
145.     auth: {
146.       username: 'mikeymike',
147.       password: 'rapunz3l'
148.     }
149.   },
151.   // see https://axios-http.com/zh/docs/cancellation
152.   cancelToken: new CancelToken(function (cancel) {
153.   }),
155.   // `decompress` indicates whether or not the response body should be decompressed
156.   // automatically. If set to `true` will also remove the 'content-encoding' header
157.   // from the responses objects of all decompressed responses
158.   // - Node only (XHR cannot turn off decompression)
159.   decompress: true // 默认值
161. }

复制代码

4. 相应结构

哀求的相应包含以下信息：

1. {
2.   // `data` 由服务器提供的响应
3.   data: {},
5.   // `status` 来自服务器响应的 HTTP 状态码
6.   status: 200,
8.   // `statusText` 来自服务器响应的 HTTP 状态信息
9.   statusText: 'OK',
11.   // `headers` 是服务器响应头
12.   // 所有的 header 名称都是小写，而且可以使用方括号语法访问
13.   // 例如: `response.headers['content-type']`
14.   headers: {},
16.   // `config` 是 `axios` 请求的配置信息
17.   config: {},
19.   // `request` 是生成此响应的请求
20.   // 在node.js中它是最后一个ClientRequest实例 (in redirects)，
21.   // 在浏览器中则是 XMLHttpRequest 实例
22.   request: {}
23. }

复制代码

当使用 then 时，将接收如下相应:

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

复制代码

5. 默认配置

   可以指定默认配置，它将作用于每个哀求。
  5.1 全局 axios 默认值

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

复制代码

5.2 自界说实例默认值

1. // 创建实例时配置默认值
2. const instance = axios.create({
3.   baseURL: "https://api.example.com",
4. });
6. // 创建实例后修改默认值
7. instance.defaults.headers.common["Authorization"] = AUTH_TOKEN;

复制代码

5.3 配置的优先级

配置合并次序是：在 lib/defaults.js 中默认值 -> 实例的 defaults 属性 -> 哀求的 config 参数。后者优先级高于前者。如下：

1. // 使用库提供的默认配置创建实例
2. // 此时超时配置的默认值是 `0`
3. const instance = axios.create();
5. // 重写库的超时默认值
6. // 现在，所有使用此实例的请求都将等待2.5秒，然后才会超时
7. instance.defaults.timeout = 2500;
9. // 重写此请求的超时时间，因为该请求需要很长时间
10. instance.get("/longRequest", {
11.   timeout: 5000,
12. });

复制代码

6. 拦截器

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

1. // 添加请求拦截器
2. axios.interceptors.request.use(
3.   function (config) {
4.     // 在发送请求之前做些什么
5.     return config;
6.   },
7.   function (error) {
8.     // 对请求错误做些什么
9.     return Promise.reject(error);
10.   }
11. );
13. // 添加响应拦截器
14. axios.interceptors.response.use(
15.   function (response) {
16.     // 2xx 范围内的状态码都会触发该函数。
17.     // 对响应数据做点什么
18.     return response;
19.   },
20.   function (error) {
21.     // 超出 2xx 范围的状态码都会触发该函数。
22.     // 对响应错误做点什么
23.     return Promise.reject(error);
24.   }
25. );

复制代码

移除拦截器：

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

复制代码

给 axios 实例添加拦截器：

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

复制代码

7. 错误处置惩罚

7.1 基础用法

1. axios.get("/user/12345").catch(function (error) {
2.   if (error.response) {
3.     // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围
4.     console.log(error.response.data);
5.     console.log(error.response.status);
6.     console.log(error.response.headers);
7.   } else if (error.request) {
8.     // 请求已经成功发起，但没有收到响应
9.     // `error.request` 在浏览器中是 XMLHttpRequest 的实例，
10.     // 而在node.js中是 http.ClientRequest 的实例
11.     console.log(error.request);
12.   } else {
13.     // 发送请求时出了点问题
14.     console.log("Error", error.message);
15.   }
16.   console.log(error.config);
17. });

复制代码

7.2 validateStatus

使用 validateStatus 配置选项，可自界说抛出错误的 HTTP code：

1. axios.get("/user/12345", {
2.   validateStatus: function (status) {
3.     return status < 500; // 处理状态码小于500的情况
4.   },
5. });

复制代码

7.3 toJson

使用 toJSON 可以获取更多关于 HTTP 错误的信息：

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

复制代码

8. 取消哀求

8.1 AbortController

从 v0.22.0 开始，Axios 支持以 fetch API 方式—— AbortController 取消哀求：

1. const controller = new AbortController();
3. axios
4.   .get("/foo/bar", {
5.     signal: controller.signal,
6.   })
7.   .then(function (response) {
8.     //...
9.   });
10. // 取消请求
11. controller.abort();

复制代码

8.2 CancelToken deprecated

使用 CancelToken.source 工厂方法创建一个 cancel token ，如下所示：

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

复制代码

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

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

复制代码

9. 哀求体编码

9.1 主动序列化

当哀求头中的 content-type 是 application/x-www-form-urlencoded 时，Axios 将主动地将平凡对象序列化成 urlencoded 的格式：

1. const data = {
2.   x: 1,
3.   arr: [1, 2, 3],
4.   arr2: [1, [2], 3],
5.   users: [
6.     { name: "Peter", surname: "Griffin" },
7.     { name: "Thomas", surname: "Anderson" },
8.   ],
9. };
11. await axios.post("https://postman-echo.com/post", data, {
12.   headers: { "content-type": "application/x-www-form-urlencoded" },
13. });

复制代码

服务器接收到的数据就像是这样：

1.   {
2.     x: '1',
3.     'arr[]': [ '1', '2', '3' ],
4.     'arr2[0]': '1',
5.     'arr2[1][0]': '2',
6.     'arr2[2]': '3',
7.     'arr3[]': [ '1', '2', '3' ],
8.     'users[0][name]': 'Peter',
9.     'users[0][surname]': 'griffin',
10.     'users[1][name]': 'Thomas',
11.     'users[1][surname]': 'Anderson'
12.   }

复制代码

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