永康网站优化,网店代运营公司,为什么做网站要用谷歌浏览器,个人信息网站模板前言#xff1a;参考 AXIOS 中文文档
一 起步
1. 介绍
1.1 Axios 是什么#xff1f; Axios 是一个基于 promise 网络请求库#xff0c;作用于 node.js 和浏览器中。在服务端使用 node.js 的 http 模块, 在客户端 (浏览端) 使用 XMLHttpRequests。 1.2 安装
$ npm instal…前言参考 AXIOS 中文文档
一 起步
1. 介绍
1.1 Axios 是什么 Axios 是一个基于 promise 网络请求库作用于 node.js 和浏览器中。在服务端使用 node.js 的 http 模块, 在客户端 (浏览端) 使用 XMLHttpRequests。 1.2 安装
$ npm install axios
# or
$ yarn add axios
# or
$ pnpm add axios
2. 用例
2.1 发起 GET 请求
const axios require(axios);// 向给定ID的用户发起请求
axios.get(/user?ID12345).then(function (response) {// 处理成功情况console.log(response);}).catch(function (error) {// 处理错误情况console.log(error);}).finally(function () {// 总是会执行});// 上述请求等同于如下
axios.get(/user, {params: {ID: 12345,},}).then(function (response) {console.log(response);}).catch(function (error) {console.log(error);}).finally(function () {// 总是会执行});// 支持async/await用法
async function getUser() {try {const response await axios.get(/user?ID12345);console.log(response);} catch (error) {console.error(error);}
}
2.2 发起 POST 请求
axios.post(/user, {firstName: Fred,lastName: Flintstone,}).then(function (response) {console.log(response);}).catch(function (error) {console.log(error);});
2.3 发起多个并发请求
function getUserAccount() {return axios.get(/user/12345);
}function getUserPermissions() {return axios.get(/user/12345/permissions);
}const [acct, perm] await Promise.all([getUserAccount(),getUserPermissions(),
]);// ORPromise.all([getUserAccount(), getUserPermissions()]).then(function ([acct,perm,
]) {// ...
});
2.4 将 HTML Form 转换成 JSON 进行请求
const { data } await axios.post(/user, document.querySelector(#my-form), {headers: {Content-Type: application/json,},
});
3. Forms
3.1 Multipart (multipart/form-data)
const { data } await axios.post(https://httpbin.org/post,{firstName: Fred,lastName: Flintstone,orders: [1, 2, 3],photo: document.querySelector(#fileInput).files,},{headers: {Content-Type: multipart/form-data,},}
);
3.2 URL encoded form (application/x-www-form-urlencoded)
const { data } await axios.post(https://httpbin.org/post,{firstName: Fred,lastName: Flintstone,orders: [1, 2, 3],},{headers: {Content-Type: application/x-www-form-urlencoded,},}
);
二 Axios API
1. Axios API
可以向 axios 传递相关配置来创建请求axios(config)
// 发起一个post请求
axios({method: post,url: /user/12345,data: {firstName: Fred,lastName: Flintstone,},
});
axios(url[, config])
// 发起一个 GET 请求 (默认请求方式)
axios(/user/12345);
1.1 请求方式别名 为了方便起见已经为所有支持的请求方法提供了别名 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]]) axios.postForm(url[, data[, config]]) axios.putForm(url[, data[, config]]) axios.patchForm(url[, data[, config]]) tips在使用别名方法时url、method、data 这些属性都不必在配置中指定。 2. Axios 实例
使用自定义配置新建一个实例axios.create([config])
const instance axios.create({baseURL: https://some-domain.com/api/,timeout: 1000,headers: { X-Custom-Header: foobar },
});
3. 请求配置
配置选项中只有 url 是必需method 默认使用 GET 方法
{// url 是用于请求的服务器 URLurl: /user,// method 是创建请求时使用的方法method: get, // 默认值// baseURL 将自动加在 url 前面除非 url 是一个绝对 URL。// 它可以通过设置一个 baseURL 便于为 axios 实例的方法传递相对 URLbaseURL: https://some-domain.com/api/,// transformRequest 允许在向服务器发送前修改请求数据// 它只能用于 PUT, POST 和 PATCH 这几个请求方法// 数组中最后一个函数必须返回一个字符串 一个Buffer实例ArrayBufferFormData或 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. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)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, Bufferdata: {firstName: Fred},// 发送请求体数据的可选语法// 请求方式 post// 只有 value 会被发送key 则不会data: CountryBrasilCityBelo Horizonte,// timeout 指定请求超时的毫秒数。// 如果请求时间超过 timeout 的值则请求会被中断timeout: 1000, // 默认值是 0 (永不超时)// withCredentials 表示跨域请求时是否需要使用凭证withCredentials: false, // default// adapter 允许自定义处理请求这使测试更加容易。// 返回一个 promise 并提供一个有效的响应 参见 lib/adapters/README.md。adapter: function (config) {/* ... */},// auth HTTP Basic Authauth: {username: janedoe,password: s00pers3cret},// responseType 表示浏览器将要响应的数据类型// 选项包括: arraybuffer, document, json, text, stream// 浏览器专属blobresponseType: json, // 默认值// responseEncoding 表示用于解码响应的编码 (Node.js 专属)// 注意忽略 responseType 的值为 stream或者是客户端请求// Note: Ignored for responseType of stream or client-side requestsresponseEncoding: 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 或 undefined)// 则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 为httpsproxy: {protocol: https,host: 127.0.0.1,port: 9000,auth: {username: mikeymike,password: rapunz3l}},// see https://axios-http.com/zh/docs/cancellationcancelToken: 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 // 默认值}
4. 响应结构
请求的响应包含以下信息
{// 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);
});
5. 默认配置 可以指定默认配置它将作用于每个请求。 5.1 全局 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;
5.2 自定义实例默认值
// 创建实例时配置默认值
const instance axios.create({baseURL: https://api.example.com,
});// 创建实例后修改默认值
instance.defaults.headers.common[Authorization] AUTH_TOKEN;
5.3 配置的优先级
配置合并顺序是在 lib/defaults.js 中默认值 - 实例的 defaults 属性 - 请求的 config 参数。后者优先级高于前者。如下
// 使用库提供的默认配置创建实例
// 此时超时配置的默认值是 0
const instance axios.create();// 重写库的超时默认值
// 现在所有使用此实例的请求都将等待2.5秒然后才会超时
instance.defaults.timeout 2500;// 重写此请求的超时时间因为该请求需要很长时间
instance.get(/longRequest, {timeout: 5000,
});
6. 拦截器
在请求或响应被 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 () {/*...*/
});
7. 错误处理
7.1 基础用法
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);
});
7.2 validateStatus
使用 validateStatus 配置选项可自定义抛出错误的 HTTP code
axios.get(/user/12345, {validateStatus: function (status) {return status 500; // 处理状态码小于500的情况},
});
7.3 toJson
使用 toJSON 可以获取更多关于 HTTP 错误的信息
axios.get(/user/12345).catch(function (error) {console.log(error.toJSON());
});
8. 取消请求
8.1 AbortController
从 v0.22.0 开始Axios 支持以 fetch API 方式—— AbortController 取消请求
const controller new AbortController();axios.get(/foo/bar, {signal: controller.signal,}).then(function (response) {//...});
// 取消请求
controller.abort();
8.2 CancelToken deprecated
使用 CancelToken.source 工厂方法创建一个 cancel token 如下所示
const CancelToken axios.CancelToken;
const source CancelToken.source();axios.get(/user/12345, {cancelToken: source.token,}).catch(function (thrown) {if (axios.isCancel(thrown)) {console.log(Request canceled, thrown.message);} else {// 处理错误}});axios.post(/user/12345,{name: new name,},{cancelToken: source.token,}
);// 取消请求message 参数是可选的
source.cancel(Operation canceled by the user.);
可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建一个 cancel token
const CancelToken axios.CancelToken;
let cancel;axios.get(/user/12345, {cancelToken: new CancelToken(function executor(c) {// executor 函数接收一个 cancel 函数作为参数cancel c;}),
});// 取消请求
cancel();
9. 请求体编码
9.1 自动序列化
当请求头中的 content-type 是 application/x-www-form-urlencoded 时Axios 将自动地将普通对象序列化成 urlencoded 的格式
const data {x: 1,arr: [1, 2, 3],arr2: [1, [2], 3],users: [{ name: Peter, surname: Griffin },{ name: Thomas, surname: Anderson },],
};await axios.post(https://postman-echo.com/post, data, {headers: { content-type: application/x-www-form-urlencoded },
});
服务器接收到的数据就像是这样 {x: 1,arr[]: [ 1, 2, 3 ],arr2[0]: 1,arr2[1][0]: 2,arr2[2]: 3,arr3[]: [ 1, 2, 3 ],users[0][name]: Peter,users[0][surname]: griffin,users[1][name]: Thomas,users[1][surname]: Anderson}
