DRF框架(三)——media资源路径设置、多表设计复习及补充、序列化组件(ModelSerializer)操作多表(序列化与反序列化)、多表序列化与反序列化整合(重点)
media资源路径设置 (设置好后把图片放在这个文件夹中,通过链接能访问到图片)
1.先在根目录设置一个media文件夹
2.配置settings.py,加上下面的
MEDIA_URL = '/media/' MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
3.在urls.py路由设置
from django.views.static import serve from django.conf import settings urlpatterns = [ url(r'^media/(?P<path>.*)', serve, {'document_root': settings.MEDIA_ROOT}), ]
多表设计
BaseModel基表
is_delete、create_time
下面四表继承基表,可以继承两个字段
Book表:name、price、img、authors、publish、is_delete、create_time
Publish表:name、address、is_delete、create_time
Author表:name、age、is_delete、create_time
AuthorDetail表:mobile, author、is_delete、create_time
基表设置 (注意设置abstract = True)
class BaseModel(models.Model): is_delete = models.BooleanField(default=False) create_time = models.DateTimeField(auto_now_add=True) # 设置 abstract = True 来声明基表,作为基表的Model不能在数据库中形成对应的表 class Meta: abstract = True
断关联多表关系 (******) db_constraint=False (设置了这个就是断关联,设置在外键,删除了作者详情,也不会删除作者)
1、外键位置: 一对多 - 外键放多的一方 一对一 - 从逻辑正反向考虑,如作者表与作者详情表,作者删除级联作者详情也删除,详情删除作者依旧存在,所以建议外键在详情表中
(和之前的一对一关系外键放置不一样,之前都是把外键放在查询频率高的表) 多对多 - 外键在关系表中 2、ORM正向方向连表查找: 正向:通过外键字段 eg: author_detial_obj.author #外键设置在作者详情表,在作者详情表中查询作者直接.author就可以 反向:通过设置反向查询related_name的值 eg:author_obj.detail #外键没有设置在作者表中,在作者表中通过设置反向查询.detail查询作者详情 注:依赖代码见下方 3、连表操作关系:(外键建在作者详情表中) 1)作者删除,详情级联 - on_delete=models.CASCADE #跟着一起删除 2)作者删除,详情置空 - null=True, on_delete=models.SET_NULL #外键字段清空 3)作者删除,详情重置 - default=0, on_delete=models.SET_DEFAULT 4)作者删除,详情不动 - on_delete=models.DO_NOTHING 注:拿作者与作者详情表举例 4、外键关联字段的参数 - 如何实现断关联、目前表间操作关系、方向查询字段 i)作者详情表中的(外键设置在作者详情表中) author = models.OneToOneField( to='Author', #和作者表关联 related_name='detail', #反查询,作者表直接查作者详情表的电话号码,可以直接author_obj.detail.mobile db_constraint=False, #断关联 on_delete=models.CASCADE #级联删除 ) ii)图书表中的 publish = models.ForeignKey( to='Publish', related_name='books', db_constraint=False, on_delete=models.DO_NOTHING, ) authors = models.ManyToManyField( to='Author' related_name='books', db_constraint=False, ) 注:ManyToManyField不能设置on_delete,OneToOneField、ForeignKey必须设置on_delete(django1.x系统默认级联,但是django2.x必须手动明确)
models.py
from django.db import models #基类 class BaseModel(models.Model): is_delete = models.BooleanField(default=False) #默认不是删除,数据库中是0/1 create_time = models.DateTimeField(auto_now_add=True) # 设置 abstract = True 来声明基表,作为基表的Model不能在数据库中形成对应的表 class Meta: abstract = True #声明该表只是一个抽象表不出现在数据库中 #书籍表 class Book(BaseModel): name = models.CharField(max_length=64) price = models.DecimalField(max_digits=5,decimal_places=2) img = models.ImageField(upload_to='img',default='default.jpg') #关联出版社表 publish = models.ForeignKey( to='Publish', #关联publish表 db_constraint=False, #断关联(断开Book表和Publish表的关联,方便删数据,虽然断开了关联但是还能正常使用) related_name='books',#反向查询字段:publish_obj.books就能查出当前出版社出版的的所有书籍 on_delete=models.DO_NOTHING,#设置连表操作关系 ) #关联作者表 authors = models.ManyToManyField( to='Author', db_constraint=True, #断开关联 related_name='books' #反向查询字段 ) class Meta: db_table='book' verbose_name='书籍' verbose_name_plural=verbose_name def __str__(self): return self.name #出版社表 class Publish(BaseModel): """name、address、is_delete、create_time""" name = models.CharField(max_length=64) addres = models.CharField(max_length=64) class Meta: db_table='publish' verbose_name='出版社' verbose_name_plural=verbose_name def __str__(self): return self.name #作者表 class Author(BaseModel): """name、age、is_delete、create_time""" name = models.CharField(max_length=64) age = models.IntegerField() class Meta: db_table = 'author' verbose_name='作者' verbose_name_plural=verbose_name def __str__(self): return self.name #作者详情 class AuthorDetail(BaseModel): """mobile, author、is_delete、create_time""" mobile = models.CharField(max_length=11) author = models.OneToOneField( to='Author', db_constraint=False, related_name='detail', on_delete=models.CASCADE ) class Meta: db_table='author_detail' verbose_name='作者详情' verbose_name_plural=verbose_name def __str__(self): return self.author.name
序列化 ModelSerializer 模型类序列化器
ModelSerializer与常规的Serializer相同,但提供了:
1.基于模型类自动生成一系列字段
2.包含默认的create()和update()的实现
3.基于模型类自动为Serializer生成validators,比如unique_together
序列化层:api/serializers.py
简单的写
from rest_framework.serializers import ModelSerializer,SerializerMethodField
from . import models #publish接口的序列化 class PublishModelSerializers(ModelSerializer): class Me= ('name','address') #选择需要序列化的字段,前端只显示这些字段(指明模型类的哪些字段生成) #Book接口序列化 class BookModelSerializers(ModelSerializer):
#了解:1.还可以自定义设置序列化字段,但是必须在fields中声明,在fields中写publish_address
publish_address = SerializerMethodField()
def get_publish_address(self,obj)
return obj.publish.address
#2.自定义连表深度-子序列化方式-该方式不能参与反序列化,使用在序列化和反序列化共存时,不能书写(******)
publish =
在models.py中Book类设置publish_name和author_list属性方法 (插拔式获取)
#序列化插拔式属性 -完成自定义字段名完成连表查询 @property def publish_name(self): #自定义查询出版社名字 return self.publish.name @property def author_list(self): return self.authors.values('name','age')
视图层 :views.py
from rest_framework.views import APIView from rest_framework.response import Response from . import models,serializers class Book(APIView): def get(self,request,*args,**kwargs): pk = kwargs.get('pk') #单查 if pk: try: book_obj = models.Book.objects.filter(pk=pk,is_delete=False) book_data = serializers.BookModelSerializers(book_obj).data #单条数据序列化 except: return Response({ 'status':1, 'msg':'数据不存在' }) #群查 else: book_query = models.Book.objects.filter(is_delete=False).all() #先筛选查询,再查所有 book_data = serializers.BookModelSerializers(book_query,many=True).data #不管是一条还是多条,只要数据是被[]嵌套,都要写many=True #返回前端数据 return Response({ 'status':0, 'msg':'ok', 'results':book_data })
路由层:api/urls.py
urlpatterns = [ url(r'^books/$', views.Book.as_view()), url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
反序列化
序列化层:api/serializers.py
class BookModelDeserializer(ModelSerializer):
#一些只参与反序列化的字段,但是不是与数据库关联的,自定义不入库的反序列化的字段
re_name = seializers.CharField(write_only=True) class Meta: model = models.Book fields = ('name', 'price', 'publish', 'authors') #没有默认值的字段必须序列化,为其传值 # extra_kwargs 用来完成反序列化字段的 系统校验规则 extra_kwargs = { 'name': { 'required': True, #设置name字段必填 'min_length': 1, 'error_messages': { 'required': '必填项', 'min_length': '太短', } } } # 局部钩子校验单个字段 validate_字段名 def validate_name(self, value): #value是字段name的值 # 书名不能包含 g 字符 if 'g' in value.lower(): raise ValidationError('该g书不能出版') return value # 全局钩子 def validate(self, attrs): publish = attrs.get('publish') #publish如果是外键字段,这个就是publish对象 name = attrs.get('name') if models.Book.objects.filter(name=name, publish=publish): raise ValidationError({'book': '该书已存在'}) return attrs # 注意:ModelSerializer类已经帮我们实现了 create 与 update 方法,不需要写create就能创建
视图层:views.py
def post(self,request,*args,**kwargs): request_data = request.data #获取post提交的数据包 book_ser = serializers.BookModelDeserializer(data=request_data) # raise_exception=True:当校验失败,马上终止当前视图方法,抛异常返回给前台 book_ser.is_valid(raise_exception=True) #检验是否合格 raise_exception=True必填的 book_obj = book_ser.save() #保存得到一个对象 return Response({ 'status':0, 'msg':'ok', 'results':serializers.BookModelSerializers(book_obj).data })
路由层:urls.py 在postman中访问路径时最后必须带上/,post请求方式只有json格式能一个字段提交多个值,放在列表或者元组中,其余两个只能传递单个值
urlpatterns = [ url(r'^books/$', views.Book.as_view()), url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
注意:(******)
反序列化层: 1.在设置fields,没有默认值的字段都必须设置反序列化保存到数据库中 2.使用extra_kwargs 来设置系统校验规则 3.设置局部钩子和全局钩子 4.ModelSerializer类已经帮我们实现了 create 与 update 方法,不需要再写 视图层: 1.POST请求通过request.data拿到数据包 2.传给反序列化 ,通过data=request_data传入需要反序列化的数据 3.is_valid判断校验是否合格 ,raise_exception=True必须要写的 4.通过.save()保存到数据库中
序列化与反序列化整合(******)
序列化层:api/serializers.py
class V2BookModelSerializer(ModelSerializer): class Meta: model = models.Book fields = ('name', 'price', 'img', 'author_list', 'publish_name', 'publish', 'authors') extra_kwargs = { 'name': { 'required': True, 'min_length': 1, 'error_messages': { 'required': '必填项', 'min_length': '太短', } }, 'publish': { 'write_only': True }, 'authors': { 'write_only': True }, 'img': { 'read_only': True, }, 'author_list': { 'read_only': True, }, 'publish_name': { 'read_only': True, } } def validate_name(self, value): # 书名不能包含 g 字符 if 'g' in value.lower(): raise ValidationError('该g书不能出版') return value def validate(self, attrs): publish = attrs.get('publish') name = attrs.get('name') if models.Book.objects.filter(name=name, publish=publish): raise ValidationError({'book': '该书已存在'}) return attrs
序列化层注意点:
1) fields中设置所有序列化与反序列化字段 2) extra_kwargs划分只序列化或只反序列化字段(一般我们把需要存入到数据库中的使用write_only(反序列化),只需要展示的就read_only(序列化),看需求设计) write_only:只反序列化 read_only:只序列化 自定义字段默认只序列化(read_only) 如果字段没设置write_only或者read_only,那么该字段可以序列化和反序列化 3) 设置反序列化所需的 系统、局部钩子、全局钩子 等校验规则
视图层:views.py
class V2Book(APIView): def get(self,request,*args,**kwargs): pk = kwargs.get('pk') #单查 if pk: try: book_obj = models.Book.objects.get(pk=pk,is_delete=False) book_data = serializers.V2BookModelSerializer(book_obj).data #序列化 except: return Response({ 'status':1, 'msg':'参数有误' }) #群查 else: book_query=models.Book.objects.filter(is_delete=False).all() book_data = serializers.V2BookModelSerializer(book_query,many=True).data #序列化 return Response({ 'status':0, 'msg':'ok', 'results':book_data }) def post(self,request,*args,**kwargs): #单增:传的数据是与model对应的一个字典 # 群增:设计传递的是多个model对应的字典列表,在postman中通过列表嵌套字典传值 request_data = request.data if isinstance(request_data,dict): #判断获取的数据是否是dict many = False elif isinstance(request_data,list): #判断获取的数据是否是list many = True else: return Response({ 'status':1, 'msg':'数据错误' }) book_ser = serializers.V2BookModelSerializer(data=request_data,many=many) #反序列化 book_ser.is_valid(raise_exception=True) book_result = book_ser.save() #book_result是对象<class 'app01.models.Book'>,群增就是列表套一个个对象
return Response({ 'status':0, 'msg':'ok', 'results':serializers.V2BookModelSerializer(book_result,many=many).data }) #单删: 有pk #在postman中通过路径传参 #群删:有pks {"pks": [1, 2, 3]} #通过json传参 def delete(self,request,*args,**kwargs): pk = kwargs.get('pk') if pk: pks = [pk] else: pks = request.data.get('pks') if models.Book.objects.filter(pk__in=pks,is_delete=False).update(is_delete=True): return Response({ 'status':0, 'msg':'删除成功' }) return Response({ 'status':1, 'msg':'删除失败' })
视图层注意点:(****)
1.序列化数据最后必须要.data (因为要传给前端)
2.反序列化通过data传参,序列化通过instance传参(当你只传一个参数时,默认是instanca的参数)
3.反序列化与序列化都能使用many=True,序列化和反序列化数据只要被[]嵌套都要写many=True
路由层:urls.py
urlpatterns = [ url(r'^v2/books/$', views.V2Book.as_view()), url(r'^v2/books/(?P<pk>.*)/$', views.V2Book.as_view()), ]
instance/data/many/partial四个关键参数的用法总结
instance/data/many/partial 影响序列化对象行为的四个关键参数。
序列化情况: 1.如果没有data参数,只有instance,那么就不存在反序列化校验一说,只有序列化对象instance。
反序列化情况: 2.如果有data,没有instance,那么需要进行校验data,然后将data进行反序列化,得到validated_data,此时再通过序列化对象获取data,这个data和初始化提供的data可不一样,这个序列化validated_data后的data,比起初始化data,可能减少了无效的字段(序列化没有定义的字段)。
修改情况: 3.如果又提供了instance 又提供了data, 那么只要有data或者部分data,那么data都要进行验证才能进行下面的save等操作,如果不经过is_valid过程,那么后面的获取序列化数据或者反序列化数据都会无效。
ListSerializer使用情况: 4.many参数将直接影响序列化类的类型,如果是many=False,那么直接使用当前序列化类。如果many=True,将实例化一个ListSerializer类来序列化或者反序列化类。(这也是看源码是漏掉的地方,一直奇怪普通Serialiszer类怎么没看到对多对象序列化的特殊处理。查看BaseSerializer.__new__方法)或者class Meta:中定义了list_serializer_class指定的多对象序列化类。
修改情况要用instance指明要修改的对象: 5.终于弄懂了,partial用于部分更新,为啥子要伴随instance,因为要指明给save用,在save操作时给那个instance部分更新。逻辑这回走到下面源码中的get_initial()获取要进行更新instance的字段数据。