DIV CSS 佈局教程網

JavaScript 複製到剪貼簿:三種實作方案與相容性實測
編輯:關於JavaScript     

「點一下把這段文字複製走」聽起來是個小功能,但攤開到各家瀏覽器上就一點都不小。本文把實戰中試過的三條路整理出來,包含各自失效的原因。

方案一:clipboardData,只有 IE 能用

最省事的寫法,直接呼叫 IE 提供的 clipboardData:

 <script type="text/javascript">
function copy() {
    window.clipboardData.setData("text", document.getElementById("name").value);
    alert("The text is on the clipboard, try to paste it!");
}
</script> 

程式碼短得可疑,代價是它只存在於 IE 系。一旦要考慮 Chrome、Firefox,就得換思路。

方案二:execCommand,跨瀏覽器但 Firefox 卡關

第二版試著用標準一點的做法:IE 走 window.clipboardData,其餘瀏覽器則建立一個暫時元素、選中它的內容,再呼叫 document.execCommand("copy")。

 function CopyToClipboard() {
    var input = document.getElementById("toClipboard");
    var textToClipboard = input.value;
    var success = true;

    if (window.clipboardData) {
        // Internet Explorer
        window.clipboardData.setData("Text", textToClipboard);
    } else {
        // 建立一個暫時元素供 execCommand 使用
        var forExecElement = CreateElementForExecCommand(textToClipboard);
        SelectContent(forExecElement);

        try {
            // Firefox 需要 UniversalXPConnect 權限才能碰剪貼簿
            if (window.netscape && netscape.security) {
                netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
            }
            success = document.execCommand("copy", false, null);
        } catch (e) {
            success = false;
        }
        document.body.removeChild(forExecElement);
    }

    if (success) {
        alert("The text is on the clipboard, try to paste it!");
    } else {
        alert("Your browser doesn't allow clipboard access!");
    }
}

function CreateElementForExecCommand(textToClipboard) {
    var forExecElement = document.createElement("div");
    // 放到可視區域之外
    forExecElement.style.position = "absolute";
    forExecElement.style.left = "-10000px";
    forExecElement.style.top = "-10000px";
    forExecElement.textContent = textToClipboard;
    document.body.appendChild(forExecElement);
    // Firefox 的 execCommand 要求 contentEditable
    forExecElement.contentEditable = true;
    return forExecElement;
}

function SelectContent(element) {
    var rangeToSelect = document.createRange();
    rangeToSelect.selectNodeContents(element);
    var selection = window.getSelection();
    selection.removeAllRanges();
    selection.addRange(rangeToSelect);
} 
 <input id="toClipboard" value="text to clipboard"/>
<button onclick='CopyToClipboard()'>Copy text to clipboard</button> 

實測結果:Firefox 依然複製失敗。那段 netscape.security 的權限寫法早已被移除,此路不通。

方案三:Flash 方案 ZeroClipboard

與其自己造輪子,那個年代的事實標準是 ZeroClipboard。它的原理值得一看:早期方案藏一個隱形 Flash 在頁面裡,但 Flash Player 10 之後只允許「使用者直接對 Flash 操作」時才能寫入剪貼簿,於是 ZeroClipboard 改成放一個透明的 Flash,浮在按鈕上層。使用者以為自己點的是按鈕,實際上點的是 Flash,剪貼簿權限問題就繞過去了。

整個流程可以拆成五件事:

建立一個透明 Flash → 把它浮在按鈕上層 → 決定要複製的文字內容 → 監聽這個透明 Flash 的點擊事件 → 點擊後完成剪貼簿寫入。ZeroClipboard 針對每一環都提供了對應 API。

使用方式(當年):

 git clone https://github.com/chenpingzhao/easycopy.git 

核心檔案 ZeroClipboard.js 裡有幾個關鍵成員,讀懂它們就讀懂整個思路:

 var ZeroClipboard = {
    version: "1.0.7",
    clients: {},
    moviePath: "zeroclipboard.swf",
    nextId: 1,
    // 為元素補上 hide / show / addClass / removeClass / hasClass 等工具方法
    $: function (A) { /* ……省略…… */ return A },
    setMoviePath: function (A) { this.moviePath = A },
    // Flash 透過它反向呼叫 JS
    dispatch: function (D, B, C) {
        var A = this.clients[D];
        if (A) { A.receiveEvent(B, C); }
    },
    register: function (B, A) { this.clients[B] = A },
    // 計算元素在頁面上的位置與尺寸
    getDOMObjectPosition: function (C, A) {
        var B = { left: 0, top: 0,
                  width: C.width ? C.width : C.offsetWidth,
                  height: C.height ? C.height : C.offsetHeight };
        while (C && (C != A)) {
            B.left += C.offsetLeft;
            B.top += C.offsetTop;
            C = C.offsetParent;
        }
        return B;
    },
    Client: function (A) { /* ……省略…… */ }
};

glue() 負責把 Flash 對齊並疊在目標元素上方:

 glue: function (D, B, E) {
    this.domElement = ZeroClipboard.$(D);
    var F = 99;
    if (this.domElement.style.zIndex) {
        F = parseInt(this.domElement.style.zIndex, 10) + 1;
    }
    // ……計算位置與尺寸,建立 div 並插入 innerHTML ……
} 

插入 innerHTML 的順序是個已知雷區:IE 的 Flash JavaScript 通信介面有個 bug,必須先把 object 標籤插入到一個「已經掛進 DOM」的元素裡,並確保該元素完成 appendChild 之後再寫入 innerHTML,否則會失效。

reposition() 用來處理版面位移:因為按鈕上覆蓋著 Flash,視窗尺寸變化後二者可能錯位導致點不到,實務上會把它綁到 resize 事件:

 bind(window, "resize", function () {
    clip.reposition();
});

function bind(obj, type, fn) {
    if (obj.attachEvent) {
        obj['e' + type + fn] = fn;
        obj[type + fn] = function () { obj['e' + type + fn](window.event); };
        obj.attachEvent('on' + type, obj[type + fn]);
    } else {
        obj.addEventListener(type, fn, false);
    }
} 

還有一個容易忽略的細節:滑鼠移到按鈕上時,由於 Flash 蓋在上層,CSS 的 :hover、:active 等偽類可能失效。解法是把偽類改成類別:

 /* 原本 */
copy-botton:hover { border-color: #FF6633; }

/* 改成 */
copy-botton.hover { border-color: #FF6633; }

然後告訴組件幫你轉換:

 clip.setCSSEffects(true); 

最後,組件透過 receiveEvent() 分派 Flash 上來的各種事件,其中 load 是最關鍵的一個——它代表 Flash 已就緒,此時才能把待複製的文字真正交給它:

 receiveEvent: function (D, E) {
    D = D.toString().toLowerCase().replace(/^on/, "");
    switch (D) {
        case "load":
            this.movie = document.getElementById(this.movieId);
            // ……取得 movie 物件,設定文字與游標樣式 ……
            this.ready = true;
            this.movie.setText(this.clipText);
            this.movie.setHandCursor(this.handCursorEnabled);
            break;
        case "mouseover": /* 加上 hover 類別 */ break;
        case "mouseout":  /* 移除 hover / active 類別 */ break;
        case "mousedown": /* 加上 active 類別 */ break;
        case "mouseup":   /* 移除 active 類別 */ break;
    }
    // 接著依序呼叫使用者註冊的處理函數
} 

寫在最後

這三條路各自對應一個時代。以現在的標準來看,Flash 方案早已退場,execCommand 也屬於兼容舊瀏覽器的手段;現代專案更合適的做法是使用標準的剪貼簿 API,並在需要時搭配使用者手勢觸發。理解上面三種思路的價值在於:它們示範了瀏覽器權限模型如何一步步收緊,也解釋了為什麼「按一下自動複製」這件事,曾經需要一個透明的 Flash 才做得成。

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