功能问题:如何实现文件的拖拽上传?

大家好,我是大澈!

本文约1900+字,整篇阅读大约需要5分钟。

感谢关注微信公众号:"程序员大澈",免费领取"面试礼包"一份,然后免费加入问答群,从此让解决问题的你不再孤单!

1. 需求分析

文件上传,可以说是我们在项目中最常用的功能之一。

文件上传一般有两种形式:点击上传和拖拽上传。而上传的内容,又大体包括:文件和文件夹。

在项目中,我们一般都会直接选择使用UI库提供的上传组件,简单配置一下必要的属性,就实现了文件上传功能,至于组件底层实现的原理,是丝毫不知。

所以今天,针对文件和文件夹的拖拽上传功能,我整理了一下具体的实现,很简单一起瞧瞧。

2. 问题实现

先普及一下元素拖拽的几个API知识点,再放上文件拖拽上传的实现代码,并做简单的描述,最后做小结。

2.1 拖拽的6个API

元素拖拽的6个API分别是:dragenter、dragover、drop 以及 dragstart、drag、dragend。

ondragstart 事件:该事件在拖动操作开始时触发,即拖动操作的起点。通常在该事件的处理函数中设置拖动的数据和效果。

drag 事件:该事件在元素正在被拖动时持续触发,即在拖动过程中。可以在该事件的处理函数中执行一些实时的操作,例如更新元素的位置或显示一些效果。

dragend 事件:该事件在拖动操作结束时触发,即拖动操作的终点。通常在该事件的处理函数中执行一些清理操作或其他逻辑。

这三个事件通常用于控制拖动元素起始、过程和结束阶段的行为。

ondragenter 事件:该事件在拖动元素进入目标元素的范围时触发。可以在该事件的处理函数中执行一些显示效果或状态改变等操作。

ondragover 事件:该事件在拖动元素在目标元素上移动时持续触发,即在拖动元素在目标元素上悬停期间。通常需要阻止默认的拖放行为,以便允许在目标元素上释放。

ondrop 事件:该事件在拖动元素在目标元素上释放时触发。可以在该事件的处理函数中获取拖动的数据并执行相应的操作。

这三个事件通常用于控制目标元素在接受拖动元素时的行为。

2.2 文件拖拽上传实现

元素拖拽的6个API,这里我们只需要使用dragoverdrop这两个,就能实现文件拖拽上传。

下面简单描述一下实现过程,具体细节大家看代码就好,原理很简单。

先获取页面中的 DropFrame 元素,再为其添加两个事件监听器。

dragover 事件监听器:当有元素拖拽到 DropFrame 区域时触发,用于指定拖放操作的效果。这里必须阻止事件默认行为,否则文件是拖不上去的,会被浏览器所阻止。

drop 事件监听器:当在 DropFrame 区域释放拖拽的元素时触发,用于处理拖放完成后的操作。内部通过遍历 e.dataTransfer.items ,判断文件或文件夹,文件就直接获取File对象,文件夹则递归获取内部文件的File对象,最后依次单独上传服务器。

完整实现代码如下,复制即可使用。

HTML 复制代码
<!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>

2.3 小结

本文简单介绍了,元素拖拽的6个API,以及文件拖拽上传的实现过程。

元素拖拽的6个API,这里我们只需要使用dragoverdrop这两个,就能实现文件拖拽上传。

值得注意的是,必须阻止事件默认行为,否则文件是拖不上去的,会被浏览器所阻止。

结语

建立这个平台的初衷:

  • 打造一个专注于前端功能问题的问答平台,让大家高效搜索处理同样问题。
  • 遇到有共鸣的问题,与众多同行朋友们一起讨论,一起沉淀成长。
  • 平台现拥有功能问题、技术资讯、实用干货3个专栏内容。

感谢关注微信公众号:"程序员大澈",免费领取"面试礼包"一份,然后免费加入问答群,从此让解决问题的你不再孤单!

相关推荐
四喜花露水21 分钟前
Vue 自定义icon组件封装SVG图标
前端·javascript·vue.js
前端Hardy30 分钟前
HTML&CSS: 实现可爱的冰墩墩
前端·javascript·css·html·css3
web Rookie1 小时前
JS类型检测大全:从零基础到高级应用
开发语言·前端·javascript
Au_ust1 小时前
css:基础
前端·css
帅帅哥的兜兜1 小时前
css基础:底部固定,导航栏浮动在顶部
前端·css·css3
工业甲酰苯胺1 小时前
C# 单例模式的多种实现
javascript·单例模式·c#
就是个名称1 小时前
购物车-多元素组合动画css
前端·css
程序员爱技术5 小时前
Vue 2 + JavaScript + vue-count-to 集成案例
前端·javascript·vue.js
并不会6 小时前
常见 CSS 选择器用法
前端·css·学习·html·前端开发·css选择器
悦涵仙子6 小时前
CSS中的变量应用——:root,Sass变量,JavaScript中使用Sass变量
javascript·css·sass