第四章 DRF之Router 和 Serializer

Router简单配置和映射

router = routers.DefaultRouter()

router.register("grades",GradeViewSet,"grades")

router.register("study/grades0",GradViewSetTemp,"grades0")

router.register("study/grades8",GradeGenericViewSet,"grades8")

router = SimpleRouter(trailing_slash=False)

#去除URL 尾部斜杠/

router = DefaultRouter(trailing_slash=False) #去除URL 尾部斜杠/

DefaultRouter路由器类似于上面的SimpleRouter,但是还包括一个默认返回所有列表视图的超链接的API根视图。它还生成可选的.json样式格式后缀的路由

urlpatterns += router.urls

path('', include(router.urls)),

path('api/', include(router.urls)),

url(r'^api/', include((router.urls,'app_name'))),

url(r'^api/', include((router.urls,'app_name'), namespace='instance_name')),

第四章 DRF之Router 和 Serializer_第1张图片

Router其他Action

@action #根据Detail属性来区分是 detail_route 还是 list_route 因此可直接用下面俩

@detail_route  #对应的URL 一般是 grades/{pk}/方法名路径

@list_route    #对应的URL 一般就是 grades/方法名路径

第四章 DRF之Router 和 Serializer_第2张图片

http://127.0.0.1:8000/api/study/grades8/1/info/

如果不设置url_path 属性则默认的用函数名 api/study/grades8/1/get_grade_info /

第四章 DRF之Router 和 Serializer_第3张图片
第四章 DRF之Router 和 Serializer_第4张图片

http://127.0.0.1:8000/api/study/grades8/clist/?name=高三

http://127.0.0.1:8000/api/study/grades8/clist/

第四章 DRF之Router 和 Serializer_第5张图片

自定义Router

可自定义路由,继承SimpleRouter,比如只提供get/retrieve的映射从而达到只读路由的目的,本例直接取自官网,不再实验

第四章 DRF之Router 和 Serializer_第6张图片
第四章 DRF之Router 和 Serializer_第7张图片

Serializer

第四章 DRF之Router 和 Serializer_第8张图片
第四章 DRF之Router 和 Serializer_第9张图片

修改过程,以点击PUT为例,注意本次PUT的参数包含了id和日期

UpdateModelMixin 提供了update方法,点击put后进入update方法。根据URL里面的pk可通过instance= self.get_object() 从数据库查到该对象

第四章 DRF之Router 和 Serializer_第10张图片

然后获取serializer 调用其 is_valid方法该方法会生成校验后的validated_data

可以看到已经没有id和时间了,因为serializer里面定义了id和时间都是read_only=True

然后会调用serializer.save() 跳转到 serializer 的 update方法该方法给instance的属性赋值,然后调用 instance.save()保存入库,然后返回改对象。

# .save() will create a new instance.

serializer = GradeSerializer(data=data)

# .save() will update the existing `grade`instance.

serializer = GradeSerializer(grade,data=data)

ModelSerializer

ModelSerializer继承了Serializer,提供了数据库实体类和序列化属性的映射,并且提供了数据库操作,增删改。如下面的代码就实现了上一节的功能

第四章 DRF之Router 和 Serializer_第11张图片

Serializer验证

第四章 DRF之Router 和 Serializer_第12张图片
第四章 DRF之Router 和 Serializer_第13张图片

全局validate

第四章 DRF之Router 和 Serializer_第14张图片
第四章 DRF之Router 和 Serializer_第15张图片

通用方法验证


第四章 DRF之Router 和 Serializer_第16张图片
第四章 DRF之Router 和 Serializer_第17张图片

Serializer实现

第四章 DRF之Router 和 Serializer_第18张图片
第四章 DRF之Router 和 Serializer_第19张图片

Serializer一对一关系

第四章 DRF之Router 和 Serializer_第20张图片

准备工作

1,修改settings文件增加媒体相关配置

MEDIA_URL = '/media/'

MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

2,配置URL

# 配置上传文件的访问处理函数re_path(r'^media/(?P.*)$', serve, {"document_root": MEDIA_ROOT}),

3,安装 Pillow 用户图片类型的支持:

第四章 DRF之Router 和 Serializer_第21张图片

增加Model和Serializer

第四章 DRF之Router 和 Serializer_第22张图片
第四章 DRF之Router 和 Serializer_第23张图片
第四章 DRF之Router 和 Serializer_第24张图片

用 migrate 生成数据库表后,通过配置admin后台手动增加了一条记录

第四章 DRF之Router 和 Serializer_第25张图片

用VUE作为前端进行增加/修改的测试

调整serializer

第四章 DRF之Router 和 Serializer_第26张图片

注意红色圈起来的地方。开始做案例的时候,create 和 update 总是其中一个抛异常。

CREATE:  grade是外键,是不允许为空的,但是,ModelViewSet在接受创建的时候grade是没值的,就导致直接验证失败,因此修改Model类,设置该值可为空。前端在创建的时候传值的时候不应该给grade赋值,实际也没法赋值。

第四章 DRF之Router 和 Serializer_第27张图片

UPDATE:  假如不加上exclude(‘grade’)在前端接收到了grade的值,如果前端不做处理,直接返回修改,ModelViewSet在update函数里进行serializer验证的时候会直接报错”grade值必须唯一”,因为最终保存的方法里可以手动指定grade(并且部分方法需要grade对象而不是grade_id)因此前端并不需要返回grade值。

这里有两种修改方式:

第一种方式是前端的修改方式就是要将grade值清空,然后再传给后台。

第二种方式是后台不序列化grade,不传给前端,也就是加上exclude(‘grade’)。

注意以下代码的红框部分

1, 给添加grade属性指向Grade对象

2,  Profile的id可以直接从Grade对象的profile读取

3,  将Grade对象的profile重新赋值成修改保存后的profile,然后返还用于前端更新

第四章 DRF之Router 和 Serializer_第28张图片

前端页面展示,这里先忽略图片格式及Text格式,后面再处理:

第四章 DRF之Router 和 Serializer_第29张图片
第四章 DRF之Router 和 Serializer_第30张图片

图片上传

1, 安装six

Pip install six

第四章 DRF之Router 和 Serializer_第31张图片

新建Base64ImageField

classBase64ImageField(serializers.ImageField):

完整代码见github https://github.com/zhaorch/DRFtutorial

调整GrageSerializer

第四章 DRF之Router 和 Serializer_第32张图片

前端VUE 使用的是vue-image-crop-upload 控件

第四章 DRF之Router 和 Serializer_第33张图片
第四章 DRF之Router 和 Serializer_第34张图片

新增的时候如果不提供图片,则需要设置图片的logo为null 或者空,本次样例是前端做的修改,判断未选择图片时logo一定要赋值 null 或者‘’ 不能赋值成 undefined。DRF也需要做一定的修改

修改的时候由于前端使用的patch修改,也就是部分修改,所以在图片未改变的情况下,将logo设置成 undefined 即可

富文本编辑

使用tinymce 富文本

https://github.com/aljosa/django-tinymce

pip installdjango-tinymce

INSTALLED_APPS= (

    ...

    'tinymce',

)

urlpatterns= [

    ...

    url(r'^tinymce/', include('tinymce.urls')),

]

from tinymce.models import HTMLField

前端:

本次使用的是别人封装好的

https://github.com/PanJiaChen/tinymce-all-in-one

需要注意一点的是,在编辑器切换绑定Model的时候需要手动指定一下该编辑器的hasChange属性,

第四章 DRF之Router 和 Serializer_第35张图片

Serializer一对多关系

本案例做了2个多对一,区别在于:Student可以逐个添加。而StudentsGoods属于Student的私人物品,严重依赖于Student因此在Student保存的时候批量增加和删除,不单独添加。


第四章 DRF之Router 和 Serializer_第36张图片

实体类

第四章 DRF之Router 和 Serializer_第37张图片
第四章 DRF之Router 和 Serializer_第38张图片

Serializer序列化类

第四章 DRF之Router 和 Serializer_第39张图片
第四章 DRF之Router 和 Serializer_第40张图片
第四章 DRF之Router 和 Serializer_第41张图片

StudentGoods 的 id 设置

Read_only = True :只读,返回给客户端,但是返回来的时候validate_data中会舍弃id属性。Id的默认属性就是read_only=True

Read_only=False:返回给客户端,也会返回来,且会出现在validate_data中

Write_only = True:不会返回给客户端,因此也无法修改

Write_only= Flase: 返回给客户端,也会返回来,且会出现在validate_data中

Require=False:新建goods的时候验证的时候如果不加上这个参数则会抛异常:id必须出现

ViewSet

第四章 DRF之Router 和 Serializer_第42张图片
第四章 DRF之Router 和 Serializer_第43张图片

Serializer多对多关系

第四章 DRF之Router 和 Serializer_第44张图片

关于Course的单表增删改查,不再赘述,效果图

第四章 DRF之Router 和 Serializer_第45张图片

Model

第四章 DRF之Router 和 Serializer_第46张图片

以Student 为主进行选课

Serializer

第四章 DRF之Router 和 Serializer_第47张图片
第四章 DRF之Router 和 Serializer_第48张图片
第四章 DRF之Router 和 Serializer_第49张图片

http://127.0.0.1:8000/api/students/list_student_course/

http://127.0.0.1:8000/api/students/1/set_course/

这两个方法主体结构都是从update 方法以及 list方法复制的,但是舍弃了update方法的validate。直接使用的 request.data。

第四章 DRF之Router 和 Serializer_第50张图片

第一章 DRF概述

第二章 DRF安装与项目创建

第三章 DRF之View进化论

第四章 DRF之Router 和 Serializer

第五章 DRF权限分页查询排序访问限制

第六章 DRF Linux部署

第七章 DRF其他知识

你可能感兴趣的:(第四章 DRF之Router 和 Serializer)