DIV CSS 佈局教程網

用 FileSaver.js 在瀏覽器端儲存檔案的實作方式
編輯:關於JavaScript     

要在純前端把資料存成檔案,過去得靠各種 hack,現在用 FileSaver.js 只要兩三行就能搞定。以下說明用法與背後原理。

核心用法

把要儲存的內容包成 Blob,再呼叫 saveAs 即可:

var blob = new Blob(['out_put_string'], { type: "text/plain;charset=utf-8" });
// out_put_string 為要寫入檔案的字串內容
saveAs(blob, "filename.php"); // filename.php 為存檔名稱

插件原始碼(格式化後)

檔案不大,格式化後閱讀起來清楚很多,也能看出它其實是在做「能力偵測+多路降級」:

/*! @source https://purl.eligrey.com/github/FileSaver.js/blob/master/FileSaver.js */
var saveAs = saveAs || function(e) {
  "use strict";
  if (typeof navigator !== "undefined" && /MSIE [1-9]\./.test(navigator.userAgent)) { return }
  var t = e.document,
      n = function() { return e.URL || e.webkitURL || e },
      r = t.createElementNS("https://www.w3.org/1999/xhtml", "a"),
      i = "download" in r,
      o = function(e) { var t = new MouseEvent("click"); e.dispatchEvent(t) },
      a = /Version\/[\d\.]+.*Safari/.test(navigator.userAgent),
      f = e.webkitRequestFileSystem,
      u = e.requestFileSystem || f || e.mozRequestFileSystem,
      s = function(t) { (e.setImmediate || e.setTimeout)(function() { throw t }, 0) },
      c = "application/octet-stream",
      d = 0, l = 500,
      w = function(t) {
        var r = function() {
          if (typeof t === "string") { n().revokeObjectURL(t) } else { t.remove() }
        };
        if (e.chrome) { r() } else { setTimeout(r, l) }
      },
      p = function(e, t, n) {
        t = [].concat(t);
        var r = t.length;
        while (r--) {
          var i = e["on" + t[r]];
          if (typeof i === "function") {
            try { i.call(e, n || e) } catch(o) { s(o) }
          }
        }
      },
      v = function(e) {
        if (/^\s*(?::text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)) {
          return new Blob(["\ufeff", e], { type: e.type })
        }
        return e
      },
      y = function(t, s, l) {
        if (!l) { t = v(t) }
        var y = this, m = t.type, S = false, h, R,
            O = function() { p(y, "writestart progress write writeend".split(" ")) },
            g = function() {
              if (R && a && typeof FileReader !== "undefined") {
                var r = new FileReader;
                r.onloadend = function() {
                  var e = r.result;
                  R.location.href = "data:attachment/file" + e.slice(e.search(/[,;]/));
                  y.readyState = y.DONE;
                  O()
                };
                r.readAsDataURL(t);
                y.readyState = y.INIT;
                return
              }
              if (S || !h) { h = n().createObjectURL(t) }
              if (R) { R.location.href = h }
              else {
                var i = e.open(h, "_blank");
                if (i == undefined && a) { e.location.href = h }
              }
              y.readyState = y.DONE;
              O();
              w(h)
            },
            b = function(e) {
              return function() {
                if (y.readyState !== y.DONE) { return e.apply(this, arguments) }
              }
            },
            E = { create: true, exclusive: false }, N;
        y.readyState = y.INIT;
        if (!s) { s = "download" }
        if (i) {
          h = n().createObjectURL(t);
          r.href = h;
          r.download = s;
          setTimeout(function() { o(r); O(); w(h); y.readyState = y.DONE });
          return
        }
        if (e.chrome && m && m !== c) {
          N = t.slice || t.webkitSlice;
          t = N.call(t, 0, t.size, c);
          S = true
        }
        if (f && s !== "download") { s += ".download" }
        if (m === c || f) { R = e }
        if (!u) { g(); return }
        d += t.size;
        u(e.TEMPORARY, d, b(function(e) {
          e.root.getDirectory("saved", E, b(function(e) {
            var n = function() {
              e.getFile(s, E, b(function(e) {
                e.createWriter(b(function(n) {
                  n.onwriteend = function(t) {
                    R.location.href = e.toURL();
                    y.readyState = y.DONE;
                    p(y, "writeend", t);
                    w(e)
                  };
                  n.onerror = function() {
                    var e = n.error;
                    if (e.code !== e.ABORT_ERR) { g() }
                  };
                  "writestart progress write abort".split(" ").forEach(function(e) {
                    n["on" + e] = y["on" + e]
                  });
                  n.write(t);
                  y.abort = function() { n.abort(); y.readyState = y.DONE };
                  y.readyState = y.WRITING
                }), g)
              }), g)
            };
            e.getFile(s, { create: false }, b(function(e) { e.remove(); n() }),
              b(function(e) { if (e.code === e.NOT_FOUND_ERR) { n() } else { g() } }))
          }), g)
        }), g)
      },
      m = y.prototype,
      S = function(e, t, n) { return new y(e, t, n) };
    if (typeof navigator !== "undefined" && navigator.msSaveOrOpenBlob) {
      return function(e, t, n) {
        if (!n) { e = v(e) }
        return navigator.msSaveOrOpenBlob(e, t || "download")
      }
    }
    m.abort = function() { var e = this; e.readyState = e.DONE; p(e, "abort") };
    m.readyState = m.INIT = 0;
    m.WRITING = 1;
    m.DONE = 2;
    m.error = m.onwritestart = m.onprogress = m.onwrite = m.onabort = m.onerror = m.onwriteend = null;
    return S
}(typeof self !== "undefined" && self || typeof window !== "undefined" && window || this.content);

if (typeof module !== "undefined" && module.exports) {
  module.exports.saveAs = saveAs
} else if (typeof define !== "undefined" && define !== null && define.amd != null) {
  define([], function() { return saveAs })
}

它做了哪些事

  • 優先走 a.download+createObjectURL 這條最乾淨的路徑(現代瀏覽器都支援)。
  • 不支援時降級到 File System API 寫檔,再不行就用 window.open 開新視窗觸發下載。
  • IE 走 navigator.msSaveOrOpenBlob,Safari 則用 FileReader 轉 dataURL。
  • 存完之後記得 revokeObjectURL 釋放記憶體,避免 blob URL 洩漏。

實務上最常用到的就是匯出 CSV、JSON 設定檔或後端回傳的報表,後者只要把 response 轉成 Blob 再丟給 saveAs 即可,不必再靠後端下發 Content-Disposition 標頭。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved