适合前端的网络请求模块：axios学习全集
1. 什么是axios？
axios是一个基于promise的HTTP库，可以在浏览器和node.js中使用。promise是es6的语法，这对前端人员是非常友好的。
特性：
- 从浏览器中创建XMLHttpRequests
- 从node.js创建http请求
- 支持Promise API
- 拦截请求和响应
- 转换请求数据和相应数据
- 取消请求
- 自动转换JSON数据
- 客户端支持防御XSRF
2.axios的API
A. axios有一个API可以实现大部分的请求,可以通过向axios传递相关配置来创建请求：
- axios(config)
示例：
import axios from "axios";
//1.发送post请求
axios({
method:"post",
url:"请求的网址",
date:{
//使用post方法提交给服务器的数据
}
})
//2.发送get请求，获取远端图片
axios({
method:"get",
url:"请求的网址",
responseType:"stream"
}).then((response)=>{
response.data.pipe(fs.createStream("xxx.jpg"))
})
注意：当使用axios(url[,config])时，若没有设置method属性，则默认是get请求。中括号参数表示可选。
//发送get请求（默认方法）
axios("/user/12345")
B. 但是为了在开发中方便区分，官方还是为所有请求方法提供了别名：
- axios.request(config)
- axios.get(url[,config])
- axios.delete(url[,config])
- axios.head(url[,config])
- axios.options(url[,config])
- axios.patch(url[data[,config]])
- axios.post(url[data[,config]])
- axios.put(url[data[,config]])
注意：在使用别名方法时，url、method、data这些属性都不必在配置中指定。
api使用示例1：（get请求）
axios.get("/user?id=12345").then(
res => {
console.log(res);
},
err => {
console.log(err);
}
);
//上面的请求也可以这样写
axios.get("/user", {
params: {
id: 1234
}
})
.then(
res => {
console.log(res);
},
err => {
console.log(err);
}
);
api使用示例2：（post请求，省略第三个参数config）
axios
.post("/user", {
name: "张三",
age: 18
})
.then(
res => {
console.log(res);
},
err => {
console.log(err);
}
);
C. 当我们需同时发送多个请求时，我们可以使用并发函数：
- axios.all(iterable)（迭代器，即数组对象）
- axios.spread(callback)(少用)
function getUserAccount() {
return axios.get("/user/account");
}
function getUserPermissions() {
return axios.post("user/permissions");
}
axios.all([getUserAccount(), getUserPermissions()]).then(
axios.spread(result1,result2){
//处理两个请求的数据
}
)
D. 创建实例
在上面使用的几乎是全局axios，全局的配置对象的缺点就是有些重复的配置内容在没写一个请求都需重复写代码，我们封装网络请求需用到自定义实例。
- axios.create([config])
const instance = axios.create({
baseURL: "一般写多个网址的相同部分",
timeout: 1000,
headers: {
"X-Custom-Header": "foobar" }
});
注意：使用创建的axios实例请求时，请求的配置项将与实例的配置合并。
3. 请求的配置选项
这些是创建请求时可以用的配置选项。只有url是必须的，如果没有指定method，请求将默认使用get方法。
{
// url 是用于请求的服务器 URL
url: '/user',
// method 是创建请求时使用的方法
method: 'get', // default
// baseURL 将自动加在 url 前面，除非 url 是一个绝对 URL
// 它可以通过设置一个 baseURL 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// transformRequest 允许在向服务器发送前，修改请求数据
// 只能用在 PUT、POST 和 PATCH 这几个请求方法
// 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data, headers) {
// 对 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, // default
// 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', // default
// responseEncoding 表示对响应的编码
// Note：对于 responseType 为 stream 或 客户端请求会忽略
responseEncoding: 'utf-8',
// xsrfCookieName 是用作 xsrf token 值的 cookie 名称 xsrfCookieName: 'XSRF-TOKEN',
// default
// xsrfHeaderName 是 xsrf token 值的 http 头名称
xsrfHeaderName: 'X-XSRF-TOKEN', // default
// onUploadProgress 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// ... ...
},
// onDownloadProgress 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// ... ...
},
// maxContentLength 定义允许的响应内容的最大尺寸
maxContentLength: 2000,
// validateStatus 定义对于给定的 HTTP 响应状态码是 resolve 或 reject promise。
// 如果 validateStatus 返回 true (或者设置为 null 或 undefined)，promise 将被 resolve，否则 promise 将被 reject
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
// maxRedirects 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为 0，将不会 follow 任何重定向
maxRedirects: 5,
// socketPath 用于在 node.js 中定义 UNIX Socket
// e.g. '/var/run/docker.sock' to send requests to the docker daemon.
// 只能指定 socketPath 或 proxy，如果两者同时指定，将使用 socketPath
ocketPath: null,
// 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: 'rapunz31'
}
},
// cancelToken 指定用于取消请求的 cancel token
cancelToken: new CancelToken(function (cancel) {
// ... ...
}) }
4. 响应信息
某个请求的响应包含一下信息：
//data由服务器提供的响应
data{
},
//status 来自服务器相应的HTTP状态吗
status:200,
//statusText来自服务器相应的HTTP状态信息
statusText:"OK",
//headers:{}
headers:{
},
//config是为请求提供的配置信息
config:{
},
//request是生成当前响应的请求
request:{
}
5. 配置对象的默认值
我们可以指定将被用在各个请求的配置默认值。
全局的axios默认值：
axios.defaults.baseURL="xxx.com";
axios.defaults.timeout=3000;
自定义实例默认值：
//创建实例时设置config默认值
const instant = axios.create({
baseURL: "xxx.com"
});
//创建实例后可修改默认值
instance.defaults.baseURL = "bbb.com";
配置的优先顺序：
上面我们在全局配置默认值，也在实例中配置默认值。在发起请求时，使用配置会以一个优先顺序进行合并。这个顺序是：
- 在lib/defaults.js找到库的默认值。
- 在axios实例中找defaults属性。
- 最后是请求的config参数。
后者将优于前者。
实例：
//使用库提供的配置默认值来创建实例，此时超时配置的默认值是0
const instance = axios.create();
//覆盖库的默认值，现在超时值为3000
instance.defaults.timeout = 3000;
//在请求的配置选择设置5000，则最终5000为超时
instance.get("xxx.com", {
timeout: 5000
});
6. 拦截器
如果我们在发送请求前或接收响应数据前想做一些处理就需要用到拦截器。
在请求或响应被then或catch处理前拦截它们：
//添加请求拦截器
axios.interceptors.request.use(
//在发送请求前拦截下来的是请求中的config对象
function(config){
//在发送请求前做些什么
return config;//拦截下来的config必须返回，否则请求无法进行
},
function(error){
//对错误请求做点什么
return Promise.reject(error);
}
)
//添加响应拦截器
axios.interceptors.response.use(
//在拦截响应，拦截的是相应的数据
function(response){
//对响应数据做点什么
return response;//务必返回，否则获取不到数据
},
function(error){
//对错误响应做点什么
return Promise.reject(error);
}
)
如果你想在使用拦截器后移除拦截器，可以这样：
const myInterceptor=axios.interceptors.response.use(
function(){
}
)
axios.interceptors.response.eject(myInterceptor)
上面的是全局的axios使用拦截器，那自定义的axios实例呢？
const instance = axios.create();
instance.interceptors.request.use(
function(){
}
)
7.错误处理
在做请求时，偶尔会遇到一些错误，那么我们需要在客户端清楚知道这是来自客户端错误还是服务端的错误。
错误处理样例：
axios.get("/user?id=12345")
.catch(function(error) {
if (error.response) {
//进入这里，说明请求已发出，并且服务器的响应状态吗超出了2xx的范围
console.log(error.response.status)
}else if(error.request){
//进入这里，说明请求已发出，但是没有收到任何相应
console.log(error.request)
}else{
console.log("Error Message:",error.message)
}
});