佛山高端网站制作,正规的网站制作,东莞外贸网站建设策划方案,达州大亚网站建设axios起步——介绍和使用基本用例post请求 场景复现核心干货axios APIaxios(config)axios(url[,config])请求方式别名 axios实例创建一个axios实例axios.create([config])实例方法 axios请求配置axios响应结构 场景复现
最近学习与前端相关的小程序时#xff0c;接触了异步请… axios起步——介绍和使用基本用例post请求 场景复现核心干货axios APIaxios(config)axios(url[,config])请求方式别名 axios实例创建一个axios实例axios.create([config])实例方法 axios请求配置axios响应结构 场景复现
最近学习与前端相关的小程序时接触了异步请求api的封装和实现涉及到了很多底层的基础知识比如ajax和axios工具因此计划用两个专栏来系统的学习关于axios和ajax的实用知识。 本期文章将重点介绍axios请求——Axios API、Axios实例、请求配置、Axios响应结构。
核心干货 axios官方中文文档https://axios-http.com/zh/ ajax文档https://www.runoob.com/ajax/ajax-tutorial.html axios API 可以向axios传递相关配置来创建请求 axios(config)
// 发起一个post请求
axios({method: post,url: /user/12345,data: {firstName: Fred,lastName: Flintstone}
});// 在 node.js 用GET请求获取远程图片
axios({method: get,url: http://bit.ly/2mTM3nY,responseType: stream
}).then(function (response) {response.data.pipe(fs.createWriteStream(ada_lovelace.jpg))});axios(url[,config])
// 发起一个 GET 请求 (默认请求方式)
axios(/user/12345);请求方式别名
为了方便起见已经为所有支持的请求方法提供了别名。
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实例 创建一个axios实例axios.create([config])
const instance axios.create({baseURL: https://some-domain.com/api/,timeout: 1000,headers: {X-Custom-Header: foobar}
});实例方法
以下是可用的实例方法。指定的配置将与实例的配置合并。
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#getUri([config])axios请求配置
在这里整理了一些创建请求时可以用的配置选项只有url是必须的如果没有指定method请求将默认使用GET方法。 一般常用的配置选项 url——用于请求服务器的URLmethod——创建请求时使用的方法baseUrl——自动加在url前面 除非url是一个绝对的URLparams——与请求一起发送的URL参数一般采用字符串拼接传值data——作为请求体被发送的数据仅适用PUT、POST、DELETE、PATCH请求方法一般类型为string、object或者undefinedtimeout——请求超时的毫秒数如果请求时间超过timeout的值则请求会被中断 详细代码示例
{// 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 // 默认值
}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或者传递一个rejection callback作为 then 的第二个参数时响应可以通过 error 对象被使用正如在错误处理部分解释的那样。 以上就是关于与axios请求相关的axios API、axios实例、axios请求配置的分享相信看完这篇文章的小伙伴们一定有了一定的收获。当然可能有不足的地方欢迎大家在评论区留言指正 下期文章将介绍axios API的相关内容 感兴趣的小伙伴可以订阅本专栏方便后续了解学习~ 觉得这篇文章有用的小伙伴们可以点赞➕收藏➕关注哦~
