APP下载

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

消息来源:baojiabao.com 作者: 发布时间:2026-05-15

报价宝综合消息Axios是什么?用在什么场景?如何使用?

点选右上方红色按钮关注“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

或者直接引入

引入模组后可以直接使用

示例(一)

// 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 },

// `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低版本以外,最新版的浏览器都是支援的。

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

2020-01-17 10:51:00

相关文章