如何在 django rest 框架中使用数据表服务器端处理

Question

我尝试使用datatables：服务器端处理

我有一个看法：

class DataList(generics.ListAPIView):
    queryset = Data.objects.all()
    serializer_class = DataSerializer
 

还有我的html：

$(document).ready(function() {
   $('#example').dataTable( {

        "processing": true,   
        /* serverSide:true  */        
        "deferRender": true,           
        "iDisplayLength": 25,
        "paging": true,
        ajax: {
         url: 'http://127.0.0.1:8000/api/datas/',
         dataSrc: ''
        },
       columns: [
            { "data": "id"},
            { "data": "name"},
            { "data": "update_time"},
            { "data": "description"},
        ]
   });

});

这很好用。

然后我将serverSide:true 注释掉：

$(document).ready(function() {
   $('#example').dataTable( {

        "processing": true,   
        "serverSide": true,        
        "deferRender": true,           
        "iDisplayLength": 25,
        "paging": true,
        ajax: {
         url: 'http://127.0.0.1:8000/api/datas/',
         dataSrc: ''
        },
       columns: [
            { "data": "id"},
            { "data": "name"},
            { "data": "update_time"},
            { "data": "description"},
        ]
   });

});

paginator 和 search 和 ordering 不再起作用
好像是查询所有数据。

我看到数据表的例子是用 php。
我想将datatable与django rest框架集成，我还应该设置什么？？

Answer 1

首先，阅读一些关于数据表的服务器端处理的文档：https://datatables.net/manual/server-side。它会告诉你什么数据表发送到后端以及它想要返回什么。只需提供所需的参数即可。

然后让我给你看一些我作品中的代码。这不是完整的示例，但您会知道将什么传递回datatable() 函数。

一些常量：

import json


DEFAULT_START_POSITION = 0
DEFAULT_PAGE_SIZE = 10
DEFAULT_SORTING_COLUMN_INDEX = 1
DEFAULT_SORTING_METHOD = 'asc'

#constants for querying
ORDER_DICT = {
    0: 'field1',
    1: 'field2',
}

ORDER_BY = {
    'desc': '-',
    'asc': ''
}

QUERY_FIELDS = ['field1', 'field2']

Python代码的主要部分：

def get_sorting(self, request_values):
    return int(request_values.get('iSortCol_0', self.DEFAULT_SORTING_COLUMN_INDEX)),\
           request_values.get('sSortDir_0', self.DEFAULT_SORTING_METHOD).lower()

def get_paging(self, request_values):
    return int(request_values.get('iDisplayStart', self.DEFAULT_START_POSITION)),\
               int(request_values.get('iDisplayLength', self.DEFAULT_PAGE_SIZE))

def render_records(self, current_page_members, query):
    # list to be returned for aaData
    records = []
    # ... do something to put data in the list and return
    return records

def get(self, request):
    # ... receive the request
    # paging
    start, page_size = self.get_paging(request_values)
    # sorting
    sort_column, sort_by = self.get_sorting(request_values)

    # research query
    query = request_values.get('sSearch', '')  # get search term from datatable request
    query_combined = self.get_combined_query(query)

    all_records, filter_count, current_page_records = \
        self.get_member_list(request_values, company_id, query_combined, sort_by, sort_column, start, page_size)

    # json dict to be returned
    records = {
        'iTotalRecords': all_records.count(),    # The total count of records in your database, if query exist, it is the count of filtered records
        'sEcho': request_values.get('sEcho', '0'),    # Represents the rendering count of datatable
        'aaData': [],    # Main data to be rendered in table
    }

    # if no query, all records returned
    records.update({'iTotalDisplayRecords': filter_count if query else records['iTotalRecords']})

    # update aaData list for records
    records['aaData'].extend(self.render_records(current_page_records, query))

    return HttpResponse(json.dumps(records), content_type='application/json')

请再次注意，这不是一个完整的示例，您应该根据自己的需求对其进行扩展。

Answer 2

在您看来，您将返回查询集中的所有元素。

您可以使用 ajax 请求中给出的值对结果进行切片。 Datatables 在 ajax 请求中提供了 'start' 和 'length' 值，您可以使用它们来获取正确的集合以返回分页。例如：

start = int(request.POST.get('start', 0))
end = int(request.POST.get('length', 20))

queryset = Data.objects.filter()
queryset = queryset[start:start+end]

请注意，为了使分页正常工作，Datatables 需要 server-side processing 的其他值，例如 recordsTotal 和 recordsFiltered