本文详细介绍 jQuery DataTable 在后端的 Java 封装实现。通过定义数据转换类、基础控制器及具体查询方法,展示如何将数据库结果转换为前端所需的二维数组格式。重点强调后端返回的数组对象属性数量必须与前端显示的列数保持一致,以确保数据正确渲染。
数据转换类定义
首先定义用于接收和返回数据的转换类。该类包含总记录数、显示记录数、Echo 标识以及用于存储表格数据的二维数组字段,并提供相应的构造函数和 Getter/Setter 方法,以便将后端数据格式化为 DataTable 可识别的结构。
public class DataTableReturnObject {
private int iTotalRecords;
private int iTotalDisplayRecords;
private String sEcho;
private String[][] aaData;
public DataTableReturnObject(int totalRecords, int totalDisplayRecords, String echo, String[][] d) {
this.setiTotalRecords(totalRecords);
this.setiTotalDisplayRecords(totalDisplayRecords);
this.setsEcho(echo);
this.setAaData(d);
}
public void setiTotalRecords(int iTotalRecords) {
this.iTotalRecords = iTotalRecords;
}
public int getiTotalRecords() {
return iTotalRecords;
}
public void setiTotalDisplayRecords(int iTotalDisplayRecords) {
this.iTotalDisplayRecords = iTotalDisplayRecords;
}
public int getiTotalDisplayRecords() {
return iTotalDisplayRecords;
}
public void setsEcho(String sEcho) {
this.sEcho = sEcho;
}
public String getsEcho() {
return sEcho;
}
public void setAaData(String[][] aaData) {
this.aaData = aaData;
}
public String[][] getAaData() {
return aaData;
}
}
基础控制器封装
2帮助类
public class BaseController {
protected JSONResponse successed(Object obj) {
JSONResponse ret = new JSONResponse();
ret.setSuccessed(true);
ret.setReturnObject(obj);
return ret;
}
}
列表查询方法实现
在实现类中,编写具体的列表查询方法。该方法接收 HTTP 请求和响应对象以及 Echo 参数,首先解析前端传来的 aoData 参数,将其转换为 JSONArray 并提取分页相关的起始位置和长度信息。随后调用具体的业务查询逻辑获取数据,最后实例化数据转换对象,传入总记录数、显示记录数和解析后的数据数组,通过基础控制器返回成功响应。
public JSONResponse searchList(HttpServletRequest request , HttpServletResponse response ,String sEcho) throws Exception {
//convertToMap定义于父类,将参数数组中的所有元素加入一个HashMap
Map<Object, Object> objQueryMap = new HashMap<Object, Object>();
String jsondata = request.getParameter("aoData");
JSONArray jsonarray = JSONArray.fromObject(jsondata);
String strDisplayStart ="";
String strDisplayLength="";
String[] arrayColumen = new String[new JSONUser().toArray().length];
int strSortId = 0;
String strSort = "";
for(int i=0;i<jsonarray.size();i++) //从传递参数里面选出待用的参数
{
JSONObject obj=(JSONObject)jsonarray.get(i);
String strName = (String)obj.get("name");
String strValue = obj.get("value").toString();
if(strName.equals("sEcho")){
sEcho=strValue;
}
if(strName.equals("iDisplayStart")) {
strDisplayStart=strValue;
}
if(strName.equals("iDisplayLength")) {
strDisplayLength=strValue;
}
if(strName.equals("sColumns")){
arrayColumen = obj.get("value").toString().split(",");
}
if(strName.startsWith("iSortCol_")){
strSortId = Integer.parseInt(strValue) ;//排序列数
}
if(strName.startsWith("sSortDir_")){
strSort = strValue;//排序的方向 "desc" 或者 "asc".
}
}
Map<Object, Object> params = new HashMap<Object, Object>() ;
try {
params = managerService.getUserList(参数);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
String count = (String)params.get("COUNT");//总数
String[][] strData = (String[][])params.get("AO_DATA");//当前页显示的集合
return successed(new DataTableReturnObject(Integer.parseInt(count) , Integer.parseInt(count), sEcho, strData));
}
具体数据查询逻辑
具体查询方法负责从数据库或业务层获取用户列表数据。它将查询结果转换为二维字符串数组,如果列表不为空,则遍历列表中的每个用户对象,利用 BeanUtils 复制属性到 JSONUser 对象,并调用其 toArray 方法生成数组行。最后,将处理后的数据数组和总记录数存入查询参数 Map 中,供上层方法使用。
public Map<Object, Object> getUserList(Map<Object, Object> queryParams)
throws Exception {
String iCount = 总记录数;
// 将查询结果转换为一个二维数组
String[][] data = {};
if (lstUser != null && lstUser.size() > 0) {
int record = lstUser.size();
data = new String[record][];
for (int i = 0; i < lstUser.size(); i++) {
User objUser = (User) lstUser.get(i);
JSONUser jsonUser = new JSONUser();
BeanUtils.copyProperties(jsonUser, objUser);
data[i] = jsonUser.toArray();
}
}
queryParams.clear();// 情况map,重新设值使用
queryParams.put("AO_DATA", data);
queryParams.put("COUNT", iCount);
return queryParams;
}
关键注意事项
在实现过程中,必须注意存放的数组对象的属性数量必须与前端页面显示的列数保持完全一致。如果后端返回的数组列数与前端定义的 DataTable 列数不匹配,可能导致数据显示异常或前端脚本报错。