Axios
- 一. Axios介绍
- 二. Axios特点
- 三. Axios安装
- 1. NPM
- 2. CDN
- 四. Axios简单测试
- 1. Get请求测试
- 2. Post请求测试
- 3. 执行多个并发请求
- 4.Axios的Restful风格的API
- 5. Axios的高级使用配置对象
- 6. Axios的实例创建+配置
- 五. Axios模块封装
- 六. Axios拦截器
一. Axios介绍
- Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。
- Axios 是一个 异步请求 技术
- 异步请求,基于XMLHttpRequest对象发起的请求都是异步请求
- 异步请求特点: 请求之后页面不动,响应回来更新的是页面的局部,多个请求之间互不影响 并行执行
二. Axios特点
- 从浏览器中创建 XMLHttpRequests
- 从 node.js 创建 http 请求
- 支持 Promise API
- 拦截请求和响应
- 转换请求数据和响应数据
- 取消请求
- 自动转换 JSON 数据
- 客户端支持防御 XSRF
三. Axios安装
1. NPM
npm install axios
2. CDN
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
四. Axios简单测试
自己写两个Get/Post接口用来测试
package com.xizi.controller;
import com.xizi.pojo.User;
import org.springframework.web.bind.annotation.*;
import java.util.*;
@RestController
@RequestMapping("axios")
public class AxiosController {
@GetMapping("findAll")
@CrossOrigin(allowCredentials = "true")
public List<User> findAll(String name,String password){
System.out.println("name = " + name);
System.out.println("password = " + password);
ArrayList<User> users = new ArrayList<>();
users.add(new User("21","戏子学Java",20,new Date()));
users.add(new User("22","戏子学前端",20,new Date()));
users.add(new User("22","戏子学运维",20,new Date()));
return users;
}
@PostMapping("save")
@CrossOrigin(allowCredentials = "true")
public Map<String,Object> save(@RequestBody User user){
System.out.println("user = " + user);
HashMap<String, Object> map = new HashMap<>();
map.put("success",true);
map.put("message","保存成功!");
return map;
}
}
1. Get请求测试
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script>
//get方式的请求 发送的请求的url
axios.get("http://localhost:8888/axios/findAll").then(res => {
console.log(res.data)
}).catch(err=>{ //当请求错误的时候回调函数
console.log(err);
})
</script>
</head>
<body>
</body>
</html>
2. Post请求测试
3. 执行多个并发请求
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script>
function findAll() {
return axios.get("http://localhost:8888/axios/findAll?name=戏子&password=123456");
}
function save() {
return axios.post("http://localhost:8888/axios/save",{name:"戏子",age:20});
}
//并行处理
//all用来处理并发请求
axios.all([findAll(),save()]).//用来处理并发请求
then(
axios.spread( (result1,result2)=> {
//用来统一处理多个并发请求的执行结果
console.log(result1.data);
console.log(result2.data);
})
) ;
</script>
</head>
<body>
</body>
</html>
4.Axios的Restful风格的API
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])
5. Axios的高级使用配置对象
常见的配置选项
{
// `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) {
})
}
6. Axios的实例创建+配置
这个实例测试我就使用vue-cli3.0脚手架来测试,使用npm安装方式
创建axios实例 进行网络请求
// 4. 创建axios实例 进行网络请求
const instance=axios.create({
baseURL: 'http://localhost:8888',
timeout: 5000
})
instance({
url: '/axios/findAll'
}).then(res=>{
console.log(res)
console.log(res.data)
})
五. Axios模块封装
六. Axios拦截器
- axios提供了拦截器,用于我们在发送每次请求或者得到相应后,进行对应的处理。
- 在请求或响应被 then 或 catch 处理前拦截它们。
- 响应的成功拦截中,主要是对数据进行过滤。
- 响应的失败拦截中,可以根据status判断报错的错误码,跳转到不同的错误提示页面