Axios是什么?用在什么场景?如何使用?

2022-12-16 0 751

Axios是甚么?

Axios 是两个如前所述 promise 的 HTTP 库,单纯的讲是能推送get、post允诺。说到get、post,我们假如第三天数想不到的是Jquery吧,即便前一两年Jquery较为火的这时候,我们都在用他。但虽然Vue、React等架构的再次出现,Jquery也并非因此抢手了。也便是Vue、React等架构的再次出现,使得了Axios轻量库的再次出现,即使Vue等,不须要操作方式Dom,因此不须要导入Jquery.js了。

Axios是什么?用在什么场景?如何使用?

Axios优点

1、能在应用程序中推送 XMLHttpRequests

2、能在 node.js 推送 http 允诺

3、全力支持 Promise API

4、截击允诺和积极响应

5、切换允诺统计数据和积极响应统计数据

6、能中止允诺

7、手动切换 JSON 统计数据

8、应用程序全力支持为保护安全可靠免遭 XSRF 反击

Axios用在甚么情景?

在优点里头早已有提及,应用程序推送允诺,或是Node.js发送允诺都能加进Axios。像Vue、React、Node等工程项目就能采用Axios,假如你的工程项目里头用了Jquery,这时就不须要小题大做了,jquery里头这类就能推送允诺。

Axios怎样采用?

加装组件

npm install axios

或是间接导入

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

导入组件后能直接采用

示例(一)

// GET axios.get(/user, { params: { ID: 12345 } }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); // POST axios.post(/user, { name: Javan, website: www.javanx.cn }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });

上面的参数是可选的

假如你想并发多个允诺,能看下方代码

function getUserAccount() { return axios.get(/user/12345); } function getUserPermissions() { return axios.get(/user/12345/permissions); } axios.all([getUserAccount(), getUserPermissions()]) .then(axios.spread(function (acct, perms) { // 两个允诺都执行完成才会执行 }));

示例(二)

除了上面的方式外,你能通过向 axios 传递相关配置来创建允诺,如:

// POST axios({ method: post, url: /user/12345, data: { firstName: Fred, lastName: Flintstone } });

语法

axios(url[, config])

config

{ // `url` 是用于允诺的服务器 URL url: /user, // `method` 是创建允诺时采用的方法 method: get, // 默认是 get // `baseURL` 将手动加在 `url` 前面,除非 `url` 是两个绝对 URL。 // 它能通过设置两个 `baseURL` 便于为 axios 实例的方法传递相对 URL baseURL: https://some-domain.com/api/, // `transformRequest` 允许在向服务器推送前,修改允诺统计数据 // 只能用在 PUT, POST 和 PATCH 这几个允诺方法 // 后面数组中的函数必须返回两个字符串,或 ArrayBuffer,或 Stream transformRequest: [function (data) { // 对 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, // 默认的 // `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, // 默认的 // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称 xsrfCookieName: XSRF-TOKEN, // default // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称 xsrfHeaderName: X-XSRF-TOKEN, // 默认的 // `onUploadProgress` 允许为上传处理进度事件 onUploadProgress: function (progressEvent) { // 对原生进度事件的处理 }, // `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; // 默认的 }, // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目 // 假如设置为0,将不会 follow 任何重定向 maxRedirects: 5, // 默认的 // `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 实例,并且能在允诺或积极响应被 then 或 catch 处理前截击它们。

// 如文件名叫http.js import axios from axios // 创建实例时设置配置的默认值 var instance = axios.create({ baseURL: https://some-domain.com/api/, timeout: 1000, headers: {X-Custom-Header: foobar} }); // 添加允诺截击器 instance.interceptors.request.use(function (config) { // 在推送允诺之前做些甚么 /** 1、比如添加token之类的允诺头信息 2、添加每次允诺loading等 */ return config; }, function (error) { // 对允诺错误做些甚么 return Promise.reject(error); }); // 添加积极响应截击器 instance.interceptors.response.use(function (response) { // 对积极响应统计数据做点甚么 /** 1、集中处理积极响应统计数据(如错误码处理) */ return response; }, function (error) { // 对积极响应错误做点甚么 return Promise.reject(error); }); export default instance

怎样采用上面的http.js???

import http from xxx/http http({ method: POST, url: /user, data: { name: Javan, website: www.javanx.cn } }).then((response) => { // 200积极响应 }, (err) => { // 500积极响应 })

示例(四)

怎样中止接口???

情景:两个搜索框,每次输入字符都会调用接口,这这时候没有办法来知道那个接口统计数据放回是最后一次的,只能中止之前发起的相同接口,因此就有了中止接口。
var CancelToken = axios.CancelToken; var source = CancelToken.source(); axios.get(/user/12345, { cancelToken: source.token }).catch(function(thrown) { if (axios.isCancel(thrown)) { console.log(Request canceled, thrown.message); } else { // 处理错误 } }); // 中止允诺(message 参数是可选的) source.cancel(Operation canceled by the user.);

总结

Axios能说把允诺这件事做到了极致,封装的很好用,目前下载次数:4,784,599次,github star:60,584次。足矣说明开发者们还是很喜欢他的。应用程序全力支持方法,除了IE低版本以外,最新版的应用程序都是全力支持的。

作者:向建峰_Javan

链接:https://www.imooc.com/article/287900

本文原创发布于慕课网 ,转载请注明出处,谢谢合作

相关文章

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

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