細說Web API中的Blob

艾特老幹部發表於2017-10-15
WebAPI

在一般的Web開發中，很少會用到Blob，但Blob可以滿足一些場景下的特殊需求。Blob，Binary Large Object的縮寫，代表二進位制型別的大物件。Blob的概念在一些資料庫中有使用到，例如，MYSQL中的BLOB型別就表示二進位制資料的容器。在Web中，Blob型別的物件表示不可變的類似檔案物件的原始資料，通俗點說，就是Blob物件是二進位制資料，但它是類似檔案物件的二進位制資料，因此可以像操作File物件一樣操作Blob物件，實際上，File繼承自Blob。

Blob基本用法

建立

可以通過Blob的建構函式建立Blob物件：

Blob(blobParts[, options])
複製程式碼

引數說明：

blobParts：陣列型別，陣列中的每一項連線起來構成Blob物件的資料，陣列中的每項元素可以是ArrayBuffer, ArrayBufferView, Blob, DOMString 。

options：可選項，字典格式型別，可以指定如下兩個屬性：

  • type，預設值為 ""，它代表了將會被放入到blob中的陣列內容的MIME型別。
  • endings，預設值為"transparent"，用於指定包含行結束符\n的字串如何被寫入。 它是以下兩個值中的一個： "native"，表示行結束符會被更改為適合宿主作業系統檔案系統的換行符； "transparent"，表示會保持blob中儲存的結束符不變。

例如：

    var data1 = "a";
    var data2 = "b";
    var data3 = "<div style='color:red;'>This is a blob</div>";
    var data4 = { "name": "abc" };

    var blob1 = new Blob([data1]);
    var blob2 = new Blob([data1, data2]);
    var blob3 = new Blob([data3]);
    var blob4 = new Blob([JSON.stringify(data4)]);
    var blob5 = new Blob([data4]);
    var blob6 = new Blob([data3, data4]);

    console.log(blob1);  //輸出：Blob {size: 1, type: ""}
    console.log(blob2);  //輸出：Blob {size: 2, type: ""}
    console.log(blob3);  //輸出：Blob {size: 44, type: ""}
    console.log(blob4);  //輸出：Blob {size: 14, type: ""}
    console.log(blob5);  //輸出：Blob {size: 15, type: ""}
    console.log(blob6);  //輸出：Blob {size: 59, type: ""}
複製程式碼

size代表Blob 物件中所包含資料的位元組數。這裡要注意，使用字串和普通物件建立Blob時的不同，blob4使用通過JSON.stringify把data4物件轉換成json字串，blob5則直接使用data4建立，兩個物件的size分別為14和15。blob4的size等於14很容易理解，因為JSON.stringify(data4)的結果為："{"name":"abc"}"，正好14個位元組(不包含最外層的引號)。blob5的size等於15是如何計算而來的呢？實際上，當使用普通物件建立Blob物件時，相當於呼叫了普通物件的toString()方法得到字串資料，然後再建立Blob物件。所以，blob5儲存的資料是"[object Object]"，是15個位元組(不包含最外層的引號)。

slice方法

Blob物件有一個slice方法，返回一個新的 Blob物件，包含了源 Blob物件中指定範圍內的資料。

slice([start[, end[, contentType]]])
複製程式碼

引數說明：

start： 可選，代表 Blob 裡的下標，表示第一個會被會被拷貝進新的 Blob 的位元組的起始位置。如果傳入的是一個負數，那麼這個偏移量將會從資料的末尾從後到前開始計算。

end： 可選，代表的是 Blob 的一個下標，這個下標-1的對應的位元組將會是被拷貝進新的Blob 的最後一個位元組。如果你傳入了一個負數，那麼這個偏移量將會從資料的末尾從後到前開始計算。

contentType： 可選，給新的 Blob 賦予一個新的文件型別。這將會把它的 type 屬性設為被傳入的值。它的預設值是一個空的字串。

例如：

    var data = "abcdef";
    var blob1 = new Blob([data]);
    var blob2 = blob1.slice(0,3);
    
    console.log(blob1);  //輸出：Blob {size: 6, type: ""}
    console.log(blob2);  //輸出：Blob {size: 3, type: ""}
複製程式碼

通過slice方法，從blob1中建立出一個新的blob物件，size等於3。

Blob使用場景

分片上傳

前面已經說過，File繼承自Blob，因此我們可以呼叫slice方法對大檔案進行分片長傳。程式碼如下：

function uploadFile(file) {
  var chunkSize = 1024 * 1024;   // 每片1M大小
  var totalSize = file.size;
  var chunkQuantity = Math.ceil(totalSize/chunkSize);  //分片總數
  var offset = 0;  // 偏移量
  
  var reader = new FileReader();
  reader.onload = function(e) {
    var xhr = new XMLHttpRequest();
    xhr.open("POST","http://xxxx/upload?fileName="+file.name);
    xhr.overrideMimeType("application/octet-stream");
    
    xhr.onreadystatechange = function() {
      if(xhr.readyState === XMLHttpRequest.DONE && xhr.status === 200) {
        ++offset;
        if(offset === chunkQuantity) {
          alert("上傳完成");
        } else if(offset === chunkQuantity-1){
          blob = file.slice(offset*chunkSize, totalSize);   // 上傳最後一片
          reader.readAsBinaryString(blob);
        } else {
          blob = file.slice(offset*chunkSize, (offset+1)*chunkSize); 
          reader.readAsBinaryString(blob);
        }
      }else {
        alert("上傳出錯");
      }
    }
    
    if(xhr.sendAsBinary) {
      xhr.sendAsBinary(e.target.result);   // e.target.result是此次讀取的分片二進位制資料
    } else {
      xhr.send(e.target.result);
    }
  }
   var blob = file.slice(0, chunkSize);
   reader.readAsBinaryString(blob);
}
複製程式碼

這段程式碼還可以進一步豐富，比如顯示當前的上傳進度，使用多個XMLHttpRequest物件並行上傳物件（需要傳遞分片資料的位置引數給伺服器端）等。

Blob URL

Blob URL是blob協議的URL，它的格式如下：

blob:http://XXX
複製程式碼

Blob URL可以通過URL.createObjectURL(blob)建立。在絕大部分場景下，我們可以像使用Http協議的URL一樣，使用Blob URL。常見的場景有：作為檔案的下載地址和作為圖片資源地址。

  • 檔案下載地址
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>Blob Test</title>
    <script>
        function createDownloadFile() {
            var content = "Blob Data";
            var blob = new Blob([content]);
            var link = document.getElementsByTagName("a")[0];
            link.download = "file";
            link.href = URL.createObjectURL(blob);
        }
        window.onload = createDownloadFile;
    </script>
</head>

<body>
    <a>下載</a>
</body>

</html>
複製程式碼

點選下載按鈕，瀏覽器將會下載一個名為file的檔案，檔案的內容是：Blob Data。通過Blob物件，我們在前端程式碼中就可以動態生成檔案，提供給瀏覽器下載。開啟Chrome瀏覽器除錯視窗，在Elements標籤下可以看到生成的Blob URL為：

細說Web API中的Blob

  • 圖片資源地址

為圖片檔案建立一個Blob URL，賦值給細說Web API中的Blob標籤：

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>Blob Test</title>
    <script>
        function handleFile(e) {
            var file = e.files[0];
            var blob = URL.createObjectURL(file);
            var img = document.getElementsByTagName("img")[0];
            img.src = blob;
            img.onload = function(e) {
                URL.revokeObjectURL(this.src);  // 釋放createObjectURL建立的物件##
            }
        }
    </script>
</head>

<body>
    <input type="file" accept="image/*" onchange="handleFile(this)" />
    <br/>
    <img style="width:200px;height:200px">
</body>

</html>
複製程式碼

input中選擇的圖片會在細說Web API中的Blob裡顯示出來，如圖所示：

細說Web API中的Blob

同時，可以在Network標籤欄，發現這個Blob URL的請求資訊：

細說Web API中的Blob

這個請求資訊和平時我們使用的Http URL獲取圖片幾乎完全一樣。我們還可以使用Data URL載入圖片資源：

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>Blob Test</title>
    <script>
        function handleFile(e) {
            var file = e.files[0];
            var fileReader = new FileReader();
            var img = document.getElementsByTagName("img")[0];
            fileReader.onload = function(e) {
                img.src = e.target.result;
            }
            fileReader.readAsDataURL(file);
        }
    </script>
</head>

<body>
    <input type="file" accept="image/*" onchange="handleFile(this)" />
    <br/>
    <img style="width:200px;height:200px">
</body>

</html>
複製程式碼

FileReader的readAsDataURL生成一個Data URL，如圖所示：

細說Web API中的Blob

Data URL對大家來說應該並不陌生，Web效能優化中有一項措施：把小圖片用base64編碼直接嵌入到HTML檔案中，實際上就是利用了Data URL來獲取嵌入的圖片資料。

那麼Blob URL和Data URL有什麼區別呢？

  1. Blob URL的長度一般比較短，但Data URL因為直接儲存圖片base64編碼後的資料，往往很長，如上圖所示，瀏覽器在顯示Data URL時使用了省略號（…）。當顯式大圖片時，使用Blob URL能獲取更好的可能性。
  2. Blob URL可以方便的使用XMLHttpRequest獲取源資料，例如：
var blobUrl = URL.createObjectURL(new Blob(['Test'], {type: 'text/plain'}));
var x = new XMLHttpRequest();
// 如果設定x.responseType = 'blob'，將返回一個Blob物件，而不是文字:
// x.responseType = 'blob';
x.onload = function() {
    alert(x.responseText);   // 輸出 Test
};
x.open('get', blobUrl);
x.send();
複製程式碼

對於Data URL，並不是所有瀏覽器都支援通過XMLHttpRequest獲取源資料的。 3. Blob URL 只能在當前應用內部使用，把Blob URL複製到瀏覽器的位址列中，是無法獲取資料的。Data URL相比之下，就有很好的移植性，你可以在任意瀏覽器中使用。

除了可以用作圖片資源的網路地址，Blob URL也可以用作其他資源的網路地址，例如html檔案、json檔案等，為了保證瀏覽器能正確的解析Blob URL返回的檔案型別，需要在建立Blob物件時指定相應的type：

// 建立HTML檔案的Blob URL
var data = "<div style='color:red;'>This is a blob</div>";
var blob = new Blob([data], { type: 'text/html' });
var blobURL = URL.createObjectURL(blob);

// 建立JSON檔案的Blob URL
var data = { "name": "abc" };
var blob = new Blob([JSON.stringify(data)], { type: 'application/json' });
var blobURL = URL.createObjectURL(blob);

複製程式碼

歡迎關注我的公眾號：老幹部的大前端，領取21本大前端精選書籍！

細說Web API中的Blob

相關文章