欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

jQuery插件DataTables分页开发心得体会

程序员文章站 2022-11-26 12:57:42
写blog目的:不是为人气,只是留份笔记;啰嗦不要紧,只怕有遗漏,以后想不起来。 官网: 中文官网: 开发环境:python 3.6.0、anaconda 4.3....

写blog目的:不是为人气,只是留份笔记;啰嗦不要紧,只怕有遗漏,以后想不起来。

官网:
中文官网:

开发环境:python 3.6.0、anaconda 4.3.1、django、jetbrains pycharm 2017.1.5

按我项目的开发过程简单整理。

1、第一版本,无分页。

在此之前有用到过datatables(更多的是easyui中的datagrid,另之前服务端是php),因此想着前端/客户端差异不大,服务端反正都是按规范格式返回json串(django的代码后续再整理)。另外,刚开始也没想着表格分页,只是有三个字段排序需求(排序已在服务端做好并返回)。
datatables基础代码:

//表格的html代码略过
$('#dtlist').datatable({
        "bpaginate": false, //翻页功能
        "binfo": false,//页脚信息
        "ordering": false, //不排序
        "searching": false,  //搜索框,不显示
        "blengthchange": false, //改变每页显示数据数量,不显示
        "idisplaylength": 10,  //每页默认显示数量(不显示了,这个设置也起不了作用)
        "serverside":true, //服务端
        "retrieve":false, //意思是如果已经初始化了,则继续使用之前的datatables实例。

        "ajax": {
          "type": "post",
          "url": "/manage/getlist/",
          "data":{'csrfmiddlewaretoken': '{{ csrf_token }}'}, //django的token值
          "datasrc": function (result) { //使用datasrc属性来设置获取到的数据格式,其值是服务端拼好的key-value(数据字段名称-字段值)【服务端走了弯路,后续有时间再写文章说明】
            var json = json.parse(result).data;
            return json;
          }
        },
        "columns": [ //表格要显示的列定义(字段名称做了处理)
          { "data": "field0",
            "visible":false,
            "render": function ( data, type, full, meta ) {
              //return '<input type="checkbox"/>';
              return data;
            }
          },
          { "data": "field1" },
          { "data": "field2" , //此列名要与服务端返回的json串中的值一致
            "render": function ( data, type, full, meta ) {
              return '<div style="text-align:left">'+data+'</div>';
            }
          },
          //其余字段定义省略
          ]
        });

2、加上分页功能

第一个程序写好几天后就准备加上分页功能。
datatables的json串格式要求:

{
  "draw": n, 
  "recordstotal": n, //总记录数
  "recordsfiltered": n, //条件过滤后的记录数,与总记录数可能会不同
  "data": [{}] //获取到的记录集合
}

按照之前处理easyui中datagrid组件的经验,得到总记录数,筛选后的记录数等值,拼好json串回传就行,客户端可以直接实现分页。

可是,问题来了:draw的值怎么控制?

查了资料,也跟踪了下浏览器的header,知道draw是datatables本身的一个属性值 ,每次获取数据时都会向服务端传,不需要改这个值,直接在json串中回传就好。试了下,不知道问题出在哪,好像分页也不行,而且总感觉这种控制方法有点累。

换个思路再查资料,就是服务端分页(按需请求相应数据),还真有:django-datatables-view(datatables for django,),按其安装步骤来就好,这样子就不用考虑json串几个值怎么拼的问题了,这个组件会做好。

改进后的前端代码:

$('#dtlist').datatable({
    "bpaginate": true, //翻页功能
    "binfo": true,//页脚信息
    "ordering":true, //开启排序
    "searching": false, //搜索框,不显示
    "blengthchange": true, //改变每页显示数据数量,不显示
    "alengthmenu": [[5, 10, 25, 50, -1], [5, 10, 25, 50, "all"]], //每页显示记录菜单选项
    "idisplaylength": 10, //每页默认显示数量
    "serverside":true, //开启服务端请求模式
    'pagingtype': 'full_numbers',
    "retrieve":true,

    "ajax": { //这边就不需要datasrc属性来处理值了
     "type": "get",
     "url": "{% url 'scheme_list_json' %}",
     "data":{
      'ssearch':'',
      'csrfmiddlewaretoken': '{{ csrf_token }}'},
     },
    "columns": [ //表格要显示的列定义
     { "data": 0,
      "visible":false,
      "render": function ( data, type, full, meta ) {
       //return '<input type="checkbox"/>';
       return data;
      }
     },
     { "data": 1
     "bsortable":false
     },
     { "data": 2,
      "bsortable":false, //此字段不排序
      "render": function ( data, type, full, meta ) {
       return '<div style="text-align:left">'+data+'</div>';
      }
     },
     //其余字段定义省略
     ......
     ],
    "aasorting": [ //指定排序的列(索引从0开始)及规则
     [ 8, "asc" ],
     [ 9, "asc" ],
     [ 10, "desc" ]
     ],
    "drawcallback": function( settings ) { //绘制表格时的回调函数
     $("th").removeclass("sorting_asc"); //删除排序图标,升序样式
     $("th").removeclass("sorting_desc");//降序样式 
   });

排序成功,但问题来了:开启排序功能后,表头行中会有排序的图标,但我们不需要它(只是排序,不需要点击),所以加上上面代码中的drawcallback回调函数,去掉其样式就好。
ps:
有个坑-服务端的回传字段和排序字段的列数一定要一一对应,前端datatables显示字段columns定义也要按这个顺序来,否则前端排序会乱,如:

 # 需要显示的字段
 columns = ['jyjhbid', 'tzbd', 'clsc', 'clzt', 'jlscrq', 'jlxgrq', 'clcz'] 

 # 排序
 order_columns = ['jyjhbid', 'tzbd', 'clsc', 'clzt', 'jlscrq', 'jlxgrq', 'clcz']

刚接触django-datatables-view,以为这两个集合值可以不同,所以。。。。多走了些路。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。