DIV CSS 佈局教程網

EasyUI TreeGrid 前端過濾功能的三次思路迭代
編輯:JQuery入門技巧     

這一周都在糾結 easyui 的 treegrid 過濾功能,起因是項目裡一個「莫名其妙」的需求。

先說背景。easyui 素有「後端程序員的前端框架」之稱,話雖如此,真要脫離 api 文檔去手寫節點結構,我還真是無從下手,這裡先向前端同學致敬。

需求本身很樸素:某個界面用 treegrid 展示數據,開發時沒做分頁。測試環境數據漲到 456 條之後,想在其中找到某一條再處理,費時費力到無法接受。於是決定加一個過濾搜索功能。

我以為這是調一下 api 的事——畢竟 datagrid 有官方的 datagrid-filter.js 擴展。但翻遍文檔,treegrid 並沒有現成的過濾方法,只找到 loader 和 loadFilter 兩個屬性看起來沾點關係。網上的資料也很少,論壇裡的提問基本都沒人回。

思路一:後端條件查詢 + loadData

最早看到的方案是:不用 treegrid 的 url 加載,改為異步 ajax 帶條件查詢,拿到結果後交給 loadData 渲染。

function searchROM() {
  var product = $('#Product').combobox('getValue');
  var keytype = $('#keytype').combobox('getValue');
  var keywords = $('#keywords').val();

  var url = encodeURI('/GoodsROM/ROMList?product=' + product
    + '&keytype=' + keytype
    + '&keywords=' + keywords
    + '&' + Math.random());

  $.post(url, {}, function (data) {
    var d = data;                       // 返回 json 格式結果
    $('#grid').treegrid('loadData', d); // 加載數據更新 treegrid
  }, 'json');
}

想法沒問題,但在我們的項目裡行不通:後端邏輯封裝在通用層(General)裡,改動影響面太大,動不起。只能回到 api,試試 loader 和 loadFilter。

思路二:loadFilter 過濾 + 每次重新 load

loadFilter: function (data) {
  var newData = new Array();
  var filter = $('#filter').val();

  for (var i = 0; i < data.length; i++) {
    if (data[i].nodeName.indexOf(filter) > 0) {
      newData.push(data[i]);
    }
  }

  if (newData.length == 0) {
    return data;
  } else {
    return newData;
  }
},

loadFilter 的職責就是「拿到原始數據,返回處理後的數據」,寫起來確實順手。查詢功能實現了,但代價是每次搜索都要重新請求一次數據庫。本來頁面初始化的查詢耗時就已經 20 秒,查一次 20 秒、再查一次又 20 秒,誰都受不了。版本被打回。

思路三:首次加載後把數據緩存在前端

沿著上一版繼續想:既然訪問數據庫慢,那我把第一次的結果存下來,後續過濾全在前端做,不就不用反覆請求了?

於是 loadFilter 裡不再做任何邏輯判斷,只負責把原始數據快照一份到全局變量,過濾行為挪到獨立函數裡,由搜索按鈕觸發:

var allData = new Array();

function doOrgChartInit(idTreeGrid, idMenu, idUriQuery) {
  var bFound = true;

  $('#' + idTreeGrid).treegrid({
    rownumbers: true,
    animate: true,
    collapsible: true,
    fitColumns: true,
    url: idUriQuery,
    idField: 'nodeId',
    treeField: 'nodeName',
    loadFilter: function (data) {
      // 只在首次加載時快照一份完整數據
      if (bFound && data[0].nodeName != 'Root') {
        allData = data;
        bFound = false;
      }
      return data;
    },
    columns: [[
      { halign: 'center', align: 'left', field: 'nodeName', title: '名稱', width: 200 },
      { halign: 'center', align: 'left', field: 'description', title: '描述', width: 100 }
    ]],
    // ------------------ 工具欄 ------------------
    toolbar: [
      {
        text: '<input id="filter" type="text" />',
      },
      {
        iconCls: 'icon-search',
        handler: function () {
          doFilter(idTreeGrid);
        }
      }
    ],
    onContextMenu: function (e, row) {
      e.preventDefault();
      $(this).treegrid('select', row.nodeId);
      $('#' + idMenu).menu('show', { left: e.pageX, top: e.pageY });
    }
  });
}

function doFilter(idTreeGrid) {
  var newData = new Array();
  var filter = $('#filter').val();

  if (allData.length == 0) {
    alert('請先點擊 Root 初始化界面');
    return false;
  }

  for (var i = 0; i < allData.length; i++) {
    if (allData[i].nodeName.indexOf(filter) > 0) {
      newData.push(allData[i]);
    }
  }

  if (filter == '') {
    $('#' + idTreeGrid).treegrid('loadData', allData);
  } else {
    $('#' + idTreeGrid).treegrid('loadData', newData);
  }
}

效果終於達標:只在初始化時查一次數據庫,之後所有搜索都在內存裡完成,響應是瞬時的。

回頭看,這版代碼還有幾處要改

  • indexOf(filter) > 0 是錯的。當匹配發生在字符串首位時 indexOf 返回 0,會被判為不匹配。應寫成 >= 0,或者更乾脆地用 indexOf(filter) !== -1。
  • 只過濾一層是不夠的。treegrid 的數據是帶父子關係的,如果只保留命中的節點,父節點被過濾掉之後子節點就無處掛載,界面會出現孤兒行甚至不顯示。正確做法是把命中節點的所有祖先一併加入結果集,必要時也把子孫帶上。
  • 用 bFound 判斷首次加載太脆弱。依賴 data[0].nodeName != 'Root' 這種業務約定,一旦根節點名稱調整就失效。更清晰的方式是在 load 成功回調(onLoadSuccess)裡做快照。
  • allData 是全局變量。多處使用時容易互相污染,封裝到一個對象或閉包裡會更安全。

三次迭代下來最大的收穫不是這段代碼,而是一個判斷順序:先看 api 有沒有現成能力,再看能不能在渲染層解決,最後才考慮動數據源。loadFilter 之所以合適,正是因為它給了一個「攔截並替換渲染數據」的入口,讓我們不必觸碰後端。

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