JavaScript中的FileReader範例詳解

2022-03-05 13:00:18

前言：

FileReader是一種非同步檔案讀取機制，結合input:file可以很方便的讀取本地檔案。

input:file

在介紹FileReader之前，先簡單介紹input的file型別。

<input type="file" id="file">

input的file型別會渲染為一個按鈕和一段文字。點選按鈕可開啟檔案選擇視窗，文字表示對檔案的描述（大部分情況下為檔名）；file型別的input會有files屬性，儲存著檔案的相關資訊。

document.querySelector('#file').addEventListener('change',(fileChoosed) => {
    console.log('fileChoosed', fileChoosed.target.files)    
})

點選按鈕上傳一個檔案後，在控制檯列印上傳的檔案資訊，如下：

可以發現檔案資訊是一個json物件，由傳入的file物件組成。每個file物件（即每個上傳檔案）包含以下屬性：

lastModified：數值，表示最近一次修改時間的毫秒數；

lastModifiedDate：物件，表示最近一次修改時間的Date物件；

name：本地檔案系統中的檔名；

size：檔案的位元組大小；

type：字串，檔案的MIME型別；

webkitRelativePath：此處為空；當在input上加上webkitdirectory屬性時，使用者可選擇資料夾，此時webkitRelativePath表示資料夾中檔案的相對路徑。

<input type="file" id="file" webkitdirectory>

FileReader

以上file物件只獲取到了對檔案的描述資訊，但沒有獲得檔案中的資料。我們可以通過html5提供的FileReader讀取到檔案中的資料。

首先建立一個FileReader範例：

const reader = new FileReader();

FileReader提供瞭如下方法：

readAsArrayBuffer(file)

按位元組讀取檔案內容，結果用ArrayBuffer物件表示

readAsBinaryString(file)

按位元組讀取檔案內容，結果為檔案的二進位制串

readAsDataURL(file)

讀取檔案內容，結果用data:url的字串形式表示

readAsText(file,encoding)

按字元讀取檔案內容，結果用字串形式表示

abort()

終止檔案讀取操作

readAsDataURL和readAsText較為常用，這裡只對這兩者進行說明。

readAsDataURL會將檔案內容進行base64編碼後輸出：

document.querySelector('#file').addEventListener('change',(fileChoosed) => {
   const reader = new FileReader();
   reader.readAsDataURL(fileChoosed.target.files[0]);//發起非同步請求
   reader.onload = function(readRes){
       console.log('載入完成', readRes.target.result)
   }          
})

控制檯為當前所傳檔案的base64編碼表示。由於媒體檔案的src屬性，可以通過採用網路地址或base64的方式顯示，因此我們可以利用readAsDataURL實現對圖片的預覽。
如下，只需將讀取的結果賦給圖片的src屬性，即可預覽圖片：

<input type="file" id="file" />
<img src="" id="imgPreview">

document.querySelector('#file').addEventListener('change',(fileChoosed) => {
    const reader = new FileReader();
    reader.readAsDataURL(fileChoosed.target.files[0]);//發起非同步請求
    reader.onload = function(readRes){
        document.querySelector('#imgPreview').src = readRes.target.result
    }           
})

readAsText可按指定編碼方式讀取檔案，但讀取檔案的單位是字元，故對於文字檔案，只要按規定的編碼方式讀取即可；而對於媒體檔案（圖片、音訊、視訊），其內部組成並不是按字元排列，故採用readAsText讀取，會產生亂碼。

FileReader事件：

onloadstart 當讀取操作開始時呼叫
onprogress 在讀取資料過程中週期性呼叫
onabort 當讀取操作被中止時呼叫
onerror 當讀取操作發生錯誤時呼叫
onload 當讀取操作成功完成時呼叫
onloadend 當讀取操作完成時呼叫，無論成功，失敗或取消

註釋：

每過50ms左右，就會觸發一次progress事件，對於較大的檔案可以利用progress實現進度條；
由於種種原因無法讀取檔案時，會觸發error事件。觸發error事件時，相關資訊儲存在FileReader物件的error屬性中，這個屬性將儲存一個物件，此物件只有一個屬性code，即錯誤碼。1表示未找到檔案，2表示安全性錯誤，3表示讀取中斷，4表示檔案不可讀，5表示編碼錯誤。

範例：

<input type="file" id="file" />

document.querySelector('#file').addEventListener('change',(fileChoosed) => {
    const reader = new FileReader();
    reader.readAsText(fileChoosed.target.files[0],'utf-8');//發起非同步請求
    reader.onloadstart = function(readRes){
        // 檔案大於500kb則取消載入
        if(readRes.total > 1024*500) {            
            reader.abort()
        } else {
            console.log("開始載入")
        }
    }
    reader.onabort = function (readRes) {
        console.log('載入已取消')
    }
    reader.onprogress = function(readRes){
        console.log("載入中", `${(readRes.loaded / readRes.total).toFixed(2)*100}/100`)
    }

補充：一個比較全面的例子

實現的功能:

通過file控制元件預覽文字, 圖片
非文字, 圖片的以二進位制串輸出
拖拽上述檔案實現預覽

包含的知識點:

readAsText方法的使用
readAsDataURL方法的使用
readAsBinaryString方法的使用
一些Promise的用法也穿插其中
簡單的拖拽用法

為了方便觀看, 這裡也把程式碼帖上:

<!DOCTYPE html>
<html lang="zh-CN">

<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>FileReader Learning</title>
</head>

<body>
  <div class="container">
    <form novalidate>
      <div class="avatars-row" style="margin: 10px;">
        <label>選擇檔案: 
          <input type="file" name="avatars" id="attachment" accept="*/*" multiple></input>
        </label>
      </div>
      <div class="result" id="result" style="overflow: auto; border: 1px solid cyan; height: 300px;"></div>
    </form>
  </div>
  <script>
    (function (window, doc, undefined) {

      function $(id) {
        return doc.getElementById(id);
      }

      let App = {
        createFileReader: () => {
          if (typeof FileReader === "undefined") {
            throw new Error("FileReader is not avaliable");
          }

          return new FileReader();
        },

        /**
         * @return FileList
         */
        getFiles: () => {
          var attachment = $("attachment"),
            files = attachment.files;

          return files || new Error("no file uploaded");
        },
        /**
         * 統一的讀取介面
         */
        read: function(api, file, callback) {
          let self = this;
          return new Promise((resolve, reject) => {
            let reader = self.createFileReader();
            reader.onload = e => {
              resolve(e.target.result);
            };

            reader.onerror = e => {
              reject("read error");
            };

            reader.onabort = e => {
              reject("abort error");
            };

            // size <= 1M
            if (file && file.size > 1 * 1024 * 1024) {
              reject('file is too large');
              return;
            }

            reader[api](file);
          });
        },
        onFileChange: function(callback) {
          let self = this;
          $("attachment").onchange = function (e) {
            callback(self.getFiles());
          };
        },
        onDrop: function() {
          let self = this;
          let resultContainer = $('result');

          document.ondragover = e => {
            e.preventDefault();
          };

          document.ondrop = e => {
            e.preventDefault();
          };

          resultContainer.ondragend = e => {
            e.preventDefault();
          };

          resultContainer.ondrop = e => {
            e.preventDefault();
            let files = e.dataTransfer.files;
            self.handleAll(files);
          };
        },
        handleFiles: function(files) {
          let self = this;
          let p;
          let ret = [];

          // FileList轉陣列
          [].slice.call(files).forEach(function(file, i) {
            const type = file.type;
            switch (true) {
              case /text/w+/.test(type):
                p = self.read("readAsText", file);
                break;

              case /image/w+/.test(type):
                p = self.read("readAsDataURL", file);
                break;

              default:
                p = self.read("readAsBinaryString", file);
                break;
            }
            ret.push(p);
          });

          return ret;
        },
        init: function() {
          var self = this;

          self.onDrop();

          // 這裡的onFileChange不能寫成Promise, 不然只會第一次有效, 因為狀態已經是fulfilled了
          self.onFileChange(files => {
            self.handleAll(files);
          });
        },
        handleAll: function(files) {
          let self = this;
          Promise.all(self.handleFiles(files))
            .then(results => {
              self.showResults(results);
            })
            .catch(err => {
              console.log(err);
            });
        },
        showResults: results => {
          console.log(results);
          let resultContainer = $("result");
          results.forEach((result, i) => {
            // alert(3);
            switch (true) {
              case result.indexOf("data:image/") >= 0:
                resultContainer.innerHTML += `<div><img src="${result}"></div>`;
                break;

              default:
                resultContainer.innerHTML += `<p>${result}<p>`;
                break;
            }
          });
        }
      };

      App.init();
    })(window, document);
  </script>
</body>
</html>

總結

到此這篇關於JavaScript中FileReader的文章就介紹到這了,更多相關js中的FileReader內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

JavaScript中的FileReader範例詳解

目錄

前言：

input:file

FileReader

補充：一個比較全面的例子

總結

熱門文章