推广网站技巧,wordpress 多重筛选插件,上海新闻,国外一个做ppt的网站1、Axios介绍 Axios基于promise网络请求库#xff0c;作用于node.js和浏览器中#xff08;即同一套代码可以运行在node.js和浏览器中)#xff0c;在服务器中他使用原生node.js http,在浏览器端则使用XMLHttpRequest。 特性#xff1a; #xff08;1#xff09;、支持 Pro…1、Axios介绍 Axios基于promise网络请求库作用于node.js和浏览器中即同一套代码可以运行在node.js和浏览器中)在服务器中他使用原生node.js http,在浏览器端则使用XMLHttpRequest。 特性 1、支持 Promise API 2、拦截请求和响应、转换请求和响应数据、取消请求 3、自动转换JSON数据、客户端支持防御XSRF 安装 1、使用npm npm install axios 2、使用yarn yarn add axios
2、基本用例 CommonJS用法
const axios require(axios).default;// axios. 能够提供自动完成和参数类型推断功能 1、get请求 写法1
axios.get(/user?ID12345)写法2
axios.get(/user, {params: {ID: 12345}})const axios require(axios);// 向给定ID的用户发起请求
axios.get(/user?ID12345).then(function (response) {// 处理成功情况console.log(response);}).catch(function (error) {// 处理错误情况console.log(error);}).then(function () {// 总是会执行});// 支持async/await用法
async function getUser() {try {const response await axios.get(/user?ID12345);console.log(response);} catch (error) {console.error(error);}
}发起多个并发请求
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];});2、Post请求
axios.post(/user, {firstName: Fred,lastName: Flintstone}).then(function (response) {console.log(response);}).catch(function (error) {console.log(error);});3、Axios API axios(config) 可以向 axios 传递相关配置来创建请求
// 发起一个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 这些属性都不必在配置中指定。
3、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])
4、请求配置 这些是创建请求时可以用的配置选项。只有 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 // 默认值
}5、响应结构 一个请求的响应包含以下信息。
{// 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: {}
}6、默认配置 您可以指定默认配置它将作用于每个请求。
全局 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;自定义实例默认值 // 创建实例时配置默认值
const instance axios.create({baseURL: https://api.example.com
});// 创建实例后修改默认值
instance.defaults.headers.common[Authorization] AUTH_TOKEN;配置的优先级 配置将会按优先级进行合并。它的顺序是在lib/defaults.js中找到的库默认值然后是实例的 defaults 属性最后是请求的 config 参数。后面的优先级要高于前面的。下面有一个例子。
// 使用库提供的默认配置创建实例 // 此时超时配置的默认值是 0
const instance axios.create();// 重写库的超时默认值 // 现在所有使用此实例的请求都将等待2.5秒然后才会超时
instance.defaults.timeout 2500;// 重写此请求的超时时间因为该请求需要很长时间
instance.get(/longRequest, {timeout: 5000
});7、拦截器 在请求或响应被 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 () {/*...*/});8、错误处理
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());});9、取消请求 AbortController 从 v0.22.0 开始Axios 支持以 fetch API 方式—— AbortController 取消请求
const controller new AbortController();axios.get(/foo/bar, {signal: controller.signal
}).then(function(response) {//...
});
// 取消请求
controller.abort()
CancelToken deprecated您还可以使用 cancel token 取消一个请求。
Axios 的 cancel token API 是基于被撤销 cancelable promises proposal。
此 API 从 v0.22.0 开始已被弃用不应在新项目中使用。
可以使用 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();注意: 可以使用同一个 cancel token 或 signal 取消多个请求。
在过渡期间您可以使用这两种取消 API即使是针对同一个请求
const controller new AbortController();const CancelToken axios.CancelToken;
const source CancelToken.source();axios.get(/user/12345, {cancelToken: source.token,signal: controller.signal
}).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.);
// 或
controller.abort(); // 不支持 message 参数10、请求体编码 默认情况下axios将 JavaScript 对象序列化为 JSON 。 要以application/x-www-form-urlencoded格式发送数据您可以使用以下选项之一。
浏览器 在浏览器中可以使用URLSearchParams API如下所示
const params new URLSearchParams();
params.append(param1, value1);
params.append(param2, value2);
axios.post(/foo, params);请注意不是所有的浏览器(参见 caniuse.com)都支持 URLSearchParams 但是可以使用polyfill (确保 polyfill 全局环境)
或者, 您可以使用qs 库编码数据:
const qs require(qs);
axios.post(/foo, qs.stringify({ bar: 123 }));或者用另一种方式 (ES6),
import qs from qs;
const data { bar: 123 };
const options {method: POST,headers: { content-type: application/x-www-form-urlencoded },data: qs.stringify(data),url,
};
axios(options);Node.js Query string 在 node.js 中 可以使用 querystring 模块如下所示:
const querystring require(querystring);
axios.post(http://something.com/, querystring.stringify({ foo: bar }));或者从’url module’中使用’URLSearchParams’如下所示:
const url require(url);
const params new url.URLSearchParams({ foo: bar });
axios.post(http://something.com/, params.toString());您也可以使用 qs 库。
注意 如果需要对嵌套对象进行字符串化处理则最好使用 qs 库因为 querystring 方法在该用例中存在已知问题(https://github.com/nodejs/node-v0.x-archive/issues/1665)。
Form data 在 node.js, 您可以使用 form-data 库如下所示:
const FormData require(form-data);const form new FormData();
form.append(my_field, my value);
form.append(my_buffer, new Buffer(10));
form.append(my_file, fs.createReadStream(/foo/bar.jpg));axios.post(https://example.com, form, { headers: form.getHeaders() })或者, 使用一个拦截器:
axios.interceptors.request.use(config {if (config.data instanceof FormData) {Object.assign(config.headers, config.data.getHeaders());}return config;
});11、注意事项 语义化 在axios达到 1.0 版本之前破坏性更改将以新的次要版本发布。 例如 0.5.1 和 0.5.4 将具有相同的 API但 0.6.0 将具有重大变化。
Promises axios 依赖原生的ES6 Promise实现而被支持。 如果你的环境不支持 ES6 Promise你可以使用polyfill。
TypeScript axios 包含 TypeScript 类型定义。
import axios from axios;
axios.get(/user?ID12345);
