【django2.0之Rest_Framework框架二】rest_framework视图介绍

最新推荐文章于 2024-04-13 06:28:31 发布

monoplasty

最新推荐文章于 2024-04-13 06:28:31 发布

阅读量243

点赞数

分类专栏： Python 文章标签： python django rest_framework

本文链接：https://blog.csdn.net/monoplasty/article/details/133882417

版权

Python 专栏收录该内容

21 篇文章 3 订阅

订阅专栏

1. 2个视图基类

1.1 `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() 或者其他请求方式的方法。

基于APIView写5个接口

## views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

from req import models
from req.serializers import StudentModelSerializer

class StudentsView(APIView):
    # 获取所有数据
    def get(self,request):
        # http://127.0.0.1:8000/req/students/?a=1&b=2&b=3  b可能为多选数据
        print(request.query_params)  # 和原来 request.GET 一样  <QueryDict: {'a': ['1'], 'b': ['2', '3']}>
        # print(request.GET)
        # print(request.query_params.getlist('b'))
        students = models.Student.objects.all()
        serializer_obj = StudentModelSerializer(instance=students,many=True)
        # return Response(serializer_obj.data,status=400)
        return Response(serializer_obj.data)

    # 添加单条记录
    def post(self,request):
        serializer_obj = StudentModelSerializer(data=request.data)
        if serializer_obj.is_valid():
            new_obj = models.Student.objects.create(**serializer_obj.validated_data)
            obj = StudentModelSerializer(instance=new_obj)
            return Response(obj.data, status=status.HTTP_201_CREATED)


class StudentView(APIView):
    # 获取所有数据
    def get(self, request, pk):
        student = models.Student.objects.get(pk=pk)
        serializer_obj = StudentModelSerializer(instance=student)
        return Response(serializer_obj.data)
        
    # 更新单条记录
    def put(self,request,pk):
        student = models.Student.objects.get(pk=pk)
        data = request.data
        serializer_obj = StudentModelSerializer(instance=student,data=data,partial=True)
        if serializer_obj.is_valid():
            instance = serializer_obj.save()
            new_serializer_obj = StudentModelSerializer(instance=instance)
            return Response(new_serializer_obj.data,status=status.HTTP_202_ACCEPTED)
        return Response({'error':"检验失败"})
    # 删除单条记录
    def delete(self, request, pk):
        models.Student.objects.get(pk=pk).delete()
        # return Response(None,)
        return Response('', status=status.HTTP_204_NO_CONTENT)

## urls.py
from django.urls import path,re_path,include #  re_path --- django1.11 url
from req import views
urlpatterns = [
    path('students/', views.StudentsView.as_view()),
    re_path('students/(?P<pk>\d+)/', views.StudentView.as_view()),
]

1.2 `GenericAPIView`[通用视图类]

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

提供的关于序列化器使用的属性与方法

属性：
serializer_class 指明视图使用的序列化器
方法：

get_serializer_class(self)
当出现一个视图类中调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象了。
返回序列化器类，默认返回serializer_class，可以重写，例如：
```
# 当试图中使用多个序列化器类时，可以使用该方法来区分
def get_serializer_class(self):
    if self.request.method == 'GET':
        return StudentModelSerializer2
    return StudentModelSerializer
```
get_serializer(self, *args, **kwargs)
返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。

比如serializer = self.get_serializer(instance=self.get_object(),context={'pk':pk}),下面的request和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):
        book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象
        serializer = self.get_serializer(book)
        return Response(serializer.data)
```

基于GenericAPIView写的接口

## views.py
from rest_framework.generics import GenericAPIView
from rest_framework.response import Response

from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer

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):
        serializer = self.get_serializer(data=request.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

    #一个视图中使用多个序列化类的方法，目前的例子是：get请求获取数据时，我们只给他两个字段数据，其他方法时我们给他所有字段数据，定义了这个get_serializer_class方法之后(其实是对父类的方法进行了重写)，其实上面的serializer_class就可以不同写了
    def get_serializer_class(self):
        """重写获取序列化器类的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        return StudentModelSerializer

    #在使用GenericAPIView实现获取操作单个数据时，我们试图方法中的参数变量pk最好是pk名，别叫id什么的，不然还需要进行一些其他的配置，比较麻烦一些了，简单看一下源码就知道了
    def get(self,request,pk):
        """获取一条数据"""
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)

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

## serializers.py
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")

2. 5个视图扩展类

作用：
提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。

这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。

2.1 `ListModelMixin`

获取多条数据的列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。

该Mixin的list方法会对数据进行过滤和分页。

2.2 `CreateModelMixin`

添加数据的创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

如果序列化器对前端发送的数据验证失败，返回400错误。

2.3 `RetrieveModelMixin`

获取单条数据，详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。

如果存在，返回200，否则返回404。

2.4 `UpdateModelMixin`

更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。

成功返回200，序列化器校验数据失败时，返回400错误。

2.5 `DestroyModelMixin`

删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

成功返回204，不存在返回404。

2.6 使用`GenericAPIView`和5个视图扩展类，实现api接口

"""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)

3. `GenericAPIView`的视图子类

3.1 `CreateAPIView`

提供 post 方法：新增一条数据
继承自： GenericAPIView、CreateModelMixin

3.2 `ListAPIView`

提供 get 方法：获取所有数据列表
继承自：GenericAPIView、ListModelMixin

3.3 `RetrieveAPIView`

提供 get 方法：获取一条数据
继承自: GenericAPIView、RetrieveModelMixin

3.4 `UpdateAPIView`

提供 put 和 patch 方法：修改和更新一条数据
继承自：GenericAPIView、UpdateModelMixin

3.5 `DestoryAPIView`

提供 delete 方法：删除一条数据
继承自：GenericAPIView、DestoryModelMixin

3.6 `ListCreateAPIView`

提供get、和post方法：查询列表和新增一条数据
继承自：GenericAPIView、ListModelMixin、CreateModelMixin

3.7 `RetrieveUpdateAPIView`

提供 get、put、patch方法：查询一条和修改一条数据
继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

3.8 `RetrieveDestroyAPIView`

提供 get、put、patch、delete方法：查询一条数据，删除一条数据
继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

3.9 `RetrieveUpdateDestoryAPIView`

提供 get、put、patch、delete方法：查询一条数据，修改和删除一条数据
继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

示例：

"""使用GenericAPIView的视图子类进一步简化开发api接口的代码"""
from rest_framework.generics import ListAPIView,CreateAPIView
class Students3GenericAPIView(ListAPIView,CreateAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

#from rest_framework.generics import RetrieveAPIView,UpdateAPIView,DestroyAPIView
from rest_framework.generics import RetrieveUpdateDestroyAPIView # 结合了上面三个子类的功能
class Student3GenericAPIView(RetrieveUpdateDestroyAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

4. 视图集基类

4.1 `ViewSet`

继承自APIView与ViewSetMixin，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。

使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：

list() 提供一组数据
retrieve() 提供单个数据
create() 创建数据
update() 保存数据
destory() 删除数据

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典（如{'get':'list'}）的映射处理工作。

## views.py
from rest_framework.viewsets import ViewSet
from rest_framework.generics import ListAPIView,CreateAPIView,RetrieveAPIView

class Student2ViewSet(ViewSet,ListAPIView,CreateAPIView,RetrieveAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    def get_all(self,request):
        """获取所有学生信息"""
        return self.list(request)

    def add_student(self,request):
        return self.create(request)

    def get_one(self,request,pk):
        """获取一个学生信息"""
        return self.retrieve(request)

## urls.py
urlpatterns = [
    path("students5/", views.Student2ViewSet.as_view({"get": "get_all", "post": "add_student"})),
    re_path("students5/(?P<pk>\d+)/", views.Student2ViewSet.as_view({"get":"get_one"})),
]

4.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

## urls.py
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"})),
]

4.3 `ModelViewSet`

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

"""使用ModelViewSet简写上面的继承代码，最终版"""
from rest_framework.viewsets import ModelViewSet

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

4.4 `ReadOnlyModelViewSet` 等

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。和ModelViewSet类似，就是继承的功能少了。

5. 视图集中定义附加`action`动作

在视图集中，除了上述默认的方法动作外，还可以添加自定义动作，进行扩展。

举例，比如做一个登录方法login：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):  #这个就可以称为自定义的action动作
        """学生登录功能"""
        return Response({"message":"登录成功"})

## urls.py
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"}))
]

5.1 路由Routers

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

REST framework提供了两个Router

SimpleRouter
DefaultRouter

## urls.py
from django.urls import path, re_path
from . import views
urlpatterns = [
    ...
]
"""使用drf提供路由类router给视图集生成路由列表"""
# drf提供一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
from rest_framework.routers import DefaultRouter
router = DefaultRouter()

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

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

## views.py
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

5.2 自定义函数生成路由

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：

methods: 声明该action对应的请求方式，列表传递
detail : 声明该action的路径是否与单一资源对应，及是否是xxx/<pk>/action方法名/
- True 表示路径格式是xxx/<pk>/action方法名/
- False 表示路径格式是xxx/action方法名/

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=True)
    def login(self, request,pk):
        """登录"""
        ...

    # detail为False 表示路径名格式应该为 router_stu/get_new_5/
    @action(methods=['put'], detail=False)
    def get_new_5(self, request):
        """获取最新添加的5个学生信息"""
        ...

由路由器自动为此视图集自定义action方法形成的路由会是如下内容：

^router_stu/get_new_5/$    name: router_stu-get_new_5
^router_stu/{pk}/login/$   name: router_stu-login

monoplasty

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
【django2.0之Rest_Framework框架二】rest_framework视图介绍

REST framework 提供了众多的通用视图基类与扩展类，以简化视图的编写。
复制链接

扫一扫

专栏目录

【django2.0之Rest_Framework框架二】rest_framework视图介绍

1. 2个视图基类

1.1 APIView

1.2 GenericAPIView[通用视图类]

2. 5个视图扩展类

2.1 ListModelMixin

2.2 CreateModelMixin

2.3 RetrieveModelMixin

2.4 UpdateModelMixin

2.5 DestroyModelMixin

2.6 使用GenericAPIView和5个视图扩展类，实现api接口

3. GenericAPIView的视图子类

3.1 CreateAPIView

3.2 ListAPIView

3.3 RetrieveAPIView

3.4 UpdateAPIView

3.5 DestoryAPIView

3.6 ListCreateAPIView

3.7 RetrieveUpdateAPIView

3.8 RetrieveDestroyAPIView

3.9 RetrieveUpdateDestoryAPIView