axios在vue项目中的使用实例详解

傷城~ 2023-02-11 11:23 27阅读 0赞

## 1、基本用法 ##

安装

cnpm i axios --save

在 `main.js` 中引入 `axios`

import axios from 'axios'
    Vue.prototype.$axios = axios

在组件中使用 `axios`

## 2、axios请求方法 ##

axios可以请求的方法：

*  get：获取数据，请求指定的信息，返回实体对象
 *  post：向指定资源提交数据（例如表单提交或文件上传）
 *  put：更新数据，从客户端向服务器传送的数据取代指定的文档的内容
 *  patch：更新数据，是对put方法的补充，用来对已知资源进行局部更新
 *  delete：请求服务器删除指定的数据

### 2.1、get请求 ###

示例代码

//方法一，请求格式类似于 http://localhost:8080/goods.json?id=1
    this.$axios.get('/goods.json',{ 
        			params: { 
                        id:1
                    }
    			}).then(res=>{ 
    					console.log(res.data);
    				},err=>{ 
    					console.log(err);
    			})
    			
    //方法二
    this.$axios({ 
    		method: 'get',
    		url: '/goods.json',
        	params: { 
                id:1
            }
    	}).then(res=>{ 
    		console.log(res.data);
    	},err=>{ 
    		console.log(err);
    	})

### 2.2、post请求 ###

post请求一般分为两种类型

*  form-data 表单提交，图片上传、文件上传时用该类型比较多
 *  application/json 一般是用于 ajax 异步请求

示例代码

//方法一
    this.$axios.post('/url',{ 
    				id:1
    			}).then(res=>{ 
    				console.log(res.data);
    			},err=>{ 
    				console.log(err);
    			})
    
    //方法二
    $axios({ 
    	method: 'post',
    	url: '/url',
    	data: { 
    		id:1
    	}
    }).then(res=>{ 
    	console.log(res.data);
    },err=>{ 
    	console.log(err);
    })
    
    //form-data请求
    let data = { 
    	//请求参数
    }
    
    let formdata = new FormData();
    for(let key in data){ 
    	formdata.append(key,data[key]);
    }
    
    this.$axios.post('/goods.json',formdata).then(res=>{ 
    	console.log(res.data);
    },err=>{ 
    	console.log(err);
    })

### 2.3、put和patch请求 ###

示例代码

//put请求
    this.$axios.put('/url',{ 
    				id:1
    			}).then(res=>{ 
    				console.log(res.data);
    			})
    
    //patch请求
    this.$axios.put('/url',{ 
    				id:1
    			}).then(res=>{ 
    				console.log(res.data);
    			})

### 2.4、delete请求 ###

示例代码

//参数以明文形式提交
    this.$axios.delete('/url',{ 
    				params: { 
    					id:1
    				}
    			}).then(res=>{ 
    				console.log(res.data);
    			})
    
    //参数以封装对象的形式提交
    this.$axios.delete('/url',{ 
    				data: { 
    					id:1
    				}
    			}).then(res=>{ 
    				console.log(res.data);
    			})
    
    //方法二
    axios({ 
        method: 'delete',
        url: '/url',
        params: {  id:1 }, //以明文方式提交参数
        data: {  id:1 } //以封装对象方式提交参数
    }).then(res=>{ 
    	console.log(res.data);
    })

## 3、并发请求 ##

并发请求：同时进行多个请求，并统一处理返回值

示例代码

this.$axios.all([
    	this.$axios.get('/goods.json'),
    	this.$axios.get('/classify.json')
    ]).then(
    	this.$axios.spread((goodsRes,classifyRes)=>{ 
    		console.log(goodsRes.data);
    		console.log(classifyRes.data);
    	})
    )

## 4、axios实例 ##

### 4.1、创建axios实例 ###

示例代码

let instance = this.$axios.create({ 
    				baseURL: 'http://localhost:9090',
    				timeout: 2000
    			})
    			
    instance.get('/goods.json').then(res=>{ 
    	console.log(res.data);
    })

可以同时创建多个axios实例。

axios实例常用配置：

*  baseURL 请求的域名，基本地址，类型：String
 *  timeout 请求超时时长，单位ms，类型：Number
 *  url 请求路径，类型：String
 *  method 请求方法，类型：String
 *  headers 设置请求头，类型：Object
 *  params 请求参数，将参数拼接在URL上，类型：Object
 *  data 请求参数，将参数放到请求体中，类型：Object

### 4.2、axios全局配置 ###

示例代码

//配置全局的超时时长
    this.$axios.defaults.timeout = 2000;
    //配置全局的基本URL
    this.$axios.defaults.baseURL = 'http://localhost:8080';

### 4.3、axios实例配置 ###

示例代码

let instance = this.$axios.create();
    instance.defaults.timeout = 3000;

### 4.4、axios请求配置 ###

示例代码

this.$axios.get('/goods.json',{ 
    				timeout: 3000
    			}).then()

以上配置的优先级为：`请求配置 > 实例配置 > 全局配置`

## 5、拦截器 ##

拦截器：在请求或响应被处理前拦截它们

### 5.1、请求拦截器 ###

示例代码

this.$axios.interceptors.request.use(config=>{ 
    				// 发生请求前的处理
    
    				return config
    			},err=>{ 
    				// 请求错误处理
    
    				return Promise.reject(err);
    			})
    
    //或者用axios实例创建拦截器
    let instance = $axios.create();
    instance.interceptors.request.use(config=>{ 
        return config
    })

### 5.2、响应拦截器 ###

示例代码

this.$axios.interceptors.response.use(res=>{ 
    				//请求成功对响应数据做处理
    
    				return res //该返回对象会传到请求方法的响应对象中
    			},err=>{ 
    				// 响应错误处理
    
    				return Promise.reject(err);
    			})

### 5.3、取消拦截 ###

示例代码

let instance = this.$axios.interceptors.request.use(config=>{ 
    				config.headers = { 
    					token: ''
    				}
    				return config
    			})
    			
    //取消拦截
    this.$axios.interceptors.request.eject(instance);

## 6、错误处理 ##

示例代码

this.$axios.get('/url').then(res={ 
    
    			}).catch(err=>{ 
    				//请求拦截器和响应拦截器抛出错误时，返回的err对象会传给当前函数的err对象
    				console.log(err);
    			})

## 7、取消请求 ##

主要用于取消正在进行的http请求。

示例代码

let source = this.$axios.CancelToken.source();
    
    this.$axios.get('/goods.json',{ 
    				cancelToken: source
    			}).then(res=>{ 
    				console.log(res)
    			}).catch(err=>{ 
    				//取消请求后会执行该方法
    				console.log(err)
    			})
    
    //取消请求，参数可选，该参数信息会发送到请求的catch中
    source.cancel('取消后的信息');