Vue Composition API 怎么实现文件上传进度的监听与封装

夜明酱_2796

夜明酱_2796

2026-10-15

978人浏览

原创

核心原理是利用 XMLHttpRequest 的 upload.onprogress 事件监听上传进度,Fetch 不支持原生上传进度;封装 useUpload Hook 返回响应式状态和方法,基于 xhr 实现进度更新、中断、错误处理与 Promise 封装。

vue composition api 怎么实现文件上传进度的监听与封装

用 Composition API 监听文件上传进度的核心原理

浏览器原生 XMLHttpRequest 和 Fetch API 中,只有 XMLHttpRequest 支持上传过程的进度事件(upload.onprogress)。Fetch 本身不暴露上传进度,但可通过 ReadableStream + TransformStream 手动分块读取并上报进度——不过实际项目中更推荐封装基于 XMLHttpRequest 的可靠方案。

封装一个可复用的 useUpload Hook

目标:返回 upload 方法、progress(0–100 数值)、isUploading、error、response,支持中断、重试、自定义 headers。

  • 使用 ref 管理响应式状态(progress、isUploading 等)
  • 内部创建 XMLHttpRequest 实例,绑定 upload.onprogress 更新进度
  • 将 abort 暴露为函数,便于手动取消
  • 支持 Promise 风格调用,也支持 await / then 链式处理

示例代码(useUpload.js):

import { ref } from 'vue'
<p>export function useUpload() {
const progress = ref(0)
const isUploading = ref(false)
const error = ref(null)
const response = ref(null)
let xhr = null</p><p>const upload = (url, file, options = {}) => {
return new Promise((resolve, reject) => {
isUploading.value = true
error.value = null
progress.value = 0
response.value = null</p><pre class="brush:php;toolbar:false;">  xhr = new XMLHttpRequest()

  // 上传进度
  xhr.upload.onprogress = (e) => {
    if (e.lengthComputable) {
      progress.value = Math.round((e.loaded / e.total) * 100)
    }
  }

  // 完成
  xhr.onload = () => {
    if (xhr.status >= 200 && xhr.status  {
    error.value = new Error('Network error')
    reject(error.value)
  }

  // 超时
  xhr.ontimeout = () => {
    error.value = new Error('Request timeout')
    reject(error.value)
  }

  xhr.open('POST', url, true)
  xhr.timeout = options.timeout ?? 30000

  // 设置 headers(如 token)
  Object.entries(options.headers || {}).forEach(([k, v]) => {
    xhr.setRequestHeader(k, v)
  })

  // 构造 FormData
  const formData = new FormData()
  formData.append(options.fieldName || 'file', file)

  xhr.send(formData)
})

}

Ainative Vue Sdk
Ainative Vue Sdk

使用 `@ainative/vue-sdk` 为 Vue 3 应用添加 AI 聊天功能。适用于以下场景:(1) 安装 `@ainative/vue-sdk`,(2) 在 Vue 组件中使用 `useChat` 组合式函数,(3) 提供……

下载

const abort = () => { if (xhr && xhr.readyState !== XMLHttpRequest.DONE) { xhr.abort() isUploading.value = false progress.value = 0 } }

return { upload, abort, progress, isUploading, error, response } }

在组件中使用 useUpload

直接解构调用,无需关心底层细节:

<script setup>
import { useUpload } from './useUpload'
<p>const { upload, abort, progress, isUploading, error, response } = useUpload()<p>const handleFileChange = async (e) => {
const file = e.target.files?.[0]
if (!file) return<p>try {
await upload('/api/upload', file, {
headers: { Authorization: 'Bearer xxx' },
fieldName: 'avatar'
})
console.log('上传成功:', response.value)
} catch (err) {
console.error('上传失败:', err)
}
}
</script><p><template><input type="file"><div v-if="isUploading">上传中:{{ progress }}%</div>
<button v-if="isUploading">取消上传</button>
<div v-if="error">错误:{{ error.message }}</div>
</template></p>

进阶建议:支持多文件、断点续传与类型泛化

若需扩展能力,可在基础 hook 上叠加:

  • 添加 multiple: boolean 参数,内部遍历上传并合并进度(加权平均或按完成数)
  • 结合后端分片接口,用 File.slice() 分块上传,维护 chunk index 与校验逻辑
  • 用泛型约束 response 类型(配合 TypeScript),例如 useUpload<uploadresult>()</uploadresult>
  • 将上传配置(超时、重试次数、最大并发)抽为默认参数或全局配置项

不复杂但容易忽略:记得在组件卸载前调用 abort() 防止内存泄漏或状态错乱(可用 onBeforeUnmount 自动清理)。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vue.js vue

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2443

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5283

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6330

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5918

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

843

5

html5动画制作有哪些制作方法
html5动画制作有哪些制作方法

html5动画制作方法有使用CSS3动画、使用JavaScript动画库、使用HTML5 Canvas等。想了解更多html5动画制作方法相关内容,可以阅读本专题下面的文章。

2023.10.23

4031

6

HTML与HTML5的区别
HTML与HTML5的区别

HTML与HTML5的区别:1、html5支持矢量图形,html本身不支持;2、html5中可临时存储数据,html不行;3、html5新增了许多控件;4、html本身不支持音频和视频,html5支持;5、html无法处理不准确的语法,html5能够处理等等。想了解更多HTML与HTML5的相关内容,可以阅读本专题下面的文章。

2024.03.06

6928

6

html5从入门到精通汇总
html5从入门到精通汇总

想系统掌握HTML5开发?本合集精选全网优质学习资源,涵盖免费教程、实战项目、视频课程与权威电子书,从基础语法到高级特性(Canvas、本地存储、响应式布局等)一应俱全,适合零基础小白到进阶开发者,助你高效入门并精通HTML5前端开发。

2025.12.30

814

19

html5新老标签汇总
html5新老标签汇总

HTML5在2026年持续优化网页语义化与交互体验,不仅引入了如<header>、<nav>、<article>、<section>、<aside>、<footer>等结构化标签,还新增了<video>、<audio>、<canvas>、<figure>、<time>、<mark>等增强多媒体与

2025.12.30

694

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17.1万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习