目录
目录
前言
官方文档 起步 | Axios 中文文档 | Axios 中文网 (axios-http.cn)
我写的关于XMLHttpRequest博客前端-HTML5-XMLHttpRequest - 知乎 (zhihu.com)
Axios 是什么?
Axios 是一个基于promise网络请求库，作用于node.js和浏览器中。在服务端它使用原生 node.js http 模块, 而在客户端 (浏览端) 则使用 XMLHttpRequests。
特性
从浏览器创建 XMLHttpRequests从 node.js 创建 http 请求支持 Promise API拦截请求和响应转换请求和响应数据取消请求自动转换JSON数据客户端支持防御XSRF安装
<!--使用 npm--> npm install axios <!--使用 yarn--> yarn add axios <!--使用 CDN--> <script src=""></script>Axios基本案例
以get和post为例子
<script> // axios发送get、post的几种形式 有参和无参 // 第1种axios的 默认请求(get) axios({ url: :999/setting/page, }).then(res => { console.log(res); }) // 第2种axios的 get请求无参数 axios({ url: :999/setting/page, method: get, }).then(res => { console.log(res); }) // 第3种axios的 get请求有参数 axios({ url: :999/setting/page, method: get, params:{ id: 1, name: xxx, } }).then(res => { console.log(res); }) // 第4种axios的 post请求无参数 axios({ url: :999/setting/page, method: post, }).then(res => { console.log(res); }) // 第5种axios的 post请求有参数 axios({ url: :999/setting/page, method: post, params: {//application/json name: 1, }, }).then(res => { console.log(res); }) axios({ url: :999/setting/page, method: post, data: { name: 1, }, }).then(res => { console.log(res); }) </script>Axios请求方式
以get和post为例子
<script> // 第1种axios的 get请求无参数 axios.get(:999/setting/page).then(res => { console.log(res); }).catch(err => { console.log(err) }); // 第2种axios的 get请求有参数 axios.get(:999/setting/page,{params: {id: 1,name: xxx,}}).then(res => { console.log(res); }) // 第3种axios的 post请求无参数 axios.post(:999/setting/page).then(res => { console.log(res); }) // 第4种axios的 post请求有参数 axios.post(:999/setting/page,"title=dnmd&size=10").then(res => { console.log(res); }) // 第4种axios的 post请求有参数 data格式 axios.post(:999/setting/page,{title:"dnmd",size:10}).then(res => { console.log(res); }) </script>请求方式别名
为了方便起见，已经为所有支持的请求方法提供了别名。
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]])注意
在使用别名方法时， url、method、data 这些属性都不必在配置中指定。
Axios并发请求
<!-- axios并发请求 --> <script> //axios并发请求 axios.all([ axios.get(:999/setting/page), axios.get(:999/setting/page) ]).then(res => { console.log(res[0]); console.log(res[1]); }).catch(err => { console.log(err) }); //axios使用spread方法处理响应数组结果 axios.all([ axios.get(:999/setting/page), axios.get(:999/setting/page) ]).then( axios.spread((res1,res2)=>{ console.log(res1) console.log(res2) }) ).catch(err => { console.log(err) }); //使用 Promise.all 发送(官方) function getUserAccount() { return axios.get(/user/12345); } function getUserPermissions() { return axios.get(/user/12345/permissions); } Promise.all([getUserAccount(), getUserPermissions()]) .then(function (results) { const acct = results[0]; const perm = results[1]; }).catch(err => { console.log(err); }) </script>Axios全局默认配置
您可以指定默认配置，它将作用于每个请求
// 全局 axios 默认值 axios.defaults.baseURL = :9999/;//默认路径 axios.defaults.timeout = 5000; //请求时长,超时失败 axios.defaults.headers.common[Authorization] = AUTH_TOKEN;//全局token axios.defaults.headers.post[Content-Type] = application/x-www-form-urlencoded; //post的类型 // get请求无参数的例子 axios.get(setting/page).then(res => { console.log(res); }).catch(err => { console.log(err) }); // 配置的优先级 // 使用库提供的默认配置创建实例 // 此时超时配置的默认值是 `0` const instance = axios.create(); // 重写库的超时默认值 现在，所有使用此实例的请求都将等待2.5秒，然后才会超时 instance.defaults.timeout = 2500; // 重写此请求的超时时间，因为该请求需要很长时间 以这里为准 instance.get(/longRequest, { timeout: 5000 });Axios实例
可以使用自定义配置新建一个实例。axios.create([config])
const instance = axios.create(); instance.get({ baseURL: https://some-domain.com/api/, timeout: 1000, headers: {X-Custom-Header: foobar} }) instance({ method:"get", baseURL: https://some-domain.com/api/, timeout: 1000, headers: {X-Custom-Header: foobar} })Axios响应结构
一个请求的响应包含以下信息。
{ // `data` 由服务器提供的响应 data: {}, // `status` 来自服务器响应的 HTTP 状态码 status: 200, // `statusText` 来自服务器响应的 HTTP 状态信息 statusText: OK, // `headers` 是服务器响应头 // 所有的 header 名称都是小写，而且可以使用方括号语法访问 // 例如: `response.headers[content-type]` headers: {}, // `config` 是 `axios` 请求的配置信息 config: {}, // `request` 是生成此响应的请求 // 在node.js中它是最后一个ClientRequest实例 (in redirects)， // 在浏览器中则是 XMLHttpRequest 实例 request: {} }当使用 then 时，您将接收如下响应:
axios.get(/user/12345) .then(function (response) { console.log(response.data); console.log(response.status); console.log(response.statusText); console.log(response.headers); console.log(response.config); }).catch(err=>{ console.log(err) }Axios拦截器
在请求或响应被 then 或 catch 处理前拦截它们。
// 添加请求拦截器 axios.interceptors.request.use(function (config) { // 在发送请求之前做些什么 return config; }, function (error) { // 对请求错误做些什么 return Promise.reject(error); }); // 添加响应拦截器 axios.interceptors.response.use(function (response) { // 2xx 范围内的状态码都会触发该函数。 // 对响应数据做点什么 return response; }, function (error) { // 超出 2xx 范围的状态码都会触发该函数。 // 对响应错误做点什么 return Promise.reject(error); });如果你稍后需要移除拦截器，可以这样：
const myInterceptor = axios.interceptors.request.use(function () {/*...*/}); axios.interceptors.request.eject(myInterceptor);可以给自定义的 axios 实例添加拦截器。
const instance = axios.create(); instance.interceptors.request.use(function () {/*...*/});Axios错误处理
axios.get(/user/12345) .catch(function (error) { if (error.response) { // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围 console.log(error.response.data); console.log(error.response.status); console.log(error.response.headers); } else if (error.request) { // 请求已经成功发起，但没有收到响应 // `error.request` 在浏览器中是 XMLHttpRequest 的实例， // 而在node.js中是 http.ClientRequest 的实例 console.log(error.request); } else { // 发送请求时出了点问题 console.log(Error, error.message); } console.log(error.config); });使用validateStatus配置选项，可以自定义抛出错误的 HTTP code。
axios.get(/user/12345, { validateStatus: function (status) { return status < 500; // 处理状态码小于500的情况 } })使用toJSON可以获取更多关于HTTP错误的信息。
axios.get(/user/12345) .catch(function (error) { console.log(error.toJSON()); });Axios请求配置
这些是创建请求时可以用的配置选项。只有url是必需的。
{ // `url` 是用于请求的服务器 URL url: /user, // `method` 是创建请求时使用的方法 method: get, // 默认值 // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。 // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL baseURL: https://some-domain.com/api/, // `transformRequest` 允许在向服务器发送前，修改请求数据 // 它只能用于 PUT, POST 和 PATCH 这几个请求方法 // 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream // 你可以修改请求头。 transformRequest: [function (data, headers) { // 对发送的 data 进行任意转换处理 return data; }], // `transformResponse` 在传递给 then/catch 前，允许修改响应数据 transformResponse: [function (data) { // 对接收的 data 进行任意转换处理 return data; }], // 自定义请求头 headers: {X-Requested-With: XMLHttpRequest}, // `params` 是与请求一起发送的 URL 参数 // 必须是一个简单对象或 URLSearchParams 对象 params: { ID: 12345 }, // `paramsSerializer`是可选方法，主要用于序列化`params` // (e.g. paramsSerializer: function (params) { return Qs.stringify(params, {arrayFormat: brackets}) }, // `data` 是作为请求体被发送的数据 // 仅适用 PUT, POST, DELETE 和 PATCH 请求方法 // 在没有设置 `transformRequest` 时，则必须是以下类型之一: // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams // - 浏览器专属: FormData, File, Blob // - Node 专属: Stream, Buffer data: { firstName: Fred }, // 发送请求体数据的可选语法 // 请求方式 post // 只有 value 会被发送，key 则不会 data: Country=Brasil&City=Belo Horizonte, // `timeout` 指定请求超时的毫秒数。 // 如果请求时间超过 `timeout` 的值，则请求会被中断 timeout: 1000, // 默认值是 `0` (永不超时) // `withCredentials` 表示跨域请求时是否需要使用凭证 withCredentials: false, // default // `adapter` 允许自定义处理请求，这使测试更加容易。 // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。 adapter: function (config) { /* ... */ }, // `auth` HTTP Basic Auth auth: { username: janedoe, password: s00pers3cret }, // `responseType` 表示浏览器将要响应的数据类型 // 选项包括: arraybuffer, document, json, text, stream // 浏览器专属：blob responseType: json, // 默认值 // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属) // 注意：忽略 `responseType` 的值为 stream，或者是客户端请求 // Note: Ignored for `responseType` of stream or client-side requests responseEncoding: utf8, // 默认值 // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称 xsrfCookieName: XSRF-TOKEN, // 默认值 // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称 xsrfHeaderName: X-XSRF-TOKEN, // 默认值 // `onUploadProgress` 允许为上传处理进度事件 // 浏览器专属 onUploadProgress: function (progressEvent) { // 处理原生进度事件 }, // `onDownloadProgress` 允许为下载处理进度事件 // 浏览器专属 onDownloadProgress: function (progressEvent) { // 处理原生进度事件 }, // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数 maxContentLength: 2000, // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数 maxBodyLength: 2000, // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。 // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 ``)， // 则promise 将会 resolved，否则是 rejected。 validateStatus: function (status) { return status >= 200 && status < 300; // 默认值 }, // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。 // 如果设置为0，则不会进行重定向 maxRedirects: 5, // 默认值 // `socketPath` 定义了在node.js中使用的UNIX套接字。 // e.g. /var/run/docker.sock 发送请求到 docker 守护进程。 // 只能指定 `socketPath` 或 `proxy` 。 // 若都指定，这使用 `socketPath` 。 socketPath: null, // default // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http // and https requests, respectively, in node.js. This allows options to be added like // `keepAlive` that are not enabled by default. httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // `proxy` 定义了代理服务器的主机名，端口和协议。 // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。 // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。 // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。 // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。 // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https` proxy: { protocol: https, host: 127.0.0.1, port: 9000, auth: { username: mikeymike, password: rapunz3l } }, // see cancelToken: new CancelToken(function (cancel) { }), // `decompress` indicates whether or not the response body should be decompressed // automatically. If set to `true` will also remove the content-encoding header // from the responses objects of all decompressed responses // - Node only (XHR cannot turn off decompression) decompress: true // 默认值 }Vue项目中封装Axios模块
案例一
axios.js-模块封装文件
import axios from axios import { baseUrl } from @/config/env axios.defaults.baseURL = baseUrl; axios.defaults.timeout = // 返回其他状态吗 axios.defaults.validateStatus = function(status) { return status >= 200 && status <= 500 // 默认的 } // 跨域请求，允许保存cookie axios.defaults.withCredentials = true // HTTPrequest拦截 axios.interceptors.request.use(config => { const isToken = (config.headers || {}).isToken === false let token = store.getters.access_token if (token && !isToken) { config.headers[Authorization] = Bearer + token // token } return config }, error => { return Promise.reject(error) }) const excludeResInterception=[ loginQrCodeThird, workwechat/butler/contact/detail, workwechat/butler/speechcraft/preview-private-qrcode, auth/oauth/token ]//不需要错误提示的请求接口数组 // HTTPresponse拦截 axios.interceptors.response.use(res => { NProgress.done() const status = Number(res.status) || 200 const message = res.data.msg || errorCode[status] || errorCode[default] if (status === 401) { store.dispatch(FedLogOut).then(() => { router.push({ path: /login }) }) return } const isExclude = excludeResInterception.some(item=>res.config.url.indexOf(item)!==-1) if (status !== 200 || res.data.code === 1) { if(!isExclude){ Message({ message: message, type: error }) } return Promise.reject(new Error(message)) } return res }, error => { NProgress.done() return Promise.reject(new Error(error)) }) export default axiosrequest.js-api文件
// 删除-参数模板列表 export function deleteTemplateList(query) { return request({ url: /param-template/delete/+query.id, method: post, data: query }) } // 获取-参数模板列表 export function getTemplateList(query) { return request({ url: /param-template/page, method: get, params: query }) }index.vue-使用
import {getTemplateList} form "./request.js" getTemplateList() { let params = { current: 1, size: 100, }; getTemplateList(params).then((res) => { let options = res.data.data.records || []; // do something }).catch(err=>{ console.error(err) }) },案例二
2.1
<!-- 封装位置--> <script> import axios from "axios"; export function request(config = {}, success, fail){ axios(config).then(res => { success(res) }).catch(err => { fail(err) }) } </script> <!-- 调用位置--> <script> import { request } from "./axios.js"; request(config = { url: ":999/setting/page" }, res => { console.log(res); }, err => { console.error(err); }) </script>2.2
<!-- 封装位置--> <script> import axios from "axios"; export function request(config){ axios(config.url).then(res => { config.success(res) }).catch(err => { config.fail(err) }) } </script> <!-- 调用位置--> <script> import { request } from "./axios.js"; request({ url: ":999/setting/page", success: res => { console.log(res); }, fail: err => { console.error(err); } }) </script>2.3
<!-- 第三种封装 --> <!-- 封装位置--> <script> import axios from "axios"; export function request(config){ return new Promise((resolve, reject) => { let newRequest = axios.create({ baseURL: "", timeout: 5000, }) newRequest(config).then((res) => { resolve(res) }).catch(err => { reject(err); }) }) } </script> <!-- 调用位置--> <script> import { request } from "./axios.js"; request({ url: ":999/setting/page" }).then(res => { console.log(res); }).catch(err => { console.log(err) }) </script>2.4(推荐)
<!-- 第四种封装 --> <!-- 封装位置--> <script> import axios from "axios"; export function request(config){ let newRequest = axios.create({ baseURL: "", timeout: 5000, }) return newRequest(config) } </script> <!-- 调用位置--> <script> import { request } from "./axios.js"; request({ url: ":999/setting/page" }).then(res => { console.log(res); }).catch(err => { console.log(err) }) </script>