layui-tree如何實現懶加載以及動態局部渲染樹節點

衆所周知，layui.tree的樹形控件，在渲染樹節點時，須要後臺準備好整個組織樹的數據；若是組織樹的數據量特別大，頁面渲染就特別慢。最近在狐小E智慧辦公平臺中，展現企業部門樹時，就遇到這種問題；當時產品要求，部門樹渲染要特別快，同時某部門下新增/刪除了一個子部門時，要動態刷新，實時呈現；然而layui.tree的原始機制是，必須從新加載整個樹的數據再渲染，這樣就會致使展開的節點全收縮回去，而不是恰好展開到該父部門位置；前端

這樣就有2個問題亟需優化：ajax

1）部門樹數據量大時，渲染慢。json

2）父部門如何動態刷新子部門，而且局部更新視圖；前端框架

爲了解決這2個問題，咱們只好修改layui.tree源碼，實現這種高大上的功能；廢話很少說，直接上乾貨：app

狐小E智慧辦公後臺使用的layui版本是v2.5.5，其餘版本的layui源碼可能有所不一樣，這點需注意。框架

解決方案異步

步驟1：源碼修改async

首先，在layui前端框架找到實現樹組件的模塊源碼tree.js，如圖所示：

ide

1：打開源碼，在樹的主渲染方法 r.render前，添加上用於加載child節點的方法r.children，代碼以下：函數

r.children = function (e, i, d) {

var a = l.that[e];

return a.children(i, d)

}
效果以下圖：

2：找到b.prototype.tree方法，在此方法前，添加兩個用於懶加載子節點的方法：b.prototype.children = function (n1, n2) {

var e = this;

e.setchildrendata(e.config.data, n1, n2);

b.prototype.setchildrendata = function (n0, n1, n2) {

var e = this;

var c = i('#' + e.config.id);

layui.each(n0, function (a, r) {

var b = c.find('div[data-id=' + r.id + ']').hasClass(C);

r.spread = b;

if (e.config.accordion === !0) { //手風琴模式

  r.spread = !1;

  var cs = c.find('div[data-id=' + n1 + ']').parents('.layui-tree-set');

  cs.each(function () {

    if (r.id === i(this).attr('data-id')) {

      r.spread = !0;

    }

  });

}

if (r.id === n1) {

  r.spread = !0;

  if(!r.children){

    r.children=[];

  }

  if (n2.length === 0) {

    delete r.children;

  }else{

    //i.extend(!0, r.children, n2);

    r.children = n2;

  }

  e.reload(e.config.id, e.config.data);

}

if (r.children) {

  e.setchildrendata(r.children, n1, n2); //遞歸子節點

}

});

}

3：修改b.prototype.tree方法的代碼，修改後代碼以下【備註：//TODO 部分標識的是layui原始代碼】

b.prototype.tree = function (e, a) {

var n = this, t = n.config, r = a || t.data;

    layui.each(r, function (a, r) {

        //TODO 此處調整源碼

        //var l = r.children && r.children.length > 0,

        var l = r.children,

            o = i('<div class="layui-tree-pack" ' + (r.spread ? 'style="display: block;"' : "") + '"></div>'),

            //TODO 源碼調整

            //h = i(['<div data-id="' + r.id + '" class="layui-tree-set' + (r.spread ? " layui-tree-spread" : "") + (r.checked ? " layui-tree-checkedFirst" : "") + '">', '<div class="layui-tree-entry">', '<div class="layui-tree-main">', function () {

            h = i(['<div data-id="' + r.id + '" data-parent-id="' + r.parentId + '" class="layui-tree-set' + (r.spread ? " layui-tree-spread" : "") + (r.checked ? " layui-tree-checkedFirst" : "") + '">', '<div class="layui-tree-entry ' + (l ? "taller" : "") + '" >', '<div class="layui-tree-main">', function () {

                //TODO 源碼調整

                //return t.showLine ? l ? '<span class="layui-tree-iconClick layui-tree-icon"><i class="layui-icon ' + (r.spread ? "layui-icon-subtraction" : "layui-icon-addition") + '"></i></span>' : '<span class="layui-tree-iconClick"><i class="layui-icon layui-icon-file"></i></span>' : '<span class="layui-tree-iconClick"><i class="layui-tree-iconArrow ' + (l ? "" : c) + '"></i></span>'

                return t.showLine ? l ? '<span class="layui-tree-iconClick layui-tree-icon"><i class="layui-icon ' + (r.spread ? "layui-icon-subtraction" : "layui-icon-addition") + '"></i></span>' : '<span class="layui-tree-iconClick layui-tree-icon"><i class="layui-icon layui-icon-file"></i></span>' : '<span class="layui-tree-iconClick"><i class="layui-icon ' + ( r.spread ? "layui-tree-active" : "layui-tree-iconArrow") + (l ? "" : c)+' "></i></span>'

            }(), function () {

                return t.showCheckbox ? '<input type="checkbox" name="' + (r.field || "layuiTreeCheck_" + r.id) + '" same="layuiTreeCheck" lay-skin="primary" ' + (r.disabled ? "disabled" : "") + ' value="' + r.id + '">' : ""

            }(), function () {

              //TODO 修改源碼顯示title

              //return t.isJump && r.href ? '<a href="' + r.href + '" target="_blank" class=" + y + ">' + (r.title || r.label || t.text.defaultNodeName) + "</a>" : '<span class="' + y + (r.disabled ? " " + d : "") + '">' + (r.title || r.label || t.text.defaultNodeName) + "</span>"

              return t.isJump && r.href ? '<a title="' + (r.title || r.label || t.text.defaultNodeName) + '"  href="' + r.href + '" target="_blank" class=" + y + ">' + (r.title || r.label || t.text.defaultNodeName) + "</a>" : '<span title="' + (r.title || r.label || t.text.defaultNodeName) + '" class="' + y + (r.disabled ? " " + d : "") + '" >' + (r.title || r.label || t.text.defaultNodeName) + "</span>"

            }(), "</div>", function () {

                if (!t.edit) return "";

                var e = {

                    add: '<i class="layui-icon layui-icon-add-1"  data-type="add"></i>',

                    update: '<i class="layui-icon layui-icon-edit" data-type="update"></i>',

                    del: '<i class="layui-icon layui-icon-delete" data-type="del"></i>'

                }, i = ['<div class="layui-btn-group layui-tree-btnGroup">'];

                return t.edit === !0 && (t.edit = ["update", "del"]), "object" == typeof t.edit ? (layui.each(t.edit, function (a, n) {

                    i.push(e[n] || "")

                }), i.join("") + "</div>") : void 0

            }(), "</div></div>"].join(""));

        l && (h.append(o), n.tree(o, r.children)), e.append(h), h.prev("." + s)[0] && h.prev().children(".layui-tree-pack").addClass("layui-tree-showLine"), l || h.parent(".layui-tree-pack").addClass("layui-tree-lineExtend"), n.spread(h, r), t.showCheckbox && (r.checked && n.checkids.push(r.id), n.checkClick(h, r)), t.edit && n.operate(h, r)

    })

}

4：修改節點展開方法b.prototype.spread，修改後代碼以下【備註：//TODO 部分標識的是layui原始代碼】

b.prototype.spread = function (e, a) {

var n = this, t = n.config, r = e.children("." + p), l = r.children("." + f), c = r.find("." + o),

        k = r.find("." + y), m = t.onlyIconControl ? c : l, x = "";

    m.on("click", function (i) {

        var ax = e.children("." + v),//TODO a衝突改爲ax

            //TODO 修改源碼

            //n = m.children(".layui-icon")[0] ? m.children(".layui-icon") : m.find(".layui-tree-icon").children(".layui-icon");

            n = m.children(".layui-icon")[0] ? m.find(".layui-tree-iconClick").children(".layui-icon") : m.find(".layui-tree-icon").children(".layui-icon");

        if (ax[0]) {  //TODO a改成ax

            //TODO 展開節點

            if (!e.hasClass(c) && !e.hasClass(C)) {

                t.spread && t.spread({

                    elem: e,

                    state: a.children.length > 0,

                    data: a

                })

            }

            //TODO 註釋掉源碼

            /*if (e.hasClass(C)) e.removeClass(C), a.slideUp(200), n.removeClass(u).addClass(h); else if (e.addClass(C), a.slideDown(200), n.addClass(u).removeClass(h), t.accordion) {

                var r = e.siblings("." + s);

                r.removeClass(C), r.children("." + v).slideUp(200), r.find(".layui-tree-icon").children(".layui-icon").removeClass(u).addClass(h)

            }*/

            //TODO 節點展開效果調整添加Begin

            if (e.hasClass(C) && !$(i.target).hasClass("layui-tree-txt")) {

                e.removeClass(C), ax.slideUp(200)

                //修改源碼，調整無實線狀態時三角圖標有動畫

                if (!t.showLine) {

                    m.find('span .layui-icon').removeClass(aa).addClass(bb)

                } else {

                    n.removeClass(u).addClass(h)

                }

            } else if (e.addClass(C), ax.slideDown(200), n.addClass(u).removeClass(h), t.accordion) {

                var r = e.siblings("." + s);

                r.removeClass(C), r.children("." + v).slideUp(200), r.find(".layui-tree-icon").children(".layui-icon").removeClass(u).addClass(h)

            } else if (!t.showLine) {

                m.find('span .layui-icon').removeClass(bb).addClass(aa)

            } //TODO 節點展開效果調整添加End

        } else x = "normal"

    })

5：b.prototype.spread 方法修改中，有兩處樣式添加 aa 、bb:以下所示

須要在tree.js中頂部樣式變量處添加。

步驟2：方案落地
解決問題1：異步加載子節點

下面是狐小E智慧辦公（https://www.hixiaoe.com ）後臺通信錄模塊中，部門樹渲染加載的業務邏輯，其核心邏輯就是經過父節點ID查詢子節點數據，綁定tree組件的spread函數，捕捉節點的展開事件，用戶點擊樹節點，根據當前節點ID查詢下一級節點，若是children節點有數據，則調用tree的children函數動態地渲染子節點。

//獲取部門樹

function LoadDeptTree() {

$.ajax({

url: "${ctx}/dept/tree/one-level?parentId=0",

dataType: "json",

async: true,

type: "GET",

success: function (resp) {

  if (resp && resp.msgcode == 0) {

    //無鏈接線風格

    deptTree =tree.render({

      elem: '#leftTreeArea'

      ,id:'leftTreeArea'

      , data: resp.data

      , showLine: false  //是否開啓鏈接線

      , click: editDept

      , spread: function (obj) {

         if (!obj.state) {

          // 懶加載子節點，異步獲取data數據這裏根據obj.data.id向後臺請求當前節點數據

          $.ajax({

            url: "${ctx}/dept/tree/one-level?parentId="+obj.data.id,

            dataType: "json",

            async: true,

            type: "GET",

            success: function (resp) {

              //當前節點展開，若是下一層有children，則調用樹的children方法，動態渲染子節點

              if (resp && resp.msgcode == 0) {

                //第一個參數是樹綁定的頁面元素ID

                //第二個參數是當前展開節點的ID

                //第三個參數是當前節點子節點的數據（數據格式參照layui的tree組件數據格式）

                tree.children(deptTree.config.id, obj.data.id, resp.data);

              }

            }

          });

        }

      }

    });

  } else {

    alert("加載部門樹失敗")

  }

},

error:function(XMLHttpRequest, textStatus, error){

  if (error.code == 19) {

    window.location.reload();

  }else{

    alert("加載部門樹失敗");

  }

}

});

}

解決問題2：父部門添加子部門，局部動態更新視圖

選中父部門，動態地爲父部門添加一個子部門，添加成功將新增的子部門局部渲染到總體部門樹中。下面是添加子部門後，js調用一下我本身的refreshTreeNode函數，函數裏有操做layui.tree的局部更新視圖的代碼，以下:

若是想下載咱們修改後的代碼，請點擊：

https://oa.hixiaoe.com/static/layui-v2.5.x/src/lay/modules/tree.js

做者介紹：小文文，狐小E智慧辦公（https://www.hixiaoe.com ）開發工程師，專一移動辦公軟件的SaaS平臺建設以及輕應用開發