Python从入门到精通day53
RESTful架构和DRF进阶CBV实战与高级特性在上一节中我们讲解了基于FBV函数视图实现REST风格API的方法本节将聚焦DRF的进阶用法——通过CBV类视图快速开发接口并详解分页、数据筛选等核心功能帮助你在实际开发中兼顾效率与灵活性。一、基于CBV实现REST接口CBVClass-Based View是DRF中更高效的接口开发方式通过继承DRF封装的视图类可大幅减少重复代码相比之下FBVFunction-Based View虽更灵活但需要手动编写更多逻辑。下面以学科接口为例讲解CBV的具体用法。1. 继承APIView子类快速实现单一功能接口DRF的APIView提供了多个子类如ListAPIView、CreateAPIView等每个子类封装了特定HTTP方法的处理逻辑可直接复用。步骤1编写视图类修改polls/views.py删除原有的show_subjects函数视图新增继承ListAPIView的类视图仅支持GET请求获取学科列表Pythonfrom rest_framework.generics import ListAPIViewclass SubjectView(ListAPIView): # 通过queryset指定如何获取学科数据 queryset Subject.objects.all() # 通过serializer_class指定如何序列化学科数据 serializer_class SubjectSerializer•ListAPIView是APIView的子类已内置get方法无需手动编写即可处理 GET 请求• 核心只需配置两个属性queryset数据来源、serializer_class序列化规则。步骤 2配置 URL 映射修改polls/urls.py将类视图映射到 URL需调用as_view()方法转换为可调用视图urlpatterns [ path(api/subjects/, SubjectView.as_view()), ]补充APIView 核心子类说明DRF 为常见的接口场景封装了多个APIView子类可按需选择视图类支持的 HTTP 方法核心功能ListAPIViewGET获取资源列表CreateAPIViewPOST新增资源RetrieveAPIViewGET带 ID获取单个资源详情UpdateAPIViewPUT/PATCH更新资源全量 / 部分DestroyAPIViewDELETE删除资源2. 继承 ModelViewSet 实现全功能接口如果需要为学科接口同时支持 GET列表 / 详情、POST新增、PUT/PATCH更新、DELETE删除等所有操作推荐继承ModelViewSet—— 它整合了上述所有功能无需编写额外逻辑。步骤 1编写视图类修改polls/views.py删除SubjectView新增SubjectViewSet类from rest_framework.viewsets import ModelViewSetclass SubjectViewSet(ModelViewSet): queryset Subject.objects.all() serializer_class SubjectSerializer步骤 2ModelViewSet 核心原理ModelViewSet通过继承多个 Mixin 类实现全功能支持其源码结构如下class ModelViewSet(mixins.CreateModelMixin, mixins.RetrieveModelMixin, mixins.UpdateModelMixin, mixins.DestroyModelMixin, mixins.ListModelMixin, GenericViewSet): A viewset that provides default create(), retrieve(), update(), partial_update(), destroy() and list() actions. pass每个 Mixin 类对应一个核心功能ModelViewSet直接整合所有能力只需配置queryset和serializer_class即可完成全功能接口开发。步骤 3配置 URL 映射路由注册ModelViewSet包含多个接口逻辑需通过 DRF 的路由器Router注册 URL而非直接映射from rest_framework.routers import DefaultRouterrouter DefaultRouter()router.register(api/subjects, SubjectViewSet)urlpatterns router.urls除了ModelViewSet类外DRF还提供了一个名为ReadOnlyModelViewSet的类从名字上就可以看出该类是只读视图的集合也就意味着继承该类定制的数据接口只能支持GET请求也就是获取单个资源和资源列表的请求。二、DRF 数据分页控制列表数据返回量获取资源列表时一次性返回所有数据会导致接口响应慢、前端渲染卡顿因此分页是 REST 接口的必备功能。DRF 提供了多种分页方式可全局配置或自定义。1. 全局默认分页配置在 Django 项目的settings.py中配置REST_FRAMEWORK设置全局默认分页规则REST_FRAMEWORK { PAGE_SIZE: 10, DEFAULT_PAGINATION_CLASS: rest_framework.pagination.PageNumberPagination}配置后所有基于 DRF 的列表接口都会自动分页返回格式如下{ count: 100, // 总数据量 next: http://example.com/api/subjects/?page2, // 下一页URL previous: null, // 上一页URL第一页为null results: [/* 分页数据列表 */]}2. DRF 内置分页器说明DRF 提供了 3 种常用分页器可根据业务场景选择分页器类核心特点适用场景PageNumberPagination基于页码分页?page2page_size10常规列表分页LimitOffsetPagination基于偏移量分页?limit10offset10自定义起始位置的分页CursorPagination基于游标分页加密游标不暴露总数据量大数据量、需隐藏数据体量3. 自定义分页器视图级别如果需要为特定接口定制分页规则如每页 5 条、支持自定义页大小可编写自定义分页类并在视图中指定步骤 1编写自定义分页类from rest_framework.pagination import PageNumberPaginationclass CustomizedPagination(PageNumberPagination): # 默认页面大小 page_size 5 # 页面大小对应的查询参数 page_size_query_param size # 页面大小的最大值 max_page_size 50步骤 2在视图中使用自定义分页器class SubjectView(ListAPIView): # 指定如何获取数据 queryset Subject.objects.all() # 指定如何序列化数据 serializer_class SubjectSerializer # 指定如何分页 pagination_class CustomizedPagination4. 取消分页如果某接口不需要分页可将pagination_class设为Noneclass SubjectView(ListAPIView): queryset Subject.objects.all() serializer_class SubjectSerializer pagination_class None # 取消分页三、DRF 数据筛选精准获取目标数据实际开发中接口常需要根据条件筛选数据如 “根据学科编号获取对应老师”DRF 支持两种核心筛选方式重写get_queryset方法、使用django-filter扩展。1. 重写 get_queryset 方法基础筛选通过重写视图类的get_queryset方法可从请求中获取筛选条件动态过滤数据。以 “根据学科编号筛选老师” 为例步骤 1编写老师视图类class TeacherView(ListAPIView): serializer_class TeacherSerializer def get_queryset(self): queryset Teacher.objects.defer(subject) try: sno self.request.GET.get(sno, ) queryset queryset.filter(subject__nosno) return queryset except ValueError: raise Http404(No teachers found.)步骤 2配置 URLpath(api/teachers/, TeacherView.as_view()),前端可通过/api/teachers/?sno1获取编号为 1 的学科下的所有老师。2. 使用 django-filter 扩展高级筛选对于复杂筛选场景多条件、模糊查询等推荐使用django-filter扩展配合 DRF 实现更灵活的筛选步骤 1安装依赖pip install django-filter步骤 2配置 DRF 筛选后端# settings.pyINSTALLED_APPS [ # 其他应用 django_filters,]REST_FRAMEWORK { DEFAULT_FILTER_BACKENDS: [django_filters.rest_framework.DjangoFilterBackend],}步骤 3在视图中配置筛选字段from rest_framework.generics import ListAPIViewfrom django_filters.rest_framework import DjangoFilterBackendfrom .models import Teacherfrom .serializers import TeacherSerializerclass TeacherView(ListAPIView): queryset Teacher.objects.all() serializer_class TeacherSerializer filter_backends [DjangoFilterBackend] filter_fields [subject__no, sex] # 支持按学科编号、性别筛选前端可通过/api/teachers/?subject__no1sex1筛选 “学科 1 的男老师”无需手动编写筛选逻辑。总结1. DRF 的 CBV 模式通过继承APIView子类 /ModelViewSet可快速实现 REST 接口相比 FBV 更高效、代码更简洁2.ModelViewSet整合了增删改查全功能配合 DRF 路由器可自动生成 URL大幅降低开发成本3. DRF 内置多种分页器支持全局配置和视图级自定义是控制列表数据返回量的核心手段4. 数据筛选可通过重写get_queryset基础场景或django-filter复杂场景实现满足不同业务的筛选需求。神器,助力学习,工作国内直接使用顶级AI工具谷歌浏览器访问https://www.nezhasoft.cloud/r/vMPJZr
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2419076.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!