详解网络请求Axios

2022-12-22 0 1,088

Axios是甚么?

Axios 是两个如前所述 promise 的 HTTP 库,能用在应用程序和 node.js 中。他们晓得 Promise 是 js 触发器的一类软件系统,它最小的优点是能透过 .then 的形式来展开拉艾初始化。

详解网络请求Axios

只不过说到底axios是对ajax的PCB,axios有的是ajax都有,ajax有的是axios不一定有,归纳一句话是axios是ajax,ajax闻所未闻axios。

为甚么优先选择axios?

vue的译者尤雨溪所推荐采用axios.合乎其间端分立的态势,及后端的MVVM的大潮

机能特征:

在应用程序中推送XMLHttpRequests允诺在node.js中推送http允诺全力支持Promise API截击允诺和积极响应切换允诺和积极响应统计数据中止允诺手动切换 JSON 统计数据应用程序全力支持防卫 XSRF

全力支持多种不同允诺形式:

axios(config)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] ])

Axios的基本上采用

axios的采用十分简单,文件格式讲得也十分明晰,你如果先写作axios的非官方文件格式:axios文件格式。

在html网页中间接导入采用:

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

Html网页基本上采用

<script> const url = https://store.crmeb.net/api/pc/get_category_product axios({ url: url, method: get, // 这里能省略,默认为get }).then(res => { // 返回请求到的统计数据 console.log(res) }).catch(err => { // 返回错误信息 console.log(err) }) </script>在get允诺的url中传参,只需要定义两个params:{}即可!<script> const url = https://store.crmeb.net/api/pc/get_category_product axios({ url: url, method: get, // 这里能省略,默认为get // 这里的键值对会拼接成这样url?page=1&limit=3 params: { page: 1, limit: 3} }).then(res => { // 返回允诺到的统计数据 console.log(res) }).catch(err => { // 返回错误信息 console.log(err) })</script>推送两个post允诺,与get允诺类似,只需要将method改为post,定义两个data:{}即可,data中的统计数据则是服务器需要接收的字段统计数据!<script>axios({method: post, url: /user/12345, data: { firstName: Fred, lastName: Flintstone } }).then(res => { // 返回允诺到的统计数据 console.log(res) }).catch(err => { // 返回错误信息 console.log(err) }); </script>推送两个并发允诺

如果在开发中需要等到多个接口的统计数据同时允诺到后才能继续后边的逻辑,那么即可采用并发允诺,axios并发允诺,采用all方法,all方法的参数为两个数组,数组的每个值能为一次允诺,允诺完成后间接.then即可合并两次允诺的统计数据,返回结果为两个数组!

<script> axios.all([ axios({ url: https://store.crmeb.net/api/pc/get_products, params: { page: 1, limit: 20, cid: 57, sid: 0, priceOrder: , news: 0, } }), axios({ url: https://store.crmeb.net/api/pc/get_company_info, }) ]).then(results => { console.log(results) }) </script>

如果你想手动把这个数组展开的话在then()方法中传入axios.spread()方法即可,如下所示:

<script> axios.all([ axios({ url: https://store.crmeb.net/api/pc/get_products, params: { page: 1, limit: 20, cid: 57, sid: 0, priceOrder: , news: 0, } }), axios({ url: https://store.crmeb.net/api/pc/get_company_info, }) ]).then(axios.spread((res1, res2) => { console.log(res1); console.log(res2); })) </script>

但在采用vue组件化开发的时候一般他们会透过npm安装,导入项目!

组件化开发中采用

采用npm展开安装npm install axios –save

一般在实际项目中他们并不会像上边这样间接去采用axios允诺统计数据,而是将axiosPCB在两个单独的文件,这样做的目的主要是用来抽取公共逻辑到两个配置文件里,对这些公共逻辑做两个PCB,即使某一天这个axios框架不维护了,或者出现了重大bug也不再修复的时候,他们能只修改配置文件即可达到全局修改的目的,如果把每次允诺逻辑都写到对应的组件中,那修改起来简直是两个噩梦!

PCB两个axios的允诺文件request.js

在项目的src目录下创建两个network文件夹,再在其中创建两个request.js文件,路径为:src/network/request.js

// src/network/request.js // 导入axios import axios from axios // 这里未采用default导出,是为了以后的扩展,便于导出多个方法 export function request(config){ // 创建axios实例 constinstance = axios.create({// 这里定义每次允诺的公共统计数据,例如全局允诺头,api根地址,过期时间等 // 具体参数可参考axios的非官方文件格式 baseURL: http://demo26.crmeb.net/api, timeout: 5000 }) instance.interceptors.request.use( config => { console.log(config);return config; }, err => { console.log(err); }) // 截击积极响应instance.interceptors.response.use(res => { console.log(res) return res.data }, err => { console.log(err) } ) // 推送允诺 returninstance(config)采用他们PCB的request允诺

一般他们会将所有的是允诺放在两个api.js文件中,将每次允诺PCB为两个方法,比如我这里会在request.js的同目录创建两个api.js文件PCB他们所有的是允诺。

import { request } from ../api/request export const getHomeCategory = () => { return request({ url: /category }) } export const getHomeBanner = () => { return request({ url: /pc/get_banner}) }

之后再在组件中导入初始化导出的相关接口方法即可,如:

import { getHomeBanner } from “../network/api” getHomeBanner().then(res => { console.log(res) })

以上是两个简单的PCB,其中有个截击允诺和截击积极响应,可能很多初学的人理解起来有点吃力,我在这里以个人浅见阐述,希望能带给你些许启发!

何为截击器?

还是发挥写作理解能力,截击截击只不过是此路是我开,此树是我栽,要想过此路,留下买路钱,截击允诺是比如某些允诺需要携带一些额外的信息才能访问,实际项目中最常见的是需要登录后才能查看的信息,允诺中就必须携带token才能访问,就能在这里处理,还有截击积极响应,比如允诺到统计数据之后,发现不合乎要求,先拦下来处理一下,再返回给后端,这是两个截击器的基本上工作流程!

axios有两个全局截击的形式:axios.interceptors()截击成功后必须return返回,否则统计数据无法允诺到

如下所示:

instance.interceptors.request.use( config => { console.log(config); return config; }, err => { console.log(err); }) // 截击积极响应instance.interceptors.response.use(res => { console.log(res) return res.data }, err => { console.log(err) } )

axios还为他们提供了一些全局配置,如下:

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

当然也能将其配置在他们之前创建的axios实例中,使其只作用于某个实例!

然后来看一下 axios 的所有配置信息:

统计数据来自axios中文文件格式

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

详解网络请求Axios
上一篇: go|闭包

相关文章

发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务