axios学习笔记
Posted 二木成林
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了axios学习笔记相关的知识，希望对你有一定的参考价值。
axios的配置
aixos官网教程：https://github.com/axios/axios
axios是用来发送Ajax请求的，可以运行在浏览器和Node.js环境中。
如果想要在不同环境中使用axios，需要不同的引入方式：
- 如果是在浏览器中使用，可通过如下代码引入：
<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
例如：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>axios配置</title>
<script src="https://cdn.bootcdn.net/ajax/libs/axios/0.21.1/axios.min.js"></script>
</head>
<body>
<script>
console.log(axios);
</script>
</body>
</html>
- 如果是在Node.js中使用，则可通过下面的代码引入：
// 第一步，安装包
npm install axios
// 第二步，引入使用
var axios = require('axios');
axios基本使用
发送GET请求
例如http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name=李白接口可以获取指定作者的诗词信息，是一个GET请求，正好可以用来测试axios。对于GET请求中参数的处理可以有如下两种方式：
- 参数直接写在URL中
语法格式如下：
/**
* 其中url是你要请求的URL，其中参数是拼接在URL中的
*/
axios.get(url)
.then(function (response)
// response是响应回来的数据
)
.catch(function (error)
// error是错误对象
);
浏览器使用示例如下：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>axios学习</title>
<script src="https://cdn.bootcdn.net/ajax/libs/axios/0.21.1/axios.min.js"></script>
</head>
<body>
<script>
axios.get('http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name=李白')
.then(function (response)
console.log(response);
)
.catch(function (error)
console.log(error);
);
</script>
</body>
</html>
Node.js环境中使用代码如下：
var axios = require('axios');
axios.get('http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name='+encodeURIComponent("李白"))
.then(function (response)
console.log(response);
)
.catch(function (error)
console.log(error);
);
- 请求参数单独列出来
语法如下：
axios.get(请求URL,
params:
参数名: 参数值,
参数名: 参数值
)
.then(function (response)
// response是响应回来的数据
)
.catch(function (error)
// error是错误对象
);
示例如下：
var url = 'http://poetry.apiopen.top/poetryAuthor';
var result = axios.get(url,
params:
count: 2,
page: 1,
name: encodeURIComponent("李白")
)
.then(function (response)
// 数据是保存在data属性上的
console.log(response.data);
).catch(function (error)
console.log(error);
);
注：我们还可以使用async和await的方式获取axios.get()响应返回的数据，但要求是ES7以上，并且有一些浏览器不支持，需要注意。
var url = 'http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name=' + encodeURIComponent("李白");
// 使用async和await关键字封装axios.get()操作
async function getAuthor(url)
try
// axios.get()方法返回的是一个Promise对象，所以可以使用async和await来获取
var res = await axios.get(url);
// 真正我们想要的数据在data属性上
console.log(res.data);
catch (e)
console.log(e);
getAuthor(url);// 调用上面封装的方法
发送POST请求
我们以下面这个接口来进行测试发送POST请求：https://api.apiopen.top/searchPoetry
发送POST请求的基本语法如下：
axios.post(请求URL,
参数名: 参数值,
参数名: 参数值
)
.then(function (response)
// response是响应回来的数据
)
.catch(function (error)
// error是当发生错误时输出的错误对象
);
示例代码如下：
var url = 'https://api.apiopen.top/searchPoetry';
axios.post(url, name: '李白')
.then(function (response)
console.log(response.data);
)
.catch(function (error)
console.log(error);
);
注意，利用Promise还可以执行多个并发请求，示例如下：
var url1 = 'http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name=' + encodeURIComponent("李白");
var url2 = 'http://poetry.apiopen.top/poetryAuthor?count=2&page=1&name=' + encodeURIComponent("杜甫");
var libai = axios.get(url1);
var dufu = axios.get(url2);
// 因为axios.get()方法返回的是Promise对象，所以可以使用Promise.all()语法来执行并发请求
Promise.all([libai, dufu])
.then(function (results)
console.log(results[0].data);
console.log(results[1].data);
);
axios的API
axios()
可以直接将请求URL、请求方法、请求参数等信息直接传到axios()方法，不必单独再使用其他API。语法如下：
axios(config)
其中config是一个对象，是请求URL、请求方法、请求参数等配置信息。
- 例如，发送一个GET请求
var url = 'http://poetry.apiopen.top/poetryAuthor';
axios(
// method属性表示设置请求方式
method: 'get',
// url属性表示设置请求URL
url: url,
// data属性是一个对象，用来设置请求参数
data:
count: 2,
page: 1,
name: encodeURIComponent("李白")
)
// axios()方法返回一个Promise对象，所以可以使用then方法获取响应数据
.then(function (response)
console.log(response.data);
)
.catch(function (error)
console.log(error);
);
- 例如，发送一个POST请求
var url = 'https://api.apiopen.top/searchPoetry';
axios(
// method属性表示设置请求方式
method: 'post',
// url属性表示设置请求URL
url: url,
// data属性是一个对象，用来设置请求参数
data:
name: '李白'
,
// responseType属性表示设置响应数据类型
responseType: 'json'
)
// axios()方法返回一个Promise对象，所以可以使用then方法获取响应数据
.then(function (response)
console.log(response.data);
)
.catch(function (error)
console.log(error);
);
除了上面那一种语法之外，axios()方法还有一种语法，如下：
axios(url[, config])
其中config是可选项，默认发送GET请求。
axios.get()、axios.post()等
为了方便起见，为常用方法方法设置了别名方法，如axios.get()就直接表示发送GET请求。这些方法如下：
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属性不必单独在config参数种标明，因为该方法的参数和名字已经特别说明了。例如GET请求的示例如下：
var url = 'http://poetry.apiopen.top/poetryAuthor';
var result = axios.get(url,
params:
count: 2,
page: 1,
name: encodeURIComponent("李白")
)
.then(function (response)
// 数据是保存在data属性上的
console.log(response.data);
).catch(function (error)
console.log(error);
);
axios.create()
可以使用自定义配置创建新的axios实例，而上面使用的axios.get()等方法中的axios都是默认提供的实例。如果要自定义axios实例，使用create()方法，语法如下：
// 这里的axios还是默认实例
axios.create([config])
例如：
var instance=axios.create(
baseUrl:'https://api.apiopen.top/',
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])
示例如下：
var axios = require('axios');
var axiosInstance = axios.create(
baseURL: 'http://poetry.apiopen.top/',
timeout: 1000
);
axiosInstance
.get('/sentences')
.then(function (res)
console.log(res.data)
);
请求中的config参数和响应中的reponse参数
Request Config
即请求中的config参数，该参数是一个对象，可以设置请求属性，如url、method等。可以设置的属性说明：
// `url` 是用于请求的服务器 URL
url: "/user",
// `method` 是创建请求时使用的方法
method: "get", // 默认是 get
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: "https://some-domain.com/api/",
// `transformRequest` 允许在向服务器发送前，修改请求数据
// 只能用在 "PUT", "POST" 和 "PATCH" 这几个请求方法
// 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data)
// 对 data 进行任意转换处理
return data;
],
// `transformResponse` 在传递给 then/catch 前，允许修改响应数据
transformResponse: [function (data)
// 对 data 进行任意转换处理
return data;
],
// `headers` 是即将被发送的自定义请求头
headers: "X-Requested-With": "XMLHttpRequest",
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)或 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", 和 "PATCH"
// 在没有设置 `transformRequest` 时，必须是以下类型之一：
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 浏览器专属：FormData, File, Blob
// - Node 专属： Stream
data:
firstName: "Fred"
,
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间，请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // 默认的
// `adapter` 允许自定义处理请求，以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config)
/* ... */
,
// `auth` 表示应该使用 HTTP 基础验证，并提供凭据
// 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
auth:
username: "janedoe",
password: "s00pers3cret"
,
// `responseType` 表示服务器响应的数据类型，可以是 "arraybuffer", "blob", "document", "json", "text", "stream"
responseType: "json", // 默认的
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: "XSRF-TOKEN", // default
// `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
xsrfHeaderName: "X-XSRF-TOKEN", // 默认的
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent)
// 对原生进度事件的处理
,
// `onDownloadProgress` 允许为下载处理进度事件
onDownloadProgress: function (progressEvent)
// 对原生进度事件的处理
,
// `maxContentLength` 定义允许的响应内容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
validateStatus: function (status)
return status >= 200 && status < 300; // 默认的
,
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0，将不会 follow 任何重定向
maxRedirects: 5, // 默认的
// `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
// `keepAlive` 默认没有启用
httpAgent: new http.Agent( keepAlive: true ),
httpsAgent: new https.Agent( keepAlive: true ),
// "proxy" 定义代理服务器的主机名称和端口
// `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
// 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
proxy:
host: "127.0.0.1",
port: 9000,
auth: :
username: "mikeymike",
password: "rapunz3l"
,
// `cancelToken` 指定用于取消请求的 cancel token
// （查看后面的 Cancellation 这节了解更多）
cancelToken: new CancelToken(function (cancel)
)
注意：
- 其中
url是必选项，其他都是可选项。 - 如果没有指定
method属性的值，则默认发送GET请求。 - 常用属性有：
url用于指定请求URL；method用于指定请求方式，如GET、POST、PUT等；baseURL通常用于axios.create()方法中，用于指定域名和端口号；headers用于指定请求头；params指定连接在URL后面的参数，通常用在axios.get()方法中；data用于指定提交的数据，通常用于POST、PUT、PATCH请求；timeout指定请求超时毫秒数；responseType指定响应数据类型，默认是json；withCredentials在跨域时会用到，如果是一个前后端分离的项目，通常要修改它来解决跨越问题。
Response Schema
var url = 'http://poetry.apiopen.top/sentences';
axios.get(url).then(function (response)
console.log(response);
);
即响应回来的数据response，它打印的结果如下：
status: 200,
statusText: 'OK',
headers:
'access-control-allow-credentials': 'true',
'access-control-allow-headers': 'Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, Token, Language, From',
'access-control-allow-methods': 'POST, OPTIONS, GET, PUT',
'access-control-allow-origin': '*',
'content-type': 'application/json; charset=UTF-8',
date: 'Sun, 21 Nov 2021 05:27:12 GMT',
'content-length': '140',
connection: 'close'
VSCode自定义代码片段14——Vue的axios网络请求封装