3分钟教你用原生js实现具有进度监听的文件上传预览组件

徐小夕 等级 311 0 0

本文主要介绍如何使用原生js,通过面向对象的方式实现一个文件上传预览的组件,该组件利用FileReader来实现文件在前端的解析,预览,读取进度等功能,并对外暴露相应api来实现用户自定义的需求,比如文件上传,进度监听,自定义样式,读取成功回调等。

组件设计架构如下:

3分钟教你用原生js实现具有进度监听的文件上传预览组件

涉及的核心知识点如下:

  1. 闭包:减少变量污染,缩短变量查找范围
  2. 自执行函数
  3. file API:对文件进行读取,解析,监控文件事件
  4. DocumentFragment API:主要用来优化dom操作
  5. minix :用来实现对象混合
  6. 正则表达式:匹配文件类型
  7. class :类组件

github地址

用原生js实现具有进度监听的文件上传预览组件

Demo演示

3分钟教你用原生js实现具有进度监听的文件上传预览组件

3分钟教你用原生js实现具有进度监听的文件上传预览组件

3分钟教你用原生js实现具有进度监听的文件上传预览组件

3分钟教你用原生js实现具有进度监听的文件上传预览组件

使用:

<div id="test"></div>
<script src="./js/xjFile.js"></script>
<script>
    new xjFile({
        el: '#test', // 不填则直接默认挂在body上
        accept: 'image/png', // 可选
        clsName: 'xj-wrap', // 可选
        beforeUpload: function(e) { console.log(e) }, // 可选
        onProgress: function(e) { console.log(e) }, // 可选
        onLoad: function(e) { console.log(e) }, // 可选
        onError: function(e) { console.error('文件读取错误', e) } // 可选
    });
</script>

css代码:

.xj-wrap {
            position: relative;
            display: inline-block;
            border: 1px dashed #888;
            width: 200px;
            height: 200px;
            border-radius: 6px;
            overflow: hidden;
        }
        .xj-wrap::before {
            content: '+';
            font-size: 36px;
            position: absolute;
            transform: translate(-50%, -50%);
            left: 50%;
            top: 50%;
            color: #ccc;
        }
        .xj-wrap .xj-pre-img {
            width: 100%;
            height: 100%;
            background-repeat: no-repeat;
            background-position: center center;
            background-size: 100%;
        }
        .xj-file {
            position: absolute;
            left: 0;
            right: 0;
            bottom: 0;
            top: 0;
            opacity: 0;
            cursor: pointer;
        }

js代码:

(function(win, doc){
    function xjFile(opt) {
        var defaultOption = {
            el: doc.body,
            accept: '*', // 格式按照'image/jpg,image/gif'传
            clsName: 'xj-wrap',
            beforeUpload: function(e) { console.log(e) },
            onProgress: function(e) { console.log(e) },
            onLoad: function(e) { console.log(e) },
            onError: function(e) { console.error('文件读取错误', e) }
        };

        // 获取dom
        if(opt.el) {
            opt.el = typeof opt.el === 'object' ? opt.el : document.querySelector(opt.el);
        }

        this.opt = minix(defaultOption, opt);
        this.value = '';
        this.init();
    }

    xjFile.prototype.init = function() {
        this.render();
        this.watch();
    }

    xjFile.prototype.render = function() {
        var fragment = document.createDocumentFragment(),
            file = document.createElement('input'),
            imgBox = document.createElement('div');
        file.type = 'file';
        file.accept = this.opt.accept || '*';
        file.className = 'xj-file';
        imgBox.className = 'xj-pre-img';
        // 插入fragment
        fragment.appendChild(file);
        fragment.appendChild(imgBox);
        // 给包裹组件设置class
        this.opt.el.className = this.opt.clsName;
        this.opt.el.appendChild(fragment);
    }

    xjFile.prototype.watch = function() {
        var ipt = this.opt.el.querySelector('.xj-file');
        var _this = this;
        ipt.addEventListener('change', (e) => {
            var file = ipt.files[0];

            // 给组件赋值
            _this.value = file;

            var fileReader = new FileReader();

            // 读取文件开始时触发
            fileReader.onloadstart = function(e) {
                if(_this.opt.accept !== '*' && _this.opt.accept.indexOf(file.type.toLowerCase()) === -1) {
                    fileReader.abort();
                    _this.opt.beforeUpload(file, e);
                    console.error('文件格式有误', file.type.toLowerCase());
                }
            }

            // 读取完成触发的事件
            fileReader.onload = (e) => {
                var imgBox = this.opt.el.querySelector('.xj-pre-img');
                if(isImage(file.type)) {
                    imgBox.innerHTML = '';
                    imgBox.style.backgroundImage = 'url(' + fileReader.result + ')';
                } else {
                    imgBox.innerHTML = fileReader.result;
                }

                imgBox.title = file.name;

                this.opt.onLoad(e);
            }

            // 文件读取出错事件
            fileReader.onerror = (e) => {
                this.opt.onError(e);
            }

            // 文件读取进度事件
            fileReader.onprogress = (e) => {
                this.opt.onProgress(e);
            }

            isImage(file.type) ? fileReader.readAsDataURL(file) : fileReader.readAsText(file);

        }, false);
    }

    // 清除ipt和组件的值,支持链式调用
    xjFile.prototype.clearFile = function() {
        this.opt.el.querySelector('.xj-file').value = '';
        this.value = '';
        return this
    }

    // 简单对象混合
    function minix(source, target) {
        for(var key in target) {
            source[key] = target[key];
        }
        return source
    }

    // 检测图片类型
    function isImage(type) {
        var reg = /(image\/jpeg|image\/jpg|image\/gif|image\/png)/gi;
        return reg.test(type)
    }

    // 将方法挂载到window上
    win.xjFile = xjFile;

})(window, document);

class版(后期规划)

class版的也很简单,大致框架如下,感兴趣的朋友可以实现一下呦~

class XjFile {
    constructor(opt) {

    }

    init() {

    }

    watch() {

    }

    render() {

    }

    clearFile() {

    }

    minix(source, target) {

    }

    isImage(type) {

    }
}

总结

该组件仍有需要完善的地方,在后期使用中,会慢慢更新,优化,欢迎大家提出宝贵的建议。

更多推荐

最后,更多技术优质文章,技术资料,欢迎关注《趣谈前端》

收藏
评论区

相关推荐

JavaScript 引擎、事件循环、任务队列
一、先引用别人的一幅图 (很好的概括了JS主线程和任务队列是如何执行的) 1.JS引擎和runtime的区别: 引擎:解释并编译代码,让它变成
😎手撕吊打面试官系列面试题
js基础 1. 用js打印一个乘法表 这一题面试官考察的是你关于js的打印相关基础api的熟悉程度,以及基本的数学常识,送分题 console.log( 111 212 224 313 326 339 414 428 4312 4416 515 5210 5315 5420 5525
项目实战之---AES 加密
ajax/index.js import axiosApi from '../js/fetch'; import { baseUrl, headerParams } from '../js/baseUrl'; // import引用AES源码js import CryptoJS from 'cryptojs/cryptojs'; console.lo
面试之手撕 JS 继承
提到JS继承,你首先想到的什么? 面试 继承方式 优缺点...,js继承作为曾经的苦主,我看了忘,忘了看,看了又忘,OMG,都0212年了面试官还不放过我。 ok
大佬说:“不想加班你就背会这 10 条 JS 技巧”
(https://imghelloworld.osscnbeijing.aliyuncs.com/83909ede68f61936ac3ae10c9ce8b223.png) 为了让自己写的代码更优雅且高效,特意向大佬请教了这 10 条 JS 技巧 1\. 数组分割 const listChunk (list
几个常用js库,别再重复造轮子了
年底了,总结下今年用到的一些有意思的《js轮子》(只是大概列出些比较有意思的库,每个标题都是超链接,可点击自行查阅) 希望能对您有用! 如有意思的 轮子 可以在评论列出一起讨论下 color(https://links.jianshu.com/go?tohttps%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fco
js异步的5种样式
js异步的5种样式 1.定时器 2.AJAX 3.Promise 4.Generator 5.asyns和awite  1.定时器     setTimeout() : 延时器        可以传入三个分别是            1)code:必
js去除字符串
js去除字符串js<DOCTYPE html<html<head <title</title</head<body</body<script type"text/javascript" function delHtmlTag(str){   return str.replace(/<^/g,""); } var s
js删除表格中的某一行
点击表格中的内容,删除某一行正文js代码如下 function removeTd(obj) { obj.parentNode.parentNode.remove();}
日常必备的JS工具函数大全
为元素添加on方法 Element.prototype.on Element.prototype.addEventListener; NodeList.prototype.on function (event, fn) 、 []['forEach'].call(this, function (el) el.on(ev
只听说过CSS in JS,怎么还有JS in CSS?
CSS in JS是一种解决css问题想法的集合,而不是一个指定的库。从CSS in JS的字面意思可以看出,它是将css样式写在JavaScript文件中,而不需要独立出.css、.less之类的文件。将css放在js中使我们更方便的使用js的变量、模块化、treeshaking。还解决了css中的一些问题,譬如:更方便解决基于状态的样式,更容易追溯依赖关
天哪!几行js代码就可以实现拳皇小游戏
前言今天,我们用原生JS实现一个拳皇人物位置控制的小效果。话不多说,我们赶紧来看下如何实现吧!效果(非静止八神)分别按W、S、A、D键可实现位置移动,并且效果真实。源码html与css很简单,主要是js中有几点需要注意的。<!DOCTYPE html <html lang"en" <head  <meta charset"UTF8"  <title游
这些JS工具函数够你用到2020年底了
前言活不多说,自己平时搜集的干货函数奉上。干货函数 找出数字在数组中下一个相邻的元素let i  ""; let rr  []; const name  (n, arr1)     let num  Number(n);     for (let i  0; i < arr1.length; i++)          const elemen
你不可不知的JS面试题(第三期)
1、什么是闭包?如图所示,闭包就是一个定义在函数内部的函数,其作用是将函数内部和函数外部连接起来。大家知道,作用域的问题,就是在函数内部定义的变量称为局部变量,外部取不到值。下面我们通过代码来更加详细地看一下: function A()        let x  1;        return function B()            c
前端 - 常见的异常捕获方法
前端异常捕获在ES3之前js代码执行的过程中,一旦出现错误,整个js代码都会停止执行,这样就显的代码非常的不健壮。从ES3开始,js也提供了类似的异常处理机制,从而让js代码变的更健壮,程序执行的过程中出现了异常,也可以让程序具有了一部分的异常恢复能力。js异常的特点是,出现不会导致JS引擎崩溃,最多只会终止当前执行的任务。回归正题,我们该如何在程序异常发生