datatables的使用

在开发web项目中，界面就是一个以丰富友好的样式来展现数据的窗口，同样的数据不用的展现形式给人不同的体验，数据列表是数据是一种常见展现形式，对于数据列表的一个最基本的要求就是能够实现分页以及检索功能。

datatables是一个不错的基于jQuery的前端框架，它除了满足我们基本的分页和检索要求还有其他高级的功能。如果对datatables的高级功能感兴趣可以查看官网的API了解具体如何使用。

下面是一些datatables的常用的初始化配置。

页面HTML代码如下

1. <table width="100%" class="display" id="dataGrid" cellspacing="0">
2. <thead>
3. <tr>
4. <th>主键</th><th>序号</th><th>接口名称</th><th>问题类型</th><th>问题内容</th><th>咨询时间</th><th>联系人</th><th>处理状态</th><th>完成日期</th><th>问题细节</th><th>批次号</th><th>操作</th>
5. </tr>
6. </thead>
7. </table>

在正式使用datatables的脚本之前我们需要做一些准备工作引入脚本文件等参考如下下面的文件中并没有提到jquery和datatables脚本文件。这个两个脚本文件 handlerbars是一个js模板引擎框架，fnReloadAjax是datatables的一个plugin插件。我们使用到了这两个js脚本。

1. <script src="${ctp}/js/handlebars-v4.0.5.js"></script>
2. <script src="${ctp}/js/fnReloadAjax.js"></script>
3. <script id="tpl" type="text/x-handlebars-template">
4. {{#each func}}
5. <button type="button" class="btn{{this.type}}" onclick="{{this.fn}}">{{this.name}}</button>
6. {{/each}}
7. </script>

下面是datatables核心的js脚本内容

1. function initDataGrid(){
2. var tpl = $("#tpl").html();
3. //预编译模板
4. var template = Handlebars.compile(tpl);
5. /**************初始化数据表格****************************/
6. dataTable = $("#dataGrid").dataTable({
7. "language": {
8. "url": "${ctp}/jqueryplugin/datatables/js/Chinese.json"
9. },
10. //processing: true,
11. serverSide: true,
12. ajax: {
13. url: '${ctp}/rest/dock/listDockQuestion',
14. type: 'POST'
15. },
16. /**
17. id,moId,createTime,processDate,questionType,
18. questionContent,accessChannel,contactId,processResult,processDescription
19. interfaceId,questionDetail,batchId,contactName,sequence
20. */
21. "columns": [
22. { "data": "id","targets": -1,"visible": false  },
23. { "data": "sequence","targets": 0 },
24. { "data": "interfaceId","targets": 1 },
25. { "data": "questionType" ,"targets": 2},
26. { "data": "questionContent","targets": 3 },
27. { "data": "processDate" ,"targets": 4},
28. { "data": "contactName" ,"targets": 5},
29. { "data": "processResult" ,"targets": 6} ,
30. { "data": "processDate" ,"targets": 7},
31. { "data": "questionDetail" ,"targets": 8},
32. { "data": "batchId" ,"targets": 9,"visible": false }
33. ],
34. //自定义功列
35. "columnDefs": [
36. {
37. "render": function ( data, type, row ) {
38. return $("#interfaceId_"+data).val();
39. },
40. "targets": 2
41. },
42. {
43. "render": function ( data, type, row ) {
44. return $("#questionType_"+data).val();
45. },
46. "targets": 3
47. },
48. {
49. "render": function ( data, type, row ) {
50. return $("#processResult_"+data).val();
51. },
52. "targets": 7
53. },
54. {
55. "render": function ( data, type, row ) {
56. var questionType=row['questionType'];
57. return $("#TEC_PROBLEM_"+questionType+"_DETAIL_"+data).val();
58. },
59. "targets": 4
60. },
61. {
62. "render": function ( data, type, row ) {
63. var status=row['processResult'];
64. var context =null;
65. if("99"==status){
66. context =
67. {
68. func:[
69. {"name": "详", "fn": "viewDockQuestion('"+row['id']+"')", "type": "5"}
70. ]
71. };
72. }else{
73. context =
74. {
75. func:[
76. {"name": "办", "fn": "updateDockQuestion('"+row['id']+"')", "type": "5"}
77. ]
78. };
79. }
80. var html = template(context);
81. return html;
82. },
83. "targets": 11
84. }
85. ],
86. //创建行回调函数  创建行之后
87. "createdRow": function ( row, data, index ) {
88. tmpData.push(data);
89. }
90. });
91. dataGrid=dataTable;
92. }

columnDefs属性render 用来自定义表格显示的数据，通常我们有些反显数据时会用到，以及我们自定义一些操作写一下function时会使用到 target 用来指向表格的哪一列。 createdRow   事件是指创建完一行之后触发的事件，通过这一事件我们可以做些我们需要的工作。

接下来就是如何解决服务端如何分页的问题，下面是一段Java代码供大家进行参考，在代码之后我会进行一个简单描述

1. @POST
2. @Path("listDockQuestion")
3. @Produces(MediaType.APPLICATION_JSON)
4. public Object getDockQuestionList(@FormParam(value = "start") long start, @FormParam(value = "length") long length,
5. @FormParam(value = "draw") String draw) {
6. /**
7. * { "draw": 1, "recordsTotal": 57, "recordsFiltered": 57, "data": [ { }]}
8. */
9. // 获取Datatables发送的参数 必要
10. // 定义查询数据总记录数
11. // 条件过滤后记录数 必要recordsFiltered
12. // 表的总记录数 必要 recordsTotal
13. Map<String, Object> paramMap = new HashMap<String, Object>();
14. paramMap.put("start", start);
15. paramMap.put("length", length);
16. paramMap.put("end", start + length);
17. Map<String, Object> respMap = new HashMap<String, Object>();
18. // respMap.put("draw", "1");
19. Long sum = dockService.countDockQuestion(paramMap);
20. respMap.put("recordsTotal", sum);
21. respMap.put("recordsFiltered", sum);
22. respMap.put("data", dockService.listDockQuestion(paramMap));
23. return respMap;
24. }

  { "draw": 1, "recordsTotal": 57, "recordsFiltered": 57, "data": [ { }]} 是要返回的json数据格式，datatables向服务端传的参数中两个重要参数是我们分页使用到的，（start +1） 是从数据库中的哪一行开始取值，如果要去第11行的数据开始取值，start会传入10，而length是指要取多少行数据，这对于mysql数据的分页写sql非常方便只需要在自己SELECT语句之后加上 LIMIT  start, length  。draw是请求的序号，start是数据的偏移量，length是需要返回的最大数据条数

        下面一段代码是表格异步刷新的插件fnReloadAjax代码

1. /**
2. * By default DataTables only uses the sAjaxSource variable at initialisation
3. * time, however it can be useful to re-read an Ajax source and have the table
4. * update. Typically you would need to use the `fnClearTable()` and
5. * `fnAddData()` functions, however this wraps it all up in a single function
6. * call.
7. *
8. * DataTables 1.10 provides the `dt-api ajax.url()` and `dt-api ajax.reload()`
9. * methods, built-in, to give the same functionality as this plug-in. As such
10. * this method is marked deprecated, but is available for use with legacy
11. * version of DataTables. Please use the new API if you are used DataTables 1.10
12. * or newer.
13. *
14. *  @name fnReloadAjax
15. *  @summary Reload the table's data from the Ajax source
16. *  @author [Allan Jardine](http://sprymedia.co.uk)
17. *  @deprecated
18. *
19. *  @param {string} [sNewSource] URL to get the data from. If not give, the
20. *    previously used URL is used.
21. *  @param {function} [fnCallback] Callback that is executed when the table has
22. *    redrawn with the new data
23. *  @param {boolean} [bStandingRedraw=false] Standing redraw (don't changing the
24. *      paging)
25. *
26. *  @example
27. *    var table = $('#example').dataTable();
28. *
29. *    // Example call to load a new file
30. *    table.fnReloadAjax( 'media/examples_support/json_source2.txt' );
31. *
32. *    // Example call to reload from original file
33. *    table.fnReloadAjax();
34. */
35. jQuery.fn.dataTableExt.oApi.fnReloadAjax = function ( oSettings, sNewSource, fnCallback, bStandingRedraw )
36. {
37. // DataTables 1.10 compatibility - if 1.10 then `versionCheck` exists.
38. // 1.10's API has ajax reloading built in, so we use those abilities
39. // directly.
40. if ( jQuery.fn.dataTable.versionCheck ) {
41. var api = new jQuery.fn.dataTable.Api( oSettings );
42. if ( sNewSource ) {
43. api.ajax.url( sNewSource ).load( fnCallback, !bStandingRedraw );
44. }
45. else {
46. api.ajax.reload( fnCallback, !bStandingRedraw );
47. }
48. return;
49. }
50. if ( sNewSource !== undefined && sNewSource !== null ) {
51. oSettings.sAjaxSource = sNewSource;
52. }
53. // Server-side processing should just call fnDraw
54. if ( oSettings.oFeatures.bServerSide ) {
55. this.fnDraw();
56. return;
57. }
58. this.oApi._fnProcessingDisplay( oSettings, true );
59. var that = this;
60. var iStart = oSettings._iDisplayStart;
61. var aData = [];
62. this.oApi._fnServerParams( oSettings, aData );
63. oSettings.fnServerData.call( oSettings.oInstance, oSettings.sAjaxSource, aData, function(json) {
64. /* Clear the old information from the table */
65. that.oApi._fnClearTable( oSettings );
66. /* Got the data - add it to the table */
67. var aData =  (oSettings.sAjaxDataProp !== "") ?
68. that.oApi._fnGetObjectDataFn( oSettings.sAjaxDataProp )( json ) : json;
69. for ( var i=0 ; i<aData.length ; i++ )
70. {
71. that.oApi._fnAddData( oSettings, aData[i] );
72. }
73. oSettings.aiDisplay = oSettings.aiDisplayMaster.slice();
74. that.fnDraw();
75. if ( bStandingRedraw === true )
76. {
77. oSettings._iDisplayStart = iStart;
78. that.oApi._fnCalculateEnd( oSettings );
79. that.fnDraw( false );
80. }
81. that.oApi._fnProcessingDisplay( oSettings, false );
82. /* Callback user function - for event handlers etc */
83. if ( typeof fnCallback == 'function' && fnCallback !== null )
84. {
85. fnCallback( oSettings );
86. }
87. }, oSettings );
88. };

        下面的脚本是如何调用该插件来实现datatables异步刷新

1. dataGrid.fnReloadAjax();