使用 EasyUI DataGrid 做多選時常會遇到一個痛點:一旦翻頁,之前勾選的行就丟了。本文記錄一套能讓勾選狀態跨頁保留的完整實現,並逐步拆解背後的原理。
核心思路是維護一個數組 idsArray 保存已選中行的主鍵,並借助 DataGrid 的幾個鉤子事件在數據加載前後做同步。
var $dg;
var $grid;
var ids = '';
var idsArray = new Array();
$(function () {
$dg = $("#dg");
$grid = $dg.datagrid({
url: "${getDataUrl}",
width: 'auto',
height: $(this).height() - 85,
pagination: true,
rownumbers: true,
border: true,
striped: true,
singleSelect: false,
checkOnSelect: true,
selectOnCheck: true,
onBeforeLoad: function (data) {
addSelectedGoodsIdToArray();
},
onLoadSuccess: function (data) {
var rowsData = data.rows;
if (idsArray.length != 0) {
$.each(idsArray, function (i, e) {
for (var index = 0; index < rowsData.length; index++) {
if (rowsData[index].goodsId == e) {
$dg.datagrid('selectRow', index);
}
}
});
}
},
onUncheck: function (rowIndex, rowData) {
if (idsArray.length != 0) {
for (var index = 0; index < idsArray.length; index++) {
if (idsArray[index] == rowData.goodsId) {
removeArrayValue(idsArray, rowData.goodsId);
break;
}
}
}
},
columns: [[
{ field: 'ck', checkbox: true },
{ field: 'goodsId', hidden: true },
{ field: 'goodsName', title: '商品標題', width: parseInt($(this).width() * 0.3) }
]],
toolbar: '#tb'
});
});
function addSelectedGoodsIdToArray() {
var rows = $dg.datagrid('getSelections');
if (rows.length > 0) {
$.each(rows, function (i, row) {
if (idsArray.length == 0) {
idsArray.push(row.goodsId);
} else {
for (var index = 0; index < idsArray.length; index++) {
if (idsArray[index] == row.goodsId) {
break;
}
if (index == idsArray.length - 1) {
idsArray.push(row.goodsId);
break;
}
}
}
});
}
}
function removeArrayValue(arr, val) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == val) {
arr.splice(i, 1);
break;
}
}
}

下面按遞進的方式梳理整個實現過程,每個問題都建立在前一個已解決的基礎上。
前台只需設置 pagination:true 顯示分頁工具列;後端則接收 page 與 rows 兩個參數,分別代表當前頁碼與每頁行數,並返回總數據量 total。
@RequestMapping("/getGoodsOnSale")
@ResponseBody
public GridModel getGoodsOnSale(HttpServletRequest request,
@RequestParam("page") Integer page,
@RequestParam("rows") Integer rows) {
// 根據 page、rows 查詢數據,並設置 total
GridModel gridModel = getGoods(goods, request);
gridModel.setTotal(total);
return gridModel;
}
需要三個設置:singleSelect:false 開啟複選模式;在列定義中加入 {field:'ck',checkbox:true} 讓該列渲染複選框;再把 checkOnSelect 與 selectOnCheck 都設為 true。前者保證點擊行時同步勾選複選框,後者保證點擊複選框時同步選中行。
由於翻頁本質上是重新向後端取數、重新加載的過程,因此可在 onBeforeLoad 中調用 addSelectedGoodsIdToArray,把當前選中行的主鍵存入 idsArray。需要注意的是,點擊「下一步」提交時也要先執行一次該方法,否則當前這一頁的選中內容尚未入列就會丟失。
另外,當把兩個同步屬性都設為 true 後,onClickRow 被觸發時會自動調用 onCheck 或 onUncheck(注意 onUncheck 的 check 首字母是小寫,寫錯會失效),因此取消勾選時的清理邏輯放在 onUncheck 裡即可。
同樣利用重新加載的特性,在 onLoadSuccess 中遍歷 idsArray,把當前行數據的主鍵與之匹配,命中就調用 $dg.datagrid('selectRow', index) 選中。這裡的 index 是從零開始的自然行號,並非主鍵值。只要把主鍵列以 hidden:true 隱藏,即可在後台取值而不影響界面展示。
掌握以上要點,就能讓 EasyUI DataGrid 在多頁多選場景下穩定保留勾選狀態。