您如何使用 CursorPagination 获取当前光标？

Question

默认情况下，CursorPagination 为您提供下一个和上一个光标。有没有办法获取当前光标？

Answer 1

CusorPagination 类只是从查询字符串中读取值并对其进行解码以供内部使用。如果您想知道刚刚发出的请求的当前位置，您可以简单地做同样的事情。由于分页器实例在使用后被丢弃，因此您无法偷看。

即使可以，您也会得到“解码”的光标值，您必须重新编码才能稍后再次发送。

# from rest_framework/pagination.py@CursorPagination.paginate_queryset
encoded = request.query_params.get(self.cursor_query_param)

# read it yourself somewhere in your view/viewset
current_value = request.query_params.get('cursor')

如果您想更改一般行为，只需进行自定义实现并返回附加字段。在视图上将其设置为您的pagination_class（如果它是全局的，则在设置中）。

未测试示例代码：

class FancyCursorPagination(CusorPagination):

    def get_paginated_response(self, data):
        return Response(OrderedDict([
            ('next', self.get_next_link()),
            ('previous', self.get_previous_link()),
            ('current', self.get_current_link()),
            ('results', data)
        ]))

    def get_current_link(self):
        """ 
        Return a link to the current position. 
           - self.cursor set in the paginate_queryset() method.
        To return only the query parameter in this field, use:
           - return request.query_params.get(self.cursor_query_param, None)
        """
        if self.cursor:
            return self.encode_cursor(self.cursor)
        else:
            # cursor will be None on the first call
            return None

    def get_paginated_response_schema(self, schema):
        new_schema = super().get_paginated_response_schema(schema)
        new_schema["properties"]["current"] = {
            "type": "string", 
            "nullable": True
        }
        return new_schema

class MyApiView(APIView):
    pagination_class = FancyCursorPagination