Axios基础学习（未完）

官网：https://www.axios-http.cn/docs/req_config
  学习目录

前言

什么是axios库

Axios 是一个基于promise网络请求库，作用于node.js和浏览器中。 它是 isomorphic的(即同一套代码可以运行在浏览器和node.js中)。

• 在服务端它使用原生 node.js 模块在客户端 (浏览端) 则使用 XMLHttpRequests(ajax) (XMLHttpRequests与ajax的关系https://zhuanlan.zhihu.com/p/163718536#:~:text=XMLHttpReq)
  

特性

• 从浏览器创建XMLHttpRequests
  
• 从node.js创建http请求
  
• 支持Promise API
  
• 拦截请求和响应
  
• 转换请求和响应
  
• 取消请求
  
• 超时处理
  
• 查询参数序列化支持嵌套项处理
  
• 自动将请求体序列化为：
  
  
  
  • JSON（applocation/json）
    
  • Multipart/FormData(multipart/form-data)
    
  • URL encoded form (application/x-www-form-urlencoded)
    
  
  
• 将HTML Form 转化成JSON 举行请求
  
• 自动转化JSON数据
  
• 获取浏览器和node.js的请求进度，并提供额外的信息（速度、剩余时间）
  
• 为node.js设置带宽限制
  
• 兼容符合规范的FormData 和Blob(包括 node.js)
  
• 客户端支持防御XSRF
  

更多案例可见测试代码
一、axios基础应用

1、安装

1. npm i axios
3. # 或者
4. yarn add axios
6. # 或者 cdn
8. <script src="https://unpkg.com/axios/dist/axios.min.js"></script>

复制代码

2、axios的基本用法

axios是基于Promise的网络请求库，以是它的返回结果是个promise对象可以用await/then axios(config)

可以向axios通报相干配置来直接发送请求(axios作为函数来使用)

1. import axios from 'axios';
2. ...
4. await axios({
5.   url: 'http://localhost:3000/posts',
6.   method: 'get',
7. });
8. message.success('请求成功')

复制代码

axios

第一个参数为请求地点，第二个参数默认相干配置（不传第二个参数默认get请求）

1. await axios('http://localhost:3000/posts', {method: 'get', params: {xx: 1}})

复制代码

axios方法请求（别名方法请求）

为了方便起见，已经为所有支持的方法提供了别名 （axios作为对象来使用） 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]])
留意：在使用别名方法时，url、method、data这些属性都不必在配置中指定。
3、axios创建实例对象发送请求

创建的实例和axios本身功能几近一样。一样寻常项目中会选择创建实例对象，举行相应封装后给开发职员使用。

• 统一设置超时时长
  
• 设置请求拦截器（可给某些请求地点统一添加参数、判断token是否失效…）、响应拦截器(统一处理返回报错信息、返回数据处理…)
  

创建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. });
7. instance.get(url, data)// 实例发送各种请求

复制代码

实例方法

以下是可用的实例方法。指定的配置将与实例的配置合并。 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#getUri([config])



4、axios的响应

axios请求成功后的响应数据许多，不像我们平时项目里返回的数据那样做过处理，只返回有效的数据。

5、axios请求配置对象

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. }

复制代码

• config axios配置对象
  

• data 响应体的结果，服务器返回结果。axios自动将服务器返回结果举行json分析。（这里有个问题，axios用的JSON.parse举行的分析，若返回的结果为纯超长的数字分析后可能丢失精度）
  
• headers 响应的头信息
  

• request 原生的ajax请求对象 ，XMLHttpRequests实例对象
  

• status 响应状态码
  
• statusText 响应的状态字符串
  

6、axios 默认配置

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

2. axios.defaults.method='get';
3. axios.defaults.baseURL='http://localhost:3000';
4. axios.defaults.timeout=3000

复制代码

自界说实例默认值
实例的默认配置优于全局的默认配置

1. // 自定义实例默认值
2. const authedAxios=axios.create({
3.   baseURL: 'http://localhost:3000',
4. });
6. authedAxios.defaults.timeout=4000
8. authedAxios.get('/posts/2').then((res)=>{
9.     console.log('----自定义-res', res)
10. })

复制代码

7、拦截器

作用：在请求或响应被then或catch处理前拦截他们，处理请求前的参数、响应返回参数等。 不管是请求拦截，还是响应拦截，拦截了过后都需要返回 否则前台获取不到数据
简单的例子：
请求拦截器

1. axios.intercepters.request.use(function(config){
2.   console.log('请求拦截器------config',config);
3.   return config;
4. }, function(error){
5.   console.log('请求拦截器失败！', error);
6.   return Promise.reject(error)
7. });

复制代码

响应拦截器

1. axios.intercepters.response.use(function(response){
2.   console.log('响应拦截器-------response'， response);
3.   return response;
4. },function(error){
5.   console.log('响应拦截器失败', error);
6.   return Promise.reject(error);
7. })

复制代码

发请求

2. axios.request({
3.     url: '/posts/2',
4.   }).then((res)=>{
5.       console.log('-----request-get请求response', res)
6.   }).catch((re)=>{
7.       console.log('axios请求失败----------', re)
8.   })

复制代码

在业务署理里，我们一样寻常只需要响应的data,可以在响应拦截器处，处理只返回data部分。

多个拦截器

当有多个拦截器， 请求拦截器最反面的先执行（倒序）， 响应拦截器按最开始的先执行，反面的后执行(顺序)；

1. // 添加请求拦截器
2.         axios.interceptors.request.use(function (config) {
3.             // 在发送请求之前做些什么
4.             // 请求拦截器成功
5.             console.log('1请求拦截器-----成功', config)
6.             return config;
8.             // throw '参数出了问题1'
9.         }, function (error) {
10.             // 请求拦截器失败
11.             console.log('1请求拦截器-----失败')
12.             return Promise.reject(error);
13.         });
14.         
15.         axios.interceptors.request.use(function (config) {
16.             // 在发送请求之前做些什么
17.             // 请求拦截器成功
18.             console.log('2请求拦截器-----成功', config)
19.             return config;
21.             // throw '参数出了问题2'
22.         }, function (error) {
23.             // 请求拦截器失败
24.             console.log('2请求拦截器-----失败2')
25.             return Promise.reject(error);
26.         });
28.         axios.interceptors.response.use(function(response){
29.             // 响应拦截器成功
30.             console.log('1响应拦截器-----成功', response);
31.             // return response;
32.             return response.data;
33.         },function (error) {
34.             // 响应拦截器失败
35.             console.log('1响应拦截器失败----')
36.             return Promise.reject(error);
37.         })
39.         axios.interceptors.response.use(function(response){
40.              // 响应拦截器成功
41.              console.log('2响应拦截器-----成功', response);
42.             return response;
43.         },function (error) {
44.             // 响应拦截器失败
45.             console.log('2响应拦截器失败----')
46.             return Promise.reject(error);
47.         })        

复制代码

移除拦截器

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

复制代码

实例创建拦截器

自界说的实例也可以创建拦截器。 涉及业务处理
拦截器处判断tonken

---

8、取消请求

AbortController

从0.22.0版本开始，axios支持以fetch API的方式-AbortController 取消请求

1. const controller = new AbortController();
2. console.log('---------controller', controller)
3. axios.request({
4.   url: '/xxx/xx',
5.   signal: controller.signal
6. }).then((res)=>{
7.   console.log('请求结果', res);
8. })catch((err)=>{
9.   console.log('err', err)
10. })
12. controller.abort();// 终止请求
13. console.log('取消请求后的controller',controller)

复制代码

控制台打印：
创建的controller实例有属性signal

取消后的controller实例

CancelToken (官网如今不推荐)

此 API 从 ` v0.22.0`  开始已被弃用，不应在新项目中使用
方式一：

1. const CancelToken = axios.CancelToken;
2. let cancel;
3. axios.request({
4.   url: '/xxx/xx',
5.   cancelToken: CancelToken(function(cal){
6.     cancel=cal// cal是一个函数
7.     console.log(cal);
8.   }),
9. })
11. cancel();// 取消请求

复制代码

方式二：

1. const CancelToken = axios.CancelToken;
2. const source = CancelToken.source();
4. console.log('source', source)
6. axios.request({
7.   url: '/xxx/xx',
8.   cancelToken: source.token,
9. })
11. source.cancel(); //取消请求
12. console.log('取消后的source', source);

复制代码

控制台打印：

取消后：

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