9. axios
学习之前希望先去看一下 promise 好方便理解
1. axios 的基本了解
- 官方定义: Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。
- 它可以在具有相同代码库的浏览器和 nodejs 中运行
- 在服务器端它使用本机 node.js 的 http模块，而在客户端（浏览器）它使用 XMLHttpRequests。
- axios必须先导入才可以使用
- 使用get或者post方法即可发送请求，
- then方法的回调函数会在请求成功或者失败时触发
- 通过回调函数形参可以获取响应内容或者错误信息
- 简单的理解就是ajax的封装
2. 通过 npm 下载
首先得需要 node 环境
使用 npm：
$ npm install axios
$ bower install axios
3. 简单的引入
CommonJS 用法
const axios = require('axios');
4. 支持多种请求方法
- axios(config)
- 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]])
其中即使请求地址相同, 方式的不同也会导致结果的不同
- get：获取数据，请求指定的信息，返回实体对象
- post：向指定资源提交数据（例如表单提交或文件上传）
- put：更新数据，从客户端向服务器传送的数据取代指定的文档的内容
- patch：更新数据，是对put方法的补充，用来对已知资源进行局部更新
- delete：请求服务器删除指定的数据
可以任意选择需要的方式， 灵活的使用
5. get set 请求示例
最基础的两种请求方式
axios(config)
// 发送 POST 请求
axios({
method: 'post',
url: '/user'
});
axios(url[, config])
// 发送 GET 请求（默认的方法）
axios('http://ximingx.com',{
method:"GET",
})
axios.get(url[, config])
axios.get('/user', {
params: {
ID: 123456
}
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
}
上面的配置中的 params 用于传递参数
async await 的使用
async function getUser() {
try {
const response = await axios.get('/user?ID=12345');
console.log(response);
} catch (error) {
console.error(error);
}
}
async/await是 ECMAScript 2017 的一部分，在 Internet Explorer 和旧版浏览器中不受支持，因此请谨慎使用。嗷呜。
请求默认配置
// 在全局声明之后， 每次的 axios 请求路径前都会拼接上全局声明的路径
axios.defaults.baseURL = 'https://api.example.com';
6. 并发发送请求
使用axios.all，可以放入多个请求的数组。
axios.all([])返回的是一个数组，使用axios.spread可以将数组[res1,res2]展开为res1和res2。
等到最后都返回结果的时候才会调用 then 方法
import axios from 'axios'
export default {
name: 'app',
created(){
// 数组里存放两个 axios 请求，用 `，` 隔开
axios.all([axios.get('http://127.0.0.1:8080/getAll'),
axios.get('http://1ximingx.com/getUserPage',{
params: {pageNum: 1, pageSize: 10}
})
]).then(axios.spread((res1,res2) => {
console.log(res1)
console.log(res2)
}))
}
}
7. config 配置总结
只有 url 是必需的。如果没有指定 method，请求将默认使用 get 方法。
//config
{
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://ximingx.com/api/',
// `url` 是用于请求的服务器 URL
url: '/user',
// 实际上请求的 url 路径为 https://ximingx.com/api/user/
// `method` 是创建请求时使用的方法
method: 'post', // 默认是 get
// `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: 20201613118,
name: "ximingx"
},
// `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: 5000,
// `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) {
})
}
8. 实例化
axios.create()
var instance = axios.create({
baseURL: 'https://ximingx.com',
timeout: 1000
});
// 在实例已创建后修改默认值
instance.defaults.timeout = 2500;
instance({
url: '/home/getAll'
}).then(res => {
console.log(res);
})
9. 请求的响应
通过 axios 发送请求返回的数据都会被处理, 最后返回的数据在data 中
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 服务器响应的头
headers: {},
// `config` 是为请求提供的配置信息
config: {}
}
10. 拦截器
请求拦截的作用是什么？
- 比如config中的一些信息不符合服务器的要求
- 比如每次发送网络请求时, 都希望在界面中显示一个请求的图标
- 某些网络请求(比如登录(token)), 必须携带一些特殊的信息
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
// 在发送请求之前做些什么
return config;
}, function (error) {
// 对请求错误做些什么
return Promise.reject(error);
});
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
// 对响应数据做点什么
return response;
}, function (error) {
// 对响应错误做点什么
return Promise.reject(error);
});
当然也可以实例化之后使用
import axios from 'axios'
export function request(config) {
// 1.创建axios的实例
const instance = axios.create({
baseURL: 'http://127.0.0.1:8080',
timeout: 5000
})
// 2.axios的拦截器
// 2.1.请求拦截的作用
instance.interceptors.request.use(config => {
// console.log(config);
return config
}, err => {
// console.log(err);
})
// 2.2.响应拦截
instance.interceptors.response.use(res => {
// console.log(res);
return res.data
}, err => {
console.log(err);
})
// 3.发送真正的网络请求
return instance(config)
}
11 封装
import axios from 'axios'
const TIMEOUT = 5000
const BASEURL = 'http://localhost:3000/api/ximingx/v1'
export function request(config) {
const instance = axios.create({
baseURL: BASEURL,
timeout: TIMEOUT,
headers: {
'Content-Type': 'application/json'
}
})
// 请求拦截器
instance.interceptors.request.use(config => {
// 设置 token
config.headers.Authorization = `Bearer ${localStorage.getItem('token')}`;
return config
},err => {
console.log(err)
})
// 响应拦截器
instance.interceptors.response.use(res => {
// 直接返回数据
return res.data
},err => {
console.log(err)
})
return instance(config)
}
调用
import {request} from "network/request";
return request({
url: '/api/user',
params: {
name: "ximingx"
}
})
12. 补充
为什么不适用jQuery的Ajax？
在vue开发中不需要使用jQuery，因为jQuery很重量级。使用 jquery 比 vue 体积还大， 得不偿失
vue官方在Vue1.x的时候，推出了Vue-resource。
Vue-resource角jQuery轻便很多，但在vue2.x之后，尤雨溪对Vue-resource不维护了，简言之，就是弃用了。
尤雨溪推荐使用axios。 嗷呜, 听男神的话
