1. 需求分析
文件上传,可以说是我们在项目中最常用的功能之一。
文件上传一般有两种形式:点击上传和拖拽上传。而上传的内容,又大体包括:文件和文件夹。
在项目中,我们一般都会直接选择使用UI库提供的上传组件,简单配置一下必要的属性,就实现了文件上传功能,至于组件底层实现的原理,是丝毫不知。
所以今天,针对文件和文件夹的拖拽上传功能,我整理了一下具体的实现,很简单一起瞧瞧。
2. 问题实现
先普及一下元素拖拽的几个API知识点,再放上文件拖拽上传的实现代码,并做简单的描述,最后做小结。
(1)拖拽的6个API
元素拖拽的6个API分别是:dragenter、dragover、drop 以及dragstart、drag、dragend。
ondragstart 事件:该事件在拖动操作开始时触发,即拖动操作的起点。通常在该事件的处理函数中设置拖动的数据和效果。
drag 事件:该事件在元素正在被拖动时持续触发,即在拖动过程中。可以在该事件的处理函数中执行一些实时的操作,例如更新元素的位置或显示一些效果。
dragend 事件:该事件在拖动操作结束时触发,即拖动操作的终点。通常在该事件的处理函数中执行一些清理操作或其他逻辑。
这三个事件通常用于控制拖动元素起始、过程和结束阶段的行为。
ondragenter 事件:该事件在拖动元素进入目标元素的范围时触发。可以在该事件的处理函数中执行一些显示效果或状态改变等操作。
ondragover 事件:该事件在拖动元素在目标元素上移动时持续触发,即在拖动元素在目标元素上悬停期间。通常需要阻止默认的拖放行为,以便允许在目标元素上释放。
ondrop 事件:该事件在拖动元素在目标元素上释放时触发。可以在该事件的处理函数中获取拖动的数据并执行相应的操作。
这三个事件通常用于控制目标元素在接受拖动元素时的行为。
(2)文件拖拽上传实现
元素拖拽的6个API,这里我们只需要使用dragover、drop这两个,就能实现文件拖拽上传。
下面简单描述一下实现过程,具体细节大家看代码就好,原理很简单。
先获取页面中的 DropFrame 元素,再为其添加两个事件监听器。
dragover 事件监听器:当有元素拖拽到 DropFrame 区域时触发,用于指定拖放操作的效果。这里必须阻止事件默认行为,否则文件是拖不上去的,会被浏览器所阻止。
drop 事件监听器:当在 DropFrame 区域释放拖拽的元素时触发,用于处理拖放完成后的操作。内部通过遍历e.dataTransfer.items ,判断文件或文件夹,文件就直接获取File对象,文件夹则递归获取内部文件的File对象,最后依次单独上传服务器。
完整实现代码如下,复制即可使用。
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title></title>
<style>
#DropFrame {
width: 360px;
height: 120px;
background-color: #b8deff;
border: solid 1px #3470ff;
}
</style>
</head>
<body>
<!-- 拖拽区域 -->
<div id="DropFrame">文件拖到这里上传</div>
</body>
<script>
let dropFrame = document.getElementById('DropFrame');
// 拖动元素在目标元素上悬停期间
dropFrame.addEventListener('dragover', (e) => {
// 阻止默认事件和冒泡 必须写
e.stopPropagation();
e.preventDefault();
});
// 拖动元素在目标元素上释放时触发
dropFrame.addEventListener('drop', (e) => {
// 阻止默认事件和冒泡 必须写
e.stopPropagation();
e.preventDefault();
// 文件上传处理逻辑
let items = e.dataTransfer.items;
for (const item of items) {
// 提取Entry对象
const entry = item.webkitGetAsEntry();
if (entry.isFile) {
// 处理文件,拿到File文件
entry.file((file) => {
console.log(file, 'file');
// 上传文件到服务器
// var formData = new FormData();
// formData.append('file', file);
// axios.post('/upload', formData, {})
})
} else {
// 处理文件夹,拿到FileEntry对象
const reader = entry.createReader()
reader.readEntries((entries) => {
reHandleFile(entries)
})
}
}
});
// 如果文件夹是多级,则递归读取
const reHandleFile = (entries) => {
for (const entry of entries) {
if (entry.isFile) {
// 处理文件,拿到File文件
entry.file((file) => {
console.log(file, 'file');
// 上传文件到服务器
// var formData = new FormData();
// formData.append('file', file);
// axios.post('/upload', formData, {})
})
} else {
// 处理文件夹,拿到FileEntry对象
const reader = entry.createReader()
reader.readEntries((entries) => {
// 递归
reHandleFile(entries)
})
}
}
}
</script>
</html>
小结
本文简单介绍了,元素拖拽的6个API,以及文件拖拽上传的实现过程。
元素拖拽的6个API,这里我们只需要使用dragover、drop这两个,就能实现文件拖拽上传。
值得注意的是,必须阻止事件默认行为,否则文件是拖不上去的,会被浏览器所阻止。