DRF-Django rest framework

1. 视图

Django REST framwork 提供的视图的主要作用：

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行

2. 视图继承关系

在这里插入图片描述

3. 两个视图基类

# APIView
	继承了原生Django的View
    
# GenericAPIView
	继承了APIView
        -queryset = models.Book.objects.all()
        -serializer_class = serializer.BookModelSerializer
        -get_queryset：  获取配置的queryset
        -get_object：    路由中的分组字段必须是pk
        -get_serializer：获取配置的序列化类
    
# 两个基类
APIView：如果跟models没有关系（没有数据库相关操作），就继承它
GenericAPIView：有关数据库操作，queryset 和serializer_class

1. APIView

from rest_framework.views import APIView

APIView是REST framework提供的所有视图的基类，继承自Django的View父类

# APIView与View的不同之处
	传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象
    视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式
    任何APIException异常都会被捕获到，并且处理成合适的响应信息
    在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制
    
# 支持定义的类属性
    authentication_classes 列表或元祖，身份认证类
    permissoin_classes     列表或元祖，权限检查类
    throttle_classes       列表或元祖，流量控制类

# 注意    
	在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法
    
# 示例
	from rest_framework.views import APIView
	from rest_framework.response import Response

    url(r'^students/$', views.StudentsAPIView.as_view()),
    
    class StudentsAPIView(APIView):
        def get(self, request):
            data_list = Student.objects.all()
            serializer = StudentModelSerializer(instance=data_list, many=True)
            return Response(serializer.data)

2. GenericAPIView

# 通用视图类 
	rest_framework.generics.GenericAPIView
        继承自APIVIew
        主要增加了操作序列化器和数据库查询的方法
        作用是为下面Mixin扩展类的执行提供方法支持
        通常在使用时，可搭配一个或多个Mixin扩展类

# 提供的关于序列化器使用的属性与方法
	属性：
		serializer_class 指明视图使用的序列化器
	方法：
		get_serializer_class(self)
			当出现一个视图类中调用多个序列化器时
            那么可以通过条件判断在get_serializer_class方法中
            返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象
            返回序列化器类，默认返回serializer_class，可以重写，例如：
                def get_serializer_class(self):
                    if self.request.user.is_staff:
                        return FullAccountSerializer
                    return BasicAccountSerializer
            
        get_serializer(self, args, *kwargs)
            返回序列化器对象，主要用来提供给Mixin扩展类使用
            如果我们在视图中想要获取序列化器对象，也可以直接调用此方法

# 注意
	该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据request、format、view
    这三个数据对象可以在定义序列化器时使用
        request 当前视图的请求对象
        view    当前请求的类视图对象
        format  当前请求期望返回的数据格式  
        
# 提供的关于数据库查询的属性与方法
	属性：
		queryset 指明使用的数据查询集
	方法：
		get_queryset(self)
			返回视图使用的查询集
            主要用来提供给Mixin扩展类使用
            是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：
                def get_queryset(self):
                    user = self.request.user
                    return user.accounts.all()

        get_object(self)
            返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用
            在视图中可以调用该方法获取详情信息的模型类对象
            若详情访问的模型类对象不存在，会返回404
            该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问
            举例：
            url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()),
            
            class BookDetailView(GenericAPIView):
                queryset = BookInfo.objects.all()
                serializer_class = BookInfoSerializer

                def get(self, request, pk):
                    # get_object()方法根据pk参数查找queryset中的数据对象
                    book = self.get_object() 
                    serializer = self.get_serializer(book)
                    return Response(serializer.data)
        
# 其他可以设置的属性
    pagination_class 指明分页控制类
    filter_backends  指明过滤控制后端   
    
# 代码
from rest_framework.generics import GenericAPIView
from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response

class StudentsGenericAPIView(GenericAPIView):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取所有学生信息"""
        serializer = self.get_serializer(instance=self.get_queryset(), many=True)
        return Response(serializer.data)

    def post(self,request):
        data = request.data
        serializer = self.get_serializer(data=data)
        serializer.is_valid(raise_exception=True)
        instance = serializer.save()
        serializer = self.get_serializer(instance=instance)
        return Response(serializer.data)

class StudentGenericAPIView(GenericAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_serializer_class(self):
        """重写获取序列化器类的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        else:
            return StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)

    def put(self,request,pk):
        data = request.data
        serializer = self.get_serializer(instance=self.get_object(),data=data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)
    
# 序列化器类
from rest_framework import serializers
from students.models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = "__all__"

class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = ("name","class_null")

4. 5个视图扩展类

# 作用
	提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现
    如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量
    这五个扩展类需要搭配GenericAPIView父类
    因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法

# 5个视图扩展类(rest_framework.mixins)
    CreateModelMixin    create方法创建一条
    DestroyModelMixin   destory方法删除一条
    ListModelMixin      list方法获取所有
    RetrieveModelMixin  retrieve获取一条
    UpdateModelMixin    update修改一条

1. ListModelMixin

# 列表视图扩展类
	提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码
	该Mixin的list方法会对数据进行过滤和分页

# 源代码
class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 过滤
        queryset = self.filter_queryset(self.get_queryset())
        # 分页
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)
    
# 示例
from rest_framework.mixins import ListModelMixin

class BookListView(ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request):
        return self.list(request)

2. CreateModelMixin

# 创建视图扩展类
	提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码
	如果序列化器对前端发送的数据验证失败，返回400错误

# 源代码
class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 保存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}

3. RetrieveModelMixin

# 详情视图扩展类
	提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象
	如果存在，返回200， 否则返回404。

# 源代码
class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象，会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)
    
# 示例
class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
        return self.retrieve(request)

4. UpdateModelMixin

# 更新视图扩展类
	提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象
	同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新
	成功返回200，序列化器校验数据失败时，返回400错误
    
# 源代码
class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

5. DestroyModelMixin

# 删除视图扩展类
	提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象
	成功返回204，不存在返回404

# 源代码
class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()
        
# 使用GenericAPIView和视图扩展类，实现api接口，代码
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取多个学生信息"""
        return self.list(request)

    def post(self,request):
        """添加学生信息"""
        return self.create(request)

from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        return self.retrieve(request,pk)

    def put(self,request,pk):
        """更新一条数据"""
        return self.update(request,pk)

    def delete(self,request,pk):
        """删除一条数据"""
        return self.destroy(request,pk)

5. 9个子类视图

# GenericAPIView的视图子类
1）CreateAPIView
	提供 post 方法 => 新增数据
	继承自： GenericAPIView、CreateModelMixin

2）ListAPIView
	提供 get  方法 => 获取所有
	继承自：GenericAPIView、ListModelMixin

3）RetrieveAPIView 
	提供 get  方法 => 获取一条
	继承自: GenericAPIView、RetrieveModelMixin

4）DestoryAPIView
	提供 delete 方法 => 删除数据
	继承自：GenericAPIView、DestoryModelMixin

5）UpdateAPIView
	提供 put 和 patch 方法 => 修改数据
	继承自：GenericAPIView、UpdateModelMixin
    
6）ListCreateAPIView
	提供 get 和 post 方法 => 获取所有 新增一个 
	继承自：GenericAPIView、UpdateModelMixin
    
7）RetrieveDestroyAPIView
	提供 get 和 delete 方法 => 获取一条 删除一个 
	继承自：GenericAPIView、UpdateModelMixin
    
8）RetrieveUpdateAPIView
	提供 get put patch 方法 => 获取一条 修改数据
	继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

9）RetrieveUpdateDestoryAPIView
	提供 get put patch delete 方法 => 获取一条 修改数据 删除一条
	继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

6. 视图集ViewSet

1. 视图集简介

# ViewSet
	使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：
    list()     提供一组数据
    retrieve() 提供单个数据
    create()   创建数据
    update()   保存数据
    destory()  删除数据   	
	ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等
    
# 视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上
class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)
    
# 在设置路由时，我们可以如下操作 
urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
    url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'}),
]

2. 常用视图集父类

1）ViewSet
	继承自APIView与ViewSetMixin
    作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等
	ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典(如{‘get’:’list’})的映射处理工作
	在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法

2）GenericViewSet
	使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写
    而这些方法与前面讲过的Mixin扩展类提供的方法同名
    所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写
    但是Mixin扩展类依赖与GenericAPIView，所以还需要继承GenericAPIView
	GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin
    在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时
    还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用
    
# 示例
from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    
# url的定义
urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),
]

3）ModelViewSet
	继承自GenericViewSet 同时包括
ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin

4）ReadOnlyModelViewSet
	继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin

3. action的使用

'''
action的使用
	在视图集中，除了上述默认的方法动作外，还可以添加自定义动作
	只要继承了ViewSetMixin类,路由的配置就发生变化了,只需要写映射即可,视图类的方法中就会有个action
'''
# 路由配置
	path('books_mix/', views.BookView.as_view({'get':'lqz'}))
    
# 示例一 视图类
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """学生登录功能"""
        return Response({"message":"登录成功"})
    
# url的定义
urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))
]
 
# 示例二 视图类的方法中有 action
class BookView(ViewSet):
    def lqz(self,request,*args,**kwargs):
        print(self.action)
        return Response('lqz')

4. action的属性

'''在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个'''
# 示例
from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """获取最近添加的5个学生信息"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名
        # 通过路由访问到当前方法中.可以看到本次的action就是请求的方法名

5. 总结

# 视图集
ViewSetMixin
	重写了 as_view 

ViewSet
	继承 ViewSetMixin、 APIView

GenericViewSet
	继承 ViewSetMixin、 generics.GenericAPIView
    
ModelViewSet
	继承 mixins.CreateModelMixin、 mixins.RetrieveModelMixin、 mixins.UpdateModelMixin 
        mixins.DestroyModelMixin、 mixins.ListModelMixin、 GenericViewSet
        
ReadOnlyModelViewSet
	继承 mixins.RetrieveModelMixin、 mixins.ListModelMixin、 GenericViewSet

7. 路由Routers

1. 路由简介

对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。

REST framework提供了两个router (自动生成路由)

SimpleRouter
DefaultRouter

2. 使用方法

1. 创建router对象，并注册视图集
# 示例
	# 继承了ViewSetMixin的视图类，以后写路由，可以自动生成
    from rest_framework import routers
	# 实例化得到一个对象
    router = routers.SimpleRouter()
    # 注册进路由
    router.register('books', views.BookSetView, base_name='book')

    register(prefix, viewset, base_name)
        prefix    该视图集的路由前缀
        viewset   视图集
        base_name 路由别名的前缀
    
# 上述代码会形成的路由如下
    ^books/$    name: book-list
    ^books/{pk}/$   name: book-detail
 
2. 添加路由数据 (两种方式)
# 把自动生成的路由配置到urlpatterns中   
# 方式一
    urlpatterns = [
        ...
    ]
    urlpatterns += router.urls

# 方式二
    urlpatterns = [
        ...
        url(r'^', include(router.urls))
        re_path(r'v1/', include(router.urls))
    ]
    
3. 配置路由的其他方式
	# 最原始的
    	path('books/', views.BookAPIView.as_view()),
        
    # ViewSetMixin的视图类
    	path('books_set/', views.BookSetView.as_view({'get':'list','post':'create'}))

3. 代码演示

# 使用路由类给视图集生成了路由地址 必须是继承ModelViewSet的视图类才能自动生成路由
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
	# 这种方法不会自动生成，需要用action配置
    def login(self,request):
        """学生登录功能"""
        print(self.action)
        return Response({"message":"登录成功"})
    
# 路由代码
from django.urls import path, re_path
from . import views
urlpatterns = [
    ...
]

"""
    使用drf提供路由类router给视图集生成路由列表
    drf一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
"""
from rest_framework.routers import DefaultRouter

# 实例化路由类
router = DefaultRouter()

# 注册视图集 router.register("路由前缀",视图集类)
router.register("router_stu",views.StudentModelViewSet)

# 把生成的路由列表追加到urlpatterns
print(router.urls)
urlpatterns += router.urls

'''
	上面的代码就成功生成了路由地址[增/删/改/查一条/查多条的功能]
    但是不会自动我们在视图集自定义方法的路由
	所以我们如果也要给自定义方法生成路由，则需要进行action动作的声明
'''

4. 附加action的声明

# 视图集中附加action的声明
	当自动生成路由的时候，由于视图类中还有其它方法，是无法自动生成路由的
	在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息
    需要使用rest_framework.decorators.action装饰器
	以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同
    
# action装饰器可以接收两个参数 
	@action(methods=['get'], detail=True) 
    # 参数
        methods
            声明该action对应的请求方式，列表传递
            对应请求方式会触发被装饰函数的执行
        detail
            声明该action的路径是否与单一资源对应  
            是True是基于带id的路由生成的，如果是False，是基于不带id的路由生成的
            
# 示例
from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    # methods 设置当前方法允许哪些http请求访问当前视图方法
    # detail  设置当前视图方法是否是操作一个数据
    # detail为True，表示路径名格式应该为 router_stu/{pk}/login/
    @action(methods=['get'], detail=False)
    def login(self, request):
        return Response({'msg':'登陆成功'})

    @action(methods=['put'], detail=True)
    def get_new_5(self, request,pk):
        return Response({'msg':'获取5条数据成功'})
    
# 由路由器自动为此视图集自定义action方法形成的路由会是如下内容
    ^router_stu/get_new_5/$    name: router_stu-get_new_5
    ^router_stu/{pk}/login/$   name: router_stu-login

在这里插入图片描述

5. router形成URL的方式

1. SimpleRouter

在这里插入图片描述

2. DefaultRouter

在这里插入图片描述

3. 总结

DefaultRouter与SimpleRouter的区别

DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

原文链接：https://blog.csdn.net/qq_31455841/article/details/109514294