H5拖放異步文件上傳之二——上傳進度監聽

時間  2019-12-04
標籤 h5 拖放 異步 文件 上傳 之二 進度 監聽 简体版
原文   原文鏈接

  上一篇《H5拖放+FormData接口+NodeJS，完整異步文件上傳（一）》，咱們走通了拖放文件上傳的整個流程，但離實際使用場景還有差距。這篇，咱們來添加幾個實際使用場景必要的功能，向實際使用再走一步。html

添加功能

  1. 顯示待上傳文件列表;
  2. 支持移除待上傳文件;
  3. 使用upload.onprogress顯示上傳進度;
  4. 支持中斷上傳;

upload.progress

XMLHttpRequest.upload方法返回一個 XMLHttpRequestUpload對象，用來表示上傳的進度。這個對象是不透明的，可是做爲一個XMLHttpRequestEventTarget，能夠經過對其綁定事件來追蹤它的進度。onprogres監聽數據傳輸進行中(經過監聽這個事件，可得到上傳進度)。 摘自MDN

實現思路

  拖放文件到上傳區域時，將文件保存在一個文件數組中，添加並顯示文件相關信息和移除按鈕，點擊移除按鈕刪除文件數組中對應的文件元素，點擊上傳按鈕，遍歷文件數組，開始上傳待上傳文件，此時點擊移除按鈕則停止文件上傳。git

代碼

//相關樣式
.drop-area{
    margin:auto;
    width: 500px;
    height: 500px;
    border:1px pink dashed;
}
.close-btn{
    cursor: pointer;
}
.close-btn:after{
    float: right;
    content: 'X';
    color: red;
}
#fileList{
    width: 95%;
}
.process-bar{
    position: relative;
    margin: 0 10px 0 10px;
    width: 198px;
    height: 18px;
    display: none;
    text-align: center;
    line-height: 20px;
    color: #6dbfff;
    border-radius: 3px;
    border: 1px solid #1483d8;    
    background: #fff;
}
.success .process-bar,
.uploading .process-bar{
    display: inline-block;
}
.process-bar .process-text{
    position: relative;
    z-index: 1;
}
.process-bar .process-rate{
       position: absolute;
    width: 0;
    height: 100%;
       left: 0;
      top: 0;
      border-radius: 3px;
    background: #1483d8;
}
.file-list .success .process-text,
.file-list .success .close-btn:after,
.file-list .error .process-text,
.file-list .error .close-btn:after{
    display: none;
}
 .success .process-bar :after,
.error .process-bar :after{
    content:'success';
    position: absolute;    
    margin: auto;
    left: 0;
    right: 0;
    z-index: 2;
}
.error .process-bar:after{
    content: "error";
    color: red;
}
<!--HTML-->
<div class="drop-area"  ondrop="drop_hander(event)" ondragover = "dragover_hander(event)"></div><!--監聽拖放DOM-->
<div id="fileList" class="file-list"></div><!--顯示待上傳文件列表-->
<button id="submit">上傳</button><!--上傳按鈕-->
//Javascript代碼
let filesSet = []; //文件保存數組
let fileList = document.getElementById('fileList'); //獲取顯示文件列表DOM

/**
 * 建立一個新的空白的文檔片斷frag
 * 用於附加多個待上傳文件的DOM,可減少迴流
 * https://developer.mozilla.org/zh-CN/docs/Web/API/Document/createDocumentFragment
 */
let frag = document.createDocumentFragment();
let barDom = createProccessBar(); //建立進度條DOM
let submit = document.getElementById("submit") //獲取提交按鈕


/* 拖動到放置區域時 */
function dragover_hander (event) {
    /* 必須同時阻止dragover和drop的默認事件
       不然會響應瀏覽器默認行爲
       瀏覽器器能顯示的文件會直接顯示，例如html文件、圖片文件
       瀏覽器器不能顯示的文件會出現文件下載彈窗
    */
    event.preventDefault(); 
}

/*拖放完成事件*/
function drop_hander (event) {

    event.preventDefault(); //阻止默認事件

    var files = event.dataTransfer.files; //經過dataTransfer對象獲取文件對象數組

    for(let file of files) { //遍歷文件對象數組

       //建立文件信息顯示DOM,並保存在file對象的element屬性中，用於後續操做
       file.element = createFileDom(file, filesSet.length)
       //複製進度條DOM,並保存在file對象的processBar屬性中，用於後續操做
       file.processBar = filesSet.length?barDom.cloneNode(true):barDom;
       //將進度條添加至文件信息顯示DOM中
       file.element.appendChild(file.processBar);
       //file文件對象添加到文件保存數組
       filesSet.push(file);
       //建立文件信息顯示DOM添加至文檔片斷frag
       frag.appendChild(file.element);
    }

    //將文件列表添加至顯示文件列表的div
    fileList.appendChild(frag)
}


/**
 * 建立文件信息顯示DOM
 * file  文件對象，用於獲取文件信息
 * index 文件對象在數組中的索引，用於刪除
 */
function createFileDom (file, index) {
    let p = document.createElement('p'); 
    //file.name屬性能夠得到文件名稱
    //有興趣的童鞋，可使用for...in循環查看一下file對象的其它屬性值
    let text = document.createTextNode(file.name); 
    let span = document.createElement("span");
    span.setAttribute('index', index); //索引添加至按鈕的index屬性
    span.className = 'close-btn'; 
    p.appendChild(text);
    p.appendChild(span);

    return p; //返回文件信息顯示DOM
}
/**
 * 建立進度條DOM,
 * 進度條DOM結構固定，可以使用clone(true)進行復制
 * @return {[type]} [description]
 */
function createProccessBar() {
    let bar =  document.createElement("span");
    let rate = document.createElement("span");
    let text = document.createElement("span");
    bar.className = "process-bar";
    rate.className = "process-rate";
    text.className = "process-text";
    text.innerText="0%";
    bar.appendChild(text);
    bar.appendChild(rate);
    return bar; 
} 

//經過事件代理，監聽移除或停止上傳
fileList.addEventListener('click', (evt)=>{
    let index = evt.target.getAttribute('index'); //得到index屬性值
    if (index) { //存在index屬性值，表示點擊了刪除按鈕

        if (filesSet[index].unloading && filesSet[index].req) { //文件已經上傳中
            filesSet[index].req.abort(); //停止上傳
            filesSet[index].unloading = false;    //將上傳中的狀態設置爲false    
        } else { //未開始上傳
            filesSet[index].element.remove(); //移除DOM
            filesSet[index].element = null; //釋放對DOM的引用
            filesSet[index].processBar = null;//釋放對DOM的引用
            delete filesSet[index];//刪除文件數組中對應的元素    
        }

    }
})

submit.addEventListener('click',function(){// 爲上傳按鈕綁定事件

    //這裏使用for...in循環,正好能夠避免對數組稀疏元素的遍歷
    for(let key in filesSet){
        //若是正在上傳中或已經上傳完成，再也不上傳
        if (filesSet[key].unloading || filesSet[key].uploaded) continue; 
        filesSet[key].unloading = true; //標記開始上傳

        //建立一個文件上傳的Promise，並設置成功及失敗的回調
        initUpload(filesSet[key]).then(file => {
            //上傳成功
            file.element.className = "success"; //UI顯示成功信息
            file.uploaded = true; //標記上傳成功
        }).catch((file, err) => {
            file.element.className = "error"; //UI顯示失敗信息
            //取消開始上傳標記，點擊上傳按鈕將嘗試再次上傳
            filesSet[key].unloading = false; 
        })
    }
})

/**
 * 返回一個文件上傳的Promise實例
 * @param  {[type]} file 要上傳的文件
 */
function initUpload(file){

    return new Promise((res, rej) => {
        let formData = new FormData();//聲明一個FormData實例
        let req = new XMLHttpRequest();//建立XHR實例
        let reta = file.processBar.querySelector('.process-rate');//得到進度條DOM
        let text = file.processBar.querySelector('.process-text');//得到進度文本DOM
        let pre;//保存上傳百分比
        //監聽數據傳輸進行中
        req.upload.onprogress =function(data){ 
            pre = (data.loaded/data.total*100).toFixed(2);//計算百分比
            reta.style.width = pre +'%';//修改進度條
            text.innerText = pre +'%' ;//修改進度條文本
        }
        //監聽請求完成
        req.onreadystatechange = function () {
            if (req.readyState !==4 ) return ; 
            if (req.status === 200 ){
                //完成，執行成功回調
                res(file, req)
            } else {
                //失敗，執行失敗回調
                rej(file, req)
            }
        }
        formData.append('file',file); //使用append方法添加文件到file鍵
        req.open('POST', '/process_post'); //初始化請求
        req.send(formData); //發送請求
        file.req = req; //保存req對象，用於停止請求
        //形如顯示上傳進度
        file.element.className = "uploading"                
    })
}

  到這裏代碼就結束了，完整代碼能夠查看Github。由於是本地上傳，在測試的時候可使用大一些的文件，或者限制一下上傳。github

結束語

  這些新的API，使得文件拖放上傳變得簡單起來。惋惜低版本的IE並不支持，據說低版本的IE可使用Falsh來進行文件上傳，具體是如何實現的，要不咱們下篇再來探討一下。
  
  segmentfault

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程