django rest framework-基于视图的类

前面我们说过装饰API视图:
REST framework提供了两种封装器,你可以使用他们写views

  1. @api_view装饰器用在基于视图的方法上;
  2. APIView 装饰器用在类view中;
    一般我习惯用类视图写比较方便,除了一些单独操作的用方法写。
    我们先来看column模型相关操作。
定义视图类
from article.models import Column
from .serializers import ColumnSerializer
from rest_framework.views import APIView

class ColumnView(APIView):
    def get(self, request):
        # 获取queryset
        columns = Column.objects.all()
        # 开始序列化;
        serializer_data = ColumnSerializer(columns, many=True)
        print(serializer_data)
        print(serializer_data.data)
        # 获取序列化后的数据,返回给客户端
        return Response(serializer_data.data)

    def post(self, request):
        # 获取数据
        client_data = request.data
        print(client_data)
        # 序列化数据
        verified_data = ColumnSerializer(data=client_data)
        print(verified_data)

        # 校验数据
        if verified_data.is_valid():

            column = verified_data.save()

            print(verified_data.data)  #需要保存之后才能获取.data

            return Response(verified_data.data)
        else:
            return Response(verified_data.errors, status=400)


class ColumnFilterView(APIView):
    def get(self, request, column_id):
        column_obj = Column.objects.get(pk=column_id)
        serializer_data = ColumnSerializer(column_obj) # 这是单个实例,不需要many=True,默认不写为False

        return Response(serializer_data.data)

    def put(self, request, column_id):
        column_obj = Column.objects.get(pk=column_id)
        verified_data = ColumnSerializer(instance=column_obj, data=request.data)  # 这是单个实例,不需要many=True,默认不写为False

        if verified_data.is_valid():
            verified_data.save()
            return Response(verified_data.data)
        else:
            return Response(verified_data.errors)

    def delete(self, request, column_id):
        print(request.data) # <QueryDict: {'link_url': ['http://www.qmpython.com'], 'index': ['8'], 'name': ['REST测试111']}>

        Column.objects.get(pk=column_id).delete()
        return  Response()

写了2个视图ColumnView用户获取column数据列表,ColumnFilterView用于针对某一个实例进行查询,修改,删除操作。

序列化
class ColumnSerializer(serializers.ModelSerializer):
    class Meta:
        model = Column
        fields = ['id','name', 'link_url', 'index']
URL配置
urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:column_id>/', ColumnFilterView.as_view(), name='columns_filter'),
]
测试
  1. get获取一条记录


    image.png
  2. put修改一条记录


    image.png

3.delete一条记录


image.png

从上可以看出视图中有增删改查,在我们实际中多数都是crud操作,而很多都是差不多,我们不得不重复编写代码,为了避免重复编写,提高可复用,我们可以用到mixinis类将常见的实现。

使用mixnis

基于类视图的一大好处是,允许我们快速创建可复用行为,我们使用的create/retrieve/update/delete操作
和我们任何后端模型API视图非常相似,这些常见操作在rest框架是通过mixin类中实现的。

改写视图
from article.models import Column
from .serializers import ColumnSerializer
from rest_framework.views import APIView


class ColumnView(mixins.ListModelMixin,
                 mixins.CreateModelMixin,
                 generics.GenericAPIView):

    queryset = Column.objects.all()  # 查询结果集
    serializer_class = ColumnSerializer # 序列化类

    def get(self, request, *args, **kwargs):
        return self.list(request, * args, ** kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)



class ColumnFilterView(mixins.RetrieveModelMixin,
                       mixins.UpdateModelMixin,
                       mixins.DestroyModelMixin,
                       generics.GenericAPIView):

    queryset = Column.objects.all()
    serializer_class = ColumnSerializer

    def get(self, request, pk):  # 记住url和这传递的是pk字段,不能是其他字段
        return self.retrieve(request)

    def put(self, request, pk):
        return self.update(request)


    def delete(self, request, pk):
        return self.destroy(request)
url配置
urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:pk>/', ColumnFilterView.as_view(), name='columns_filter'),
]
测试结果

通过在postman中测试结果和实现的效果一样。

小结

代码看起来更加简洁,我们使用GenericAPIView 类来提供核心的功能,然后使用mixins类来提供增删改查的功能,我们只需要定义好请求方法,对应的功能直接调用mixins类中的方法即可。

1)ListModelMixin
列表视图扩展类,提供list(request, *args, **kwargs)方法快速实现列表视图,返回200状态码。
该Mixin的list方法会对数据进行过滤和分页。
2)CreateModelMixin
创建视图扩展类,提供create(request, *args, **kwargs)方法快速实现创建资源的视图,成功返回201状态码。
如果序列化器对前端发送的数据验证失败,返回400错误。
3) RetrieveModelMixin
详情视图扩展类,提供retrieve(request, *args, **kwargs)方法,可以快速实现返回一个存在的数据对象。
如果存在,返回200, 否则返回404。
4)UpdateModelMixin
更新视图扩展类,提供update(request, *args, **kwargs)方法,可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法,可以实现局部更新。
成功返回200,序列化器校验数据失败时,返回400错误。
5)DestroyModelMixin
删除视图扩展类,提供destroy(request, *args, **kwargs)方法,可以快速实现删除一个存在的数据对象。
成功返回204,不存在返回404。

使用通用类视图

使用mixin类,我们重写了视图以使用比以前少一点的代码,但我们可以进一步。 REST框架提供了一组已经混合的通用视图。来进一步修改我们的视图。

类视图:
class ColumnView(generics.ListCreateAPIView):

    queryset = Column.objects.all()  # 查询结果集
    serializer_class = ColumnSerializer # 序列化类

class ColumnFilterView(generics.RetrieveUpdateDestroyAPIView):

    queryset = Column.objects.all()
    serializer_class = ColumnSerializer

这个代码更加简洁,generics.ListCreateAPIView实际上继承了mixins中的mixins.ListModelMixin,mixins.CreateModelMixin,等于在又把mixins类根据get post put delete请求方式重新封装了一层。更加减少了我们的代码量。

url配置
urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:pk>/', ColumnFilterView.as_view(), name='columns_filter'),
]

注意:使用mixin和通用视图针对某一条传参需要穿固定pk字段。或者如果不传固定的PK,例如
我们路由这么写

      path('user/detail/', UserDetailView.as_view(), name='user_detail'),

对应视图则需要重写get_object方法,不使用pk值返回对象

    def get_object(self):
        """
        重写get_object,不使用pk值返回user
        因为查看某个对象具体详情,默认URL是需要配置类似
            path('users/<int:pk>/', UserDetailView.as_view(), name='user_detail'),
            但是这里我们没有使用Pk
        :return:
        """
        return self.request.user

否则会报错
AssertionError: Expected view UserDetailView to be called with a URL keyword argument named "pk". Fix your URL conf, or set the.lookup_fieldattribute on the view correctly.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355

推荐阅读更多精彩内容