一、类视图设计原则
# a.类视图尽量要简单
# b.根据需求选择相应的父类视图
# c.如果DRF中的类视图有提供相应的逻辑,那么就直接使用父类提供的
# d.如果DRF中的类视图,绝大多数逻辑都能满足需求,可以重写父类实现
# e.如果DRF中的类视图完全不满足要求,那么就直接自定义即可
class ProjectViewSet(viewsets.ModelViewSet):
queryset = Projects.objects.all()
serializer_class = ProjectModelSerializer
filter_backends = [filters.SearchFilter, filters.OrderingFilter]
search_fields = ['=name', '=leader', '=id']
ordering_fields = ['id', 'name', 'leader']
pagination_class = PageNumberPagination
def get_serializer_class(self):
"""
a.可以重写父类的get_serializer_class方法,用于为不同的action提供不一样的序列化器类
b.在视图集对象中可以使用action属性获取当前访问的action方法名称
:return:
"""
if self.action == 'names':
return ProjectsNamesModelSerailizer
else:
# return self.serializer_class
return super().get_serializer_class()
def retrieve(self, request, *args, **kwargs):
response = super().retrieve(request, *args, **kwargs)
response.data.pop('id')
response.data.pop('create_time')
return response
# def filter_queryset(self, queryset):
# if self.action == "names":
# return self.queryset
# else:
# return super().filter_queryset(queryset)
def paginate_queryset(self, queryset):
if self.action == "names":
return
else:
return super().paginate_queryset(queryset)
def get_queryset(self):
if self.action == "names":
return self.queryset.filter(name__icontains='2')
else:
return super().get_queryset()
二、路由器对象化
使用DRF框架routers类进行自动生成路由条目
# 1、可以使用路由器对象,为视图集类自动生成路由条目 # 2、路由器对象默认只为通用action(create、list、retrieve、update、destroy)生成路由条目,自定义的action不会生成路由条目 # 3、创建SimpleRouter路由对象 # DefaultRouter与SimpleRouter功能类似,仅有的区别为:DefaultRouter会自动生成一个根路由(显示获取数据的入口) # router = routers.DefaultRouter() # 4、使用路由器对象调用register方法进行注册 # 5、prefix指定路由前缀 # 6、viewset指定视图集类,不可调用as_view
加载路由条目
# 方式一: # 路由器对象.urls属性可获取生成的路由条目
# 方式二: # router.urls为列表
from rest_framework import routers
from . import views
router = routers.SimpleRouter()
router.register(r'projects', views.ProjectViewSet)
urlpatterns = [
# 方式一:
# 路由器对象.urls属性可获取生成的路由条目
# path('', include(router.urls)),
]
# 方式二:
# router.urls为列表
urlpatterns += router.urls
使用路由器对象生成路由条目后,类视图中如果进行了自定义的action方法,那就必须使用action装饰器
# 1、如果需要使用路由器机制自动生成路由条目,那么就必须得使用action装饰器
# 2、methods指定需要使用的请求方法,如果不指定,默认为GET
# 3、detail指定是否为详情接口,是否需要传递当前模型的pk值
# 如果需要传递当前模型的pk值,那么detail=True,否则detail=False
# 4、url_path指定url路径,默认为action方法名称
# 5、url_name指定url路由条目名称后缀,默认为action方法名称
# @action(methods=['GET'], detail=False, url_path='xxx', url_name='yyyy')
class ProjectViewSet(viewsets.ModelViewSet):
queryset = Projects.objects.all()
serializer_class = ProjectModelSerializer
filter_backends = [filters.SearchFilter, filters.OrderingFilter]
search_fields = ['=name', '=leader', '=id']
ordering_fields = ['id', 'name', 'leader']
# 可以在类视图中指定分页引擎类,优先级高于全局
pagination_class = PageNumberPagination
@action(methods=['GET'], detail=False)
def names(self, request, *args, **kwargs):
# queryset = self.get_queryset()
# queryset = self.filter_queryset(queryset)
# names_list = []
# for project in queryset:
# names_list.append({
# 'id': project.id,
# 'name': project.name
# })
# serializer = self.get_serializer(queryset, many=True)
#
# # return Response(names_list, status=200)
# return Response(serializer.data, status=200)
return super().list(request, *args, **kwargs)
@action(detail=True)
def interfaces(self, request, *args, **kwargs):
project = self.get_object()
interfaces_qs = project.interfaces_set.all()
interfaces_data = [{'id': interface.id, 'name': interface.name} for interface in interfaces_qs]
return Response(interfaces_data, status=200)
更多推荐
Django结合DRF框架进行路由器对象化及类视图设计原则
发布评论