AxiosPromise的HTTP库使用详细介绍

点击右上方红色按钮关注“web秀”,让你真正秀起来

Axios是什么?

Axios 是一个基于 promise 的 HTTP 库,简单的讲就是可以发送get、post请求。说到get、post,大家应该第一时间想到的就是Jquery吧,毕竟前几年Jquery比较火的时候,大家都在用他。但是由于Vue、React等框架的出现,Jquery也不是那么吃香了。也正是Vue、React等框架的出现,促使了Axios轻量级库的出现,因为Vue等,不需要操作Dom,所以不需要引入Jquery.js了。

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=""></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: // `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. 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` 或 ``),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: 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低版本以外,最新版的浏览器都是支持的。

喜欢小编或者觉得小编文章对你有帮助的,可以点击一波关注哦!