Django rest framework分页实战教程

"Django rest framework实现分页的示例，通过PageNumberPagination和自定义分页类来管理API的返回结果" 在Django REST Framework中，分页是处理大量数据时非常重要的一个功能，它可以有效地提高API性能，避免一次性返回过多数据导致的网络延迟和客户端处理压力。本示例将介绍如何使用Django REST Framework的内置分页方式以及如何自定义分页类。 首先，我们来看基本的`PageNumberPagination`分页方法： 1. 在`urls.py`中，你需要设置一个视图，比如`Pager1View`，并指定对应的URL路径，这里使用了正则表达式捕获版本号参数。 2. 在`serializers.py`或类似文件中，定义一个序列化器，如`PagerSerialiser`，用于将数据库模型（如`Role`）转换为JSON格式，以便于返回给客户端。 3. 在`views.py`中，定义视图类`Pager1View`，继承自`APIView`。在`get`方法中，先获取所有数据，然后创建`PageNumberPagination`对象，并调用其`paginate_queryset`方法对数据进行分页。接着，使用序列化器对分页后的数据进行处理，并返回`Response`。 4. 在项目的`settings.py`中，配置`REST_FRAMEWORK`，设置默认的每页显示数量，例如`"PAGE_SIZE": 2`。 除了使用内置的`PageNumberPagination`，你还可以自定义分页类。在示例中提到的`MyPageNum`类，你可以根据项目需求定制分页逻辑，比如改变页码计算方式、响应内容结构等。自定义分页类通常需要继承自`rest_framework.pagination.PageNumberPagination`，并覆盖或添加所需的方法。 自定义分页类的基本结构可能如下： ```python from rest_framework.pagination import PageNumberPagination class MyPageNum(PageNumberPagination): page_size = 10 # 自定义每页大小 page_query_param = 'my_page' # 自定义查询参数名 page_size_query_param = 'my_page_size' # 自定义每页大小查询参数名 max_page_size = 50 # 设置最大每页大小限制 def get_paginated_response(self, data): # 自定义返回的分页信息 return Response({ 'total': self.page.paginator.count, 'per_page': self.page_size, 'current_page': self.page.number, 'next': self.get_next_link(), 'previous': self.get_previous_link(), 'items': data }) ``` 在这个例子中，`get_paginated_response`方法用于返回包含分页信息的响应，你可以根据需要调整返回的内容。 Django REST Framework提供了方便的分页机制，既可以直接使用内置的分页类，也可以灵活地自定义分页行为，以满足各种API接口的需求。在实际开发中，合理地使用分页可以显著提升用户体验，并优化服务器性能。