一步一步實現JS拖拽插件

js拖拽是常見的網頁效果，本文將從零開始實現一個簡單的js插件。

一、js拖拽插件的原理

常見的拖拽操作是什么樣的呢？整過過程大概有下面幾個步驟：

　　1、用鼠標點擊被拖拽的元素

　　2、按住鼠標不放，移動鼠標

　　3、拖拽元素到一定位置，放開鼠標

這里的過程涉及到三個dom事件：onmousedown,onmousemove,onmouseup。所以拖拽的基本思路就是：

　　1、用鼠標點擊被拖拽的元素觸發onmousedown

　　　　（1）設置當前元素的可拖拽為true，表示可以拖拽

　　　　（2）記錄當前鼠標的坐標x,y

　　　　（3）記錄當前元素的坐標x,y

　　2、移動鼠標觸發onmousemove

　　　　（1）判斷元素是否可拖拽，如果是則進入步驟2，否則直接返回

　　　　（2）如果元素可拖拽，則設置元素的坐標

　　　　　　元素的x坐標 = 鼠標移動的橫向距離+元素本來的x坐標 = 鼠標現在的x坐標 - 鼠標之前的x坐標 + 元素本來的x坐標

　　　　　　元素的y坐標 = 鼠標移動的橫向距離+元素本來的y坐標 = 鼠標現在的y坐標 - 鼠標之前的y坐標 + 元素本來的y坐標

　　3、放開鼠標觸發onmouseup

　　　　（1）將鼠標的可拖拽狀態設置成false

二、根據原理實現的最基本效果

在實現基本的效果之前，有幾點需要說明的：

　　1、元素想要被拖動，它的postion屬性一定要是relative或absolute

　　2、通過event.clientX和event.clientY獲取鼠標的坐標

　　3、onmousemove是綁定在document元素上而不是拖拽元素本身，這樣能解決快速拖動造成的延遲或停止移動的問題

代碼如下：

var dragObj = document.getElementById("test");
        dragObj.style.left = "0px";
        dragObj.style.top = "0px";

        var mouseX, mouseY, objX, objY;
        var dragging = false;

        dragObj.onmousedown = function (event) {
            event = event || window.event;

            dragging = true;
            dragObj.style.position = "relative";


            mouseX = event.clientX;
            mouseY = event.clientY;
            objX = parseInt(dragObj.style.left);
            objY = parseInt(dragObj.style.top);
        }

        document.onmousemove = function (event) {
            event = event || window.event;
            if (dragging) {

                dragObj.style.left = parseInt(event.clientX - mouseX + objX) + "px";
                dragObj.style.top = parseInt(event.clientY - mouseY + objY) + "px";
            }

        }

        document.onmouseup = function () {
            dragging = false;
        }

 

三、代碼抽象與優化

上面的代碼要做成插件，要將其抽象出來，基本結構如下：

        ; (function (window, undefined) {            

            function Drag(ele) {}

            window.Drag = Drag;
        })(window, undefined);

用自執行匿名函數將代碼包起來，內部定義Drag方法並暴露到全局中，直接調用Drag，傳入被拖拽的元素。

首先對一些常用的方法進行簡單的封裝：

        ; (function (window, undefined) {
            var dom = {
                //綁定事件
                on: function (node, eventName, handler) {
                    if (node.addEventListener) {
                        node.addEventListener(eventName, handler);
                    }
                    else {
                        node.attachEvent("on" + eventName, handler);
                    }
                },
                //獲取元素的樣式
                getStyle: function (node, styleName) {
                    var realStyle = null;
                    if (window.getComputedStyle) {
                        realStyle = window.getComputedStyle(node, null)[styleName];
                    }
                    else if (node.currentStyle) {
                        realStyle = node.currentStyle[styleName];
                    }
                    return realStyle;
                },
                //獲取設置元素的樣式
                setCss: function (node, css) {
                    for (var key in css) {
                        node.style[key] = css[key];
                    }
                }
            };
          
            window.Drag = Drag;
        })(window, undefined);

 

在一個拖拽操作中，存在着兩個對象：被拖拽的對象和鼠標對象，我們定義了下面的兩個對象以及它們對應的操作：

首先的拖拽對象，它包含一個元素節點和拖拽之前的坐標x和y：

            function DragElement(node) {
                this.node = node;//被拖拽的元素節點
                this.x = 0;//拖拽之前的x坐標
                this.y = 0;//拖拽之前的y坐標
            }
            DragElement.prototype = {
                constructor: DragElement,
                init: function () {                    
                    this.setEleCss({
                        "left": dom.getStyle(node, "left"),
                        "top": dom.getStyle(node, "top")
                    })
                    .setXY(node.style.left, node.style.top);
                },
                //設置當前的坐標
                setXY: function (x, y) {
                    this.x = parseInt(x) || 0;
                    this.y = parseInt(y) || 0;
                    return this;
                },
                //設置元素節點的樣式
                setEleCss: function (css) {
                    dom.setCss(this.node, css);
                    return this;
                }
            }

 

還有一個對象是鼠標，它主要包含x坐標和y坐標：

            function Mouse() {
                this.x = 0;
                this.y = 0;
            }
            Mouse.prototype.setXY = function (x, y) {
                this.x = parseInt(x);
                this.y = parseInt(y);
            }        

這是在拖拽操作中定義的兩個對象。

 

如果一個頁面可以有多個拖拽元素，那應該注意什么：

1、每個元素對應一個拖拽對象實例

2、每個頁面只能有一個正在拖拽中的元素

為此，我們定義了唯一一個對象用來保存相關的配置：

            var draggableConfig = {
                zIndex: 1,
                draggingObj: null,
                mouse: new Mouse()
            };

這個對象中有三個屬性：

（1）zIndex：用來賦值給拖拽對象的zIndex屬性，有多個拖拽對象時，當兩個拖拽對象重疊時，會造成當前拖拽對象有可能被擋住，通過設置zIndex使其顯示在最頂層

（2）draggingObj：用來保存正在拖拽的對象，在這里去掉了前面的用來判斷是否可拖拽的變量，通過draggingObj來判斷當前是否可以拖拽以及獲取相應的拖拽對象

（3）mouse：唯一的鼠標對象，用來保存當前鼠標的坐標等信息

 

最后是綁定onmousedown，onmouseover，onmouseout事件，整合上面的代碼如下：

        ; (function (window, undefined) {
            var dom = {
                //綁定事件
                on: function (node, eventName, handler) {
                    if (node.addEventListener) {
                        node.addEventListener(eventName, handler);
                    }
                    else {
                        node.attachEvent("on" + eventName, handler);
                    }
                },
                //獲取元素的樣式
                getStyle: function (node, styleName) {
                    var realStyle = null;
                    if (window.getComputedStyle) {
                        realStyle = window.getComputedStyle(node, null)[styleName];
                    }
                    else if (node.currentStyle) {
                        realStyle = node.currentStyle[styleName];
                    }
                    return realStyle;
                },
                //獲取設置元素的樣式
                setCss: function (node, css) {
                    for (var key in css) {
                        node.style[key] = css[key];
                    }
                }
            };

            //#region 拖拽元素類
            function DragElement(node) {
                this.node = node;
                this.x = 0;
                this.y = 0;
            }
            DragElement.prototype = {
                constructor: DragElement,
                init: function () {                    
                    this.setEleCss({
                        "left": dom.getStyle(node, "left"),
                        "top": dom.getStyle(node, "top")
                    })
                    .setXY(node.style.left, node.style.top);
                },
                setXY: function (x, y) {
                    this.x = parseInt(x) || 0;
                    this.y = parseInt(y) || 0;
                    return this;
                },
                setEleCss: function (css) {
                    dom.setCss(this.node, css);
                    return this;
                }
            }
            //#endregion

            //#region 鼠標元素
            function Mouse() {
                this.x = 0;
                this.y = 0;
            }
            Mouse.prototype.setXY = function (x, y) {
                this.x = parseInt(x);
                this.y = parseInt(y);
            }
            //#endregion

            //拖拽配置
            var draggableConfig = {
                zIndex: 1,
                draggingObj: null,
                mouse: new Mouse()
            };

            function Drag(ele) {
                this.ele = ele;

                function mouseDown(event) {
                    var ele = event.target || event.srcElement;

                    draggableConfig.mouse.setXY(event.clientX, event.clientY);

                    draggableConfig.draggingObj = new DragElement(ele);
                    draggableConfig.draggingObj
                        .setXY(ele.style.left, ele.style.top)
                        .setEleCss({
                            "zIndex": draggableConfig.zIndex++,
                            "position": "relative"
                        });
                }                

                ele.onselectstart = function () {
                    //防止拖拽對象內的文字被選中
                    return false;
                }
                dom.on(ele, "mousedown", mouseDown);
            }

            dom.on(document, "mousemove", function (event) {
                if (draggableConfig.draggingObj) {
                    var mouse = draggableConfig.mouse,
                        draggingObj = draggableConfig.draggingObj;
                    draggingObj.setEleCss({
                        "left": parseInt(event.clientX - mouse.x + draggingObj.x) + "px",
                        "top": parseInt(event.clientY - mouse.y + draggingObj.y) + "px"
                    });
                }
            })

            dom.on(document, "mouseup", function (event) {
                draggableConfig.draggingObj = null;
            })


            window.Drag = Drag;
        })(window, undefined);

調用方法：Drag(document.getElementById("obj"));

注意的一點，為了防止選中拖拽元素中的文字，通過onselectstart事件處理程序return false來處理這個問題。

 

四、擴展：有效的拖拽元素

我們常見的一些拖拽效果很有可能是這樣的：

彈框的頂部是可以進行拖拽操作的，內容區域是不可拖拽的，怎么實現這樣的效果呢：

首先優化拖拽元素對象如下，增加一個目標元素target，表示被拖拽對象，在上圖的登錄框中，就是整個登錄窗口。

被記錄和設置坐標的拖拽元素就是這個目標元素，但是它並不是整個部分都是拖拽的有效部分。我們在html結構中為拖拽的有效區域添加類draggable表示有效拖拽區域：

    <div id="obj1" class="dialog" style="position:relative;left:50px">
        <div class="header draggable">
            拖拽的有效元素
        </div>
        <div class="content">
            拖拽對象1
        </div>
    </div>

然后修改Drag方法如下：

    function drag(ele) {
        var dragNode = (ele.querySelector(".draggable") || ele);
        dom.on(dragNode, "mousedown", function (event) {
            var dragElement = draggableConfig.dragElement = new DragElement(ele);

            draggableConfig.mouse.setXY(event.clientX, event.clientY);
            draggableConfig.dragElement
                .setXY(dragElement.target.style.left, dragElement.target.style.top)
                .setTargetCss({
                    "zIndex": draggableConfig.zIndex++,
                    "position": "relative"
                });
        }).on(dragNode, "mouseover", function () {
            dom.setCss(this, draggableStyle.dragging);
        }).on(dragNode, "mouseout", function () {
            dom.setCss(this, draggableStyle.defaults);
        });
    }

主要修改的是綁定mousedown的節點變成了包含draggable類的有效元素，如果不含有draggable，則整個元素都是有效元素。

五、性能優化和總結

由於onmousemove在一直調用，會造成一些性能問題，我們可以通過setTimout來延遲綁定onmousemove事件，改進move函數如下

     function move(event) {
        if (draggableConfig.dragElement) {
            var mouse = draggableConfig.mouse,
                dragElement = draggableConfig.dragElement;
            dragElement.setTargetCss({
                "left": parseInt(event.clientX - mouse.x + dragElement.x) + "px",
                "top": parseInt(event.clientY - mouse.y + dragElement.y) + "px"
            });

            dom.off(document, "mousemove", move);
            setTimeout(function () {
                dom.on(document, "mousemove", move);
            }, 25);
        }
    }

總結：

整個拖拽插件的實現其實很簡單，主要是要注意幾點

　　1、實現思路：元素拖拽位置的改變就等於鼠標改變的距離，關鍵在於獲取鼠標的變動和元素原本的坐標

      2、通過setTimeout來延遲加載onmousemove事件來提供性能

 

六、jquery插件化

簡單地將其封裝成jquery插件，主要是相關的dom方法替換成jquery方法來操作

; (function ($, window, undefined) {
    //#region 拖拽元素類
    function DragElement(node) {

        this.target = node;

        node.onselectstart = function () {
            //防止拖拽對象內的文字被選中
            return false;
        }
    }
    DragElement.prototype = {
        constructor: DragElement,
        setXY: function (x, y) {
            this.x = parseInt(x) || 0;
            this.y = parseInt(y) || 0;
            return this;
        },
        setTargetCss: function (css) {
            $(this.target).css(css);
            return this;
        }
    }
    //#endregion

    //#region 鼠標元素
    function Mouse() {
        this.x = 0;
        this.y = 0;
    }
    Mouse.prototype.setXY = function (x, y) {
        this.x = parseInt(x);
        this.y = parseInt(y);
    }
    //#endregion

    //拖拽配置
    var draggableConfig = {
        zIndex: 1,
        dragElement: null,
        mouse: new Mouse()
    };

    var draggableStyle = {
        dragging: {
            cursor: "move"
        },
        defaults: {
            cursor: "default"
        }
    }

    var $document = $(document);

    function drag($ele) {
        var $dragNode = $ele.find(".draggable");
        $dragNode = $dragNode.length > 0 ? $dragNode : $ele;
        

        $dragNode.on({
            "mousedown": function (event) {
                var dragElement = draggableConfig.dragElement = new DragElement($ele.get(0));

                draggableConfig.mouse.setXY(event.clientX, event.clientY);
                draggableConfig.dragElement
                    .setXY(dragElement.target.style.left, dragElement.target.style.top)
                    .setTargetCss({
                        "zIndex": draggableConfig.zIndex++,
                        "position": "relative"
                    });
            },
            "mouseover": function () {
                $(this).css(draggableStyle.dragging);
            },
            "mouseout": function () {
                $(this).css(draggableStyle.defaults);
            }
        })
    }

    function move(event) {
        if (draggableConfig.dragElement) {
            var mouse = draggableConfig.mouse,
                dragElement = draggableConfig.dragElement;
            dragElement.setTargetCss({
                "left": parseInt(event.clientX - mouse.x + dragElement.x) + "px",
                "top": parseInt(event.clientY - mouse.y + dragElement.y) + "px"
            });

            $document.off("mousemove", move);
            setTimeout(function () {
                $document.on("mousemove", move);
            }, 25);
        }
    }

    $document.on({
        "mousemove": move,
        "mouseup": function () {
            draggableConfig.dragElement = null;
        }
    });

    $.fn.drag = function (options) {
        drag(this);
    }

})(jQuery, window, undefined)

 

點擊下載DEMO