Axios基础学习（未完）
官网：https://www.axios-http.cn/docs/req_config学习目录
https://i-blog.csdnimg.cn/img_convert/325c24f6188d826bbbac9ce6dd7787dd.jpeg
前言
什么是axios库
Axios 是一个基于promise网络请求库，作用于node.js和浏览器中。 它是 isomorphic的(即同一套代码可以运行在浏览器和node.js中)。
[*]在服务端它使用原生 node.js 模块在客户端 (浏览端) 则使用 XMLHttpRequests(ajax) (XMLHttpRequests与ajax的关系https://zhuanlan.zhihu.com/p/163718536#:~:text=XMLHttpReq)
特性
[*]从浏览器创建XMLHttpRequests
[*]从node.js创建http请求
[*]支持Promise API
[*]拦截请求和响应
[*]转换请求和响应
[*]取消请求
[*]超时处理
[*]查询参数序列化支持嵌套项处理
[*]自动将请求体序列化为：
[*]JSON（applocation/json）
[*]Multipart/FormData(multipart/form-data)
[*]URL encoded form (application/x-www-form-urlencoded)
[*]将HTML Form 转化成JSON 举行请求
[*]自动转化JSON数据
[*]获取浏览器和node.js的请求进度，并提供额外的信息（速度、剩余时间）
[*]为node.js设置带宽限制
[*]兼容符合规范的FormData 和Blob(包括 node.js)
[*]客户端支持防御XSRF
更多案例可见测试代码
一、axios基础应用
1、安装
npm i axios
# 或者
yarn add axios
# 或者 cdn
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
2、axios的基本用法
axios是基于Promise的网络请求库，以是它的返回结果是个promise对象可以用await/then axios(config)
可以向axios通报相干配置来直接发送请求(axios作为函数来使用)
import axios from 'axios';
...
await axios({
url: 'http://localhost:3000/posts',
method: 'get',
});
message.success('请求成功')
axios
第一个参数为请求地点，第二个参数默认相干配置（不传第二个参数默认get请求） await axios('http://localhost:3000/posts', {method: 'get', params: {xx: 1}})
https://i-blog.csdnimg.cn/img_convert/ed030341cd08cbb4b7dedf3239f2d2ff.png
axios方法请求（别名方法请求）
为了方便起见，已经为所有支持的方法提供了别名 （axios作为对象来使用） 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]])
留意：在使用别名方法时，url、method、data这些属性都不必在配置中指定。
3、axios创建实例对象发送请求
创建的实例和axios本身功能几近一样。一样寻常项目中会选择创建实例对象，举行相应封装后给开发职员使用。
[*]统一设置超时时长
[*]设置请求拦截器（可给某些请求地点统一添加参数、判断token是否失效…）、响应拦截器(统一处理返回报错信息、返回数据处理…)
创建axios实例
axios.create()
const instance = axios.create({
baseURL: 'https://some-domain.com/api/',
timeout: 1000,
headers: {'X-Custom-Header': 'foobar'}
});
instance.get(url, data)// 实例发送各种请求
实例方法
以下是可用的实例方法。指定的配置将与实例的配置合并。 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()
4、axios的响应
axios请求成功后的响应数据许多，不像我们平时项目里返回的数据那样做过处理，只返回有效的数据。 https://i-blog.csdnimg.cn/img_convert/9d2fab6b6b51d9d59260c535855c7223.png
https://i-blog.csdnimg.cn/img_convert/e272a19b8f0d1c032e13cdc0c74fd82b.png
5、axios请求配置对象
{
// `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. 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, 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` 或 `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 为`https`
proxy: {
protocol: 'https',
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// see https://axios-http.com/zh/docs/cancellation
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 // 默认值
}
[*]config axios配置对象
https://i-blog.csdnimg.cn/img_convert/6ac71a58afef7dc51ed9839f1154fdf3.png
[*]data 响应体的结果，服务器返回结果。axios自动将服务器返回结果举行json分析。（这里有个问题，axios用的JSON.parse举行的分析，若返回的结果为纯超长的数字分析后可能丢失精度）
[*]headers 响应的头信息
https://i-blog.csdnimg.cn/img_convert/3fd6d90ea26812d3c527528fec8b730b.png
[*]request 原生的ajax请求对象 ，XMLHttpRequests实例对象
https://i-blog.csdnimg.cn/img_convert/092f9578384d38c8133469cafcb359f1.png
[*]status 响应状态码
[*]statusText 响应的状态字符串
6、axios 默认配置
可以指定默认配置，它将作用于每个请求
全局默认值
axios.defaults.method='get';
axios.defaults.baseURL='http://localhost:3000';
axios.defaults.timeout=3000
自界说实例默认值
实例的默认配置优于全局的默认配置
// 自定义实例默认值
const authedAxios=axios.create({
baseURL: 'http://localhost:3000',
});
authedAxios.defaults.timeout=4000
authedAxios.get('/posts/2').then((res)=>{
console.log('----自定义-res', res)
})
7、拦截器
作用：在请求或响应被then或catch处理前拦截他们，处理请求前的参数、响应返回参数等。 不管是请求拦截，还是响应拦截，拦截了过后都需要返回 否则前台获取不到数据
简单的例子：
请求拦截器
axios.intercepters.request.use(function(config){
console.log('请求拦截器------config',config);
return config;
}, function(error){
console.log('请求拦截器失败！', error);
return Promise.reject(error)
});
响应拦截器
axios.intercepters.response.use(function(response){
console.log('响应拦截器-------response'， response);
return response;
},function(error){
console.log('响应拦截器失败', error);
return Promise.reject(error);
})
发请求
axios.request({
url: '/posts/2',
}).then((res)=>{
console.log('-----request-get请求response', res)
}).catch((re)=>{
console.log('axios请求失败----------', re)
})
在业务署理里，我们一样寻常只需要响应的data,可以在响应拦截器处，处理只返回data部分。
https://i-blog.csdnimg.cn/img_convert/806b6ff839ad822a510906e2e9ec69ca.png
多个拦截器
当有多个拦截器， 请求拦截器最反面的先执行（倒序）， 响应拦截器按最开始的先执行，反面的后执行(顺序)； // 添加请求拦截器
axios.interceptors.request.use(function (config) {
// 在发送请求之前做些什么
// 请求拦截器成功
console.log('1请求拦截器-----成功', config)
return config;
// throw '参数出了问题1'
}, function (error) {
// 请求拦截器失败
console.log('1请求拦截器-----失败')
return Promise.reject(error);
});
axios.interceptors.request.use(function (config) {
// 在发送请求之前做些什么
// 请求拦截器成功
console.log('2请求拦截器-----成功', config)
return config;
// throw '参数出了问题2'
}, function (error) {
// 请求拦截器失败
console.log('2请求拦截器-----失败2')
return Promise.reject(error);
});
axios.interceptors.response.use(function(response){
// 响应拦截器成功
console.log('1响应拦截器-----成功', response);
// return response;
return response.data;
},function (error) {
// 响应拦截器失败
console.log('1响应拦截器失败----')
return Promise.reject(error);
})
axios.interceptors.response.use(function(response){
// 响应拦截器成功
console.log('2响应拦截器-----成功', response);
return response;
},function (error) {
// 响应拦截器失败
console.log('2响应拦截器失败----')
return Promise.reject(error);
})
https://i-blog.csdnimg.cn/img_convert/ab178edeb25e8f1e3d92a2e36a9e01a8.png
移除拦截器
const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
实例创建拦截器
自界说的实例也可以创建拦截器。 涉及业务处理
拦截器处判断tonken
https://i-blog.csdnimg.cn/img_convert/bdc039b458963ee1f3fcc4bf1f3cba43.jpeg
8、取消请求
AbortController
从0.22.0版本开始，axios支持以fetch API的方式-AbortController 取消请求 const controller = new AbortController();
console.log('---------controller', controller)
axios.request({
url: '/xxx/xx',
signal: controller.signal
}).then((res)=>{
console.log('请求结果', res);
})catch((err)=>{
console.log('err', err)
})
controller.abort();// 终止请求
console.log('取消请求后的controller',controller)
控制台打印：
创建的controller实例有属性signal
https://i-blog.csdnimg.cn/img_convert/bf11a9bf5773e6f0a68e3da12aaaedd4.png
取消后的controller实例
https://i-blog.csdnimg.cn/img_convert/3348132f0c650e602bf4c5c809f69c4c.png
CancelToken (官网如今不推荐)
此 API 从 ` v0.22.0`开始已被弃用，不应在新项目中使用
方式一：
const CancelToken = axios.CancelToken;
let cancel;
axios.request({
url: '/xxx/xx',
cancelToken: CancelToken(function(cal){
cancel=cal// cal是一个函数
console.log(cal);
}),
})
cancel();// 取消请求
方式二：
const CancelToken = axios.CancelToken;
const source = CancelToken.source();
console.log('source', source)
axios.request({
url: '/xxx/xx',
cancelToken: source.token,
})
source.cancel(); //取消请求
console.log('取消后的source', source);
控制台打印：
https://i-blog.csdnimg.cn/img_convert/38aa7053b0ca5cc985eb7c2906a057e7.pnghttps://i-blog.csdnimg.cn/img_convert/3c22cc74b65747a1f12fbce60df889a3.png
取消后：
https://i-blog.csdnimg.cn/img_convert/99b46d67471cfc01e6442d1239e73c79.png
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]