Vue Axios 的封装使用
2024-09-07 15:28:03
Axios 说明
Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。
安装
npm 中安装
npm install axios
使用 cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
Axios 请求配置
下面的都是针对请求时可以设置的配置项，只有 url 是必须的，若没有指定，则默认使用 get 方式请求。
{
// `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: {
userId: 1
},
// `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: {
userName: 'levy'
},
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间，请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // 默认的
// `adapter` 允许自定义处理请求，以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示应该使用 HTTP 基础验证，并提供凭据
// 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
auth: {
username: 'levy',
password: '123456'
},
// `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: 2500,
// `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: 8080,
auth: : {
username: 'levy',
password: '123456'
}
},
// `cancelToken` 指定用于取消请求的 cancel token
// （查看后面的 Cancellation 这节了解更多）
cancelToken: new CancelToken(function (cancel) {
})
}
响应结构
通常的请求响应结构体如下：
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 服务器响应的头
headers: {},
// `config` 是为请求提供的配置信息
config: {}
}
常用请求方法
在使用 axios 时，只要在当前操作窗体中 引用了 axios 后，都可以使用如下方法，
或者全局引入了 axios。
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]])
默认值配置
在程序请求中，肯定都有多个请求，而某些配置都是默认固定且相同的
全局的 请求配置项
因此可以设置全局的 请求配置项 默认值 例如
axios.defaults.baseURL = 'https://api.example.com'
axios.defaults.headers.common['token'] = AUTH_TOKEN
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8'
自定义实例默认值
// 创建实例时设置配置的默认值
var instance = axios.create({
baseURL: 'https://api.example.com',
})
// 在实例已创建后修改默认值
instance.defaults.headers.common['token'] = AUTH_TOKEN
配置的优先顺序
配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。
这里只是以超时时间(其它配置项一样的设置方式)写的一个例子：
// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create()
// 全局配置时 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500
// 在单个请求时 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
timeout: 5000,
})
拦截器
在请求或响应被 then 或 catch 处理前拦截它们。
// 添加请求拦截器
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)
}
)
如果你想在稍后移除拦截器，可以这样：
var myInterceptor = axios.interceptors.request.use(function () {
/*...*/
})
axios.interceptors.request.eject(myInterceptor)
可以为自定义 axios 实例添加拦截器
var instance = axios.create()
instance.interceptors.request.use(function () {
/*...*/
})
个人完整 axios 配置
新建一个文件夹 专门管理 axios 的全局默认配置 config.js 项如下：
下面的 baseUrl 可在 .env.production 和 .env.development 加对应参数，然后使用 process.env.baseUrl
需要特别注意的是 .env.production和.env.development文件 参数说明：
- NODE_ENV - 是 “development”、“production” 、"test"或者自定义的值。具体的值取决于应用运行的模式
- BASE_URL - 会和 vue.config.js 中的 publicPath 选项相符，即你的应用会部署到的基础路径
- 除了 NODEENV 和 BASE_URL，其他的环境变量必须以 VUE_APP 开头
- 项目中使用：process.env.环境变量名，eg：VUE_APP_BASE_URL
const urlMap = {
development: 'http://localhost:5000/',
production: '', //线上环境IP地址
}
const baseUrl = urlMap[process.env.NODE_ENV]
export default {
method: 'get',
// 基础url前缀
baseURL: baseUrl,
// 请求头信息
headers: {
'Content-Type': 'application/json;charset=UTF-8',
},
// 参数
data: {},
// 设置超时时间
timeout: 10000,
// 返回数据类型
responseType: 'json',
}
然后 新建 axios 的配置文件，axiosHttp.js。
import axios from 'axios'
import qs from 'qs'
import router from '@/router'
import config from './config'
axios.defaults.timeout = config.timeout
axios.defaults.headers = config.headers
axios.defaults.baseURL = config.baseURL
// 请求拦截器
axios.interceptors.request.use(
(config) => {
// 触发loading效果
//判断是否存在token,如果存在，则在header上加上token
// let token = getStore('token')
// if (token) {
// config.headers.common['token'] = token
// }
// if (config.method == 'post' || config.method == 'put') {
// //将数据转成string
// config.data = JSON.stringify(config.data)
// } else if (config.method == 'get') {
// //&& browser.isIE
// //给Get添加时间戳 解决IE缓存问题
// let symbol = config.url.indexOf('?') >= 0 ? '&' : '?'
// config.url += symbol + '_=' + Date.now()
// config.data = qs.stringify(config.data)
// }
return config
},
(err) => {
// 关闭loading
// 失败提示
return Promise.resolve(err)
}
)
// 响应拦截器
axios.interceptors.response.use(
(response) => {
// 关闭loading
if (!response || !response.data || !response.data.success) {
// 失败提示
} else if (response.data.data && response.data.code == 200) {
// 成功处理
}
if (response.data) {
switch (response.data.code) {
case 401:
// 返回 401 清除token信息并跳转到登录页面
// store.commit('LOGOUT')
setTimeout(function () {
router.replace({
path: '/login',
// 登录成功后跳入浏览的当前页面
// query: {redirect: router.currentRoute.fullPath}
})
}, 1500)
break
case 402:
//402无权限操作
// 提示
return new Promise(() => {}) //外部不会再处理
break
}
}
return response
},
(err) => {
// 关闭loading
// 提示异常
// return Promise.resolve(err);
//外部不会再处理
return new Promise(() => {})
}
)
export default {
Get(url, params = {}) {
return new Promise((resolve, reject) => {
axios
.get(url, { params })
.then((res) => {
resolve(res.data)
})
.catch((error) => {
reject(error)
//resolve(error)
})
})
},
Post(url, params = {}) {
return new Promise((resolve, reject) => {
axios
.post(url, params)
.then((res) => {
resolve(res.data)
})
.catch((error) => {
reject(error)
//resolve(error)
})
})
},
Delete(url, params = {}) {
return new Promise((resolve, reject) => {
axios
.delete(url, params)
.then((res) => {
resolve(res.data)
})
.catch((error) => {
reject(error)
//resolve(error)
})
})
},
Put(url, params = {}) {
return new Promise((resolve, reject) => {
axios
.put(url, params)
.then((res) => {
resolve(res.data)
})
.catch((error) => {
reject(error)
//resolve(error)
})
})
},
}
在各个模块引入 axiosHttp.js 文件，直接使用里面的方法，首字符大写。
在 api 文件中将各个模块引入，在 main.js 中将 api 全局挂载到 vue 的属性上。在页面上的调用则为 this.$api.methodName
原文地址：http://book.levy.net.cn/doc/frontend/axios.html
最新文章
- C# 利用NPOI 实现Excel转html
- SDL制作拼图游戏
- Linux以外的开源操作系统大汇总
- 理解JavaScript中的arguments,callee,caller,apply
- 前端之css、JavaScript和DOM
- QuickFIX/J常见问题汇总
- 默认选择radio的第一个
- Windows 8上强制Visual Studio以管理员身份运行
- java基础语法笔记
- Python 线程(threading) 进程(multiprocessing)
- Visual Studio自动添加头部注释 -C#开发2010-2013验证
- PID算法
- WebSocket就是这么简单
- MPI二维笛卡尔坐标划分【1】
- cobbler一键批量安装系统
- google 与服务器搭建
- 光伏电池测控系统python代码
- SpringMVC环境搭建和详解
- Java如何重置正则表达式的模式？
- MongoDB（课时24 全文索引）