QuerySet
對(duì)象 :queryset_obj = models.Book.objects.all()
為樅陽(yáng)等地區(qū)用戶(hù)提供了全套網(wǎng)頁(yè)設(shè)計(jì)制作服務(wù),及樅陽(yáng)網(wǎng)站建設(shè)行業(yè)解決方案。主營(yíng)業(yè)務(wù)為成都網(wǎng)站設(shè)計(jì)、成都網(wǎng)站制作、樅陽(yáng)網(wǎng)站設(shè)計(jì),以傳統(tǒng)方式定制建設(shè)網(wǎng)站,并提供域名空間備案等一條龍服務(wù),秉承以專(zhuān)業(yè)、用心的態(tài)度為用戶(hù)提供真誠(chéng)的服務(wù)。我們深信只要達(dá)到每一位用戶(hù)的要求,就會(huì)得到認(rèn)可,從而選擇與我們長(zhǎng)期合作。這樣,我們也可以走得更遠(yuǎn)!
單個(gè)對(duì)象:book = models.Book.objects.all().first()
QuerySet
對(duì)象、單個(gè) book
對(duì)象)轉(zhuǎn)成字典,在經(jīng)過(guò) response
的時(shí)候序列化成 json
格式返回給前端。request
之變成程字典(request.data
),序列化器再把字典轉(zhuǎn)成模型,存到數(shù)據(jù)庫(kù)中。首先得在序列化器模塊中書(shū)寫(xiě)序列化類(lèi)。
然后在視圖函數(shù)模塊中書(shū)寫(xiě) CBV
的get
方法(獲取數(shù)據(jù))
序列化類(lèi)的書(shū)寫(xiě)步驟和使用流程:
第一步:寫(xiě)一個(gè)類(lèi):必須繼承drf中的Serializer及其子類(lèi)
第二步:在類(lèi)中寫(xiě)要序列化的字段-->要序列化哪些,就寫(xiě)哪些,不序列化的不寫(xiě)
第三步:使用序列化類(lèi),視圖類(lèi)中用
第四步:視圖函數(shù)中得到序列化類(lèi)對(duì)象 對(duì)象.data,通過(guò)Response返回給前端
模型類(lèi)(models.py):
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.DecimalField(decimal_places=2, max_digits=5)
author = models.CharField(max_length=32)
序列化類(lèi)(ser.py):
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.Serializer):
# max_length=32,min_length=3 反序列化保存校驗(yàn)數(shù)據(jù)的時(shí)候用
name = serializers.CharField(max_length=8, min_length=3)
price=serializers.CharField() # models中使用了DecimalField,這個(gè)位置使用了CharField會(huì)把小數(shù)類(lèi)型轉(zhuǎn)成字符串
author = serializers.CharField()
視圖層類(lèi)(views.py)
class BookView(APIView):
def get(self,request):
# 查出來(lái)的數(shù)據(jù)做序列化
book_list=Book.objects.all()
# instance:要序列化的對(duì)象 qs,單個(gè)對(duì)象
# many:如果是qs對(duì)象,many=True,如果是單個(gè)對(duì)象many=False
ser=BookSerializer(instance=book_list,many=True) # 傳入初始化的參數(shù)instance=None, data=empty
# ser.data使用模型類(lèi)對(duì)象序列化后的字典
return Response(ser.data) # 字典,列表,字符串都行
路由:
from app01 import views
urlpatterns = [
path('admin/', admin.site.urls),
path('books/', views.BookView.as_view()),
]
需要記憶:
CharField
IntegerField
FloatField
DecimalField
DateTimeField
DateField
了解:
反序列化時(shí),前端發(fā)送進(jìn)來(lái)的json
數(shù)據(jù)中,也有值是列表或者字典的時(shí)候,那么這種數(shù)據(jù)我們需要用什么字段來(lái)反序列化?
{name:lqz,age:19,hobby:[籃球,足球],wife:{name:lyf,age:38}}
ListField
反序列化列表值DictField
反序列化字典值字段 | 字段構(gòu)造方式 |
---|---|
BooleanField | BooleanField() |
NullBooleanField | NullBooleanField() |
CharField | CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) |
EmailField | EmailField(max_length=None, min_length=None, allow_blank=False) |
RegexField | RegexField(regex, max_length=None, min_length=None, allow_blank=False) |
SlugField | SlugField(maxlength=50, min_length=None, allow_blank=False) 正則字段,驗(yàn)證正則模式 [a-zA-Z0-9-]+ |
URLField | URLField(max_length=200, min_length=None, allow_blank=False) |
UUIDField | UUIDField(format=’hex_verbose’) format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-fb31a" 2) 'hex' 如 "5ce0e9a55ffa654bcee0fb31a" 3)'int' - 如: "" 4)'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-fb31a" |
IPAddressField | IPAddressField(protocol=’both’, unpack_ipv4=False, **options) |
IntegerField | IntegerField(max_value=None, min_value=None) |
FloatField | FloatField(max_value=None, min_value=None) |
DecimalField | DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位數(shù) decimal_palces: 小數(shù)點(diǎn)位置 |
DateTimeField | DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None) |
DateField | DateField(format=api_settings.DATE_FORMAT, input_formats=None) |
TimeField | TimeField(format=api_settings.TIME_FORMAT, input_formats=None) |
DurationField | DurationField() |
ChoiceField | ChoiceField(choices) choices與Django的用法相同 |
MultipleChoiceField | MultipleChoiceField(choices) |
FileField | FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ImageField | ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ListField | ListField(child=, min_length=None, max_length=None) |
DictField | DictField(child=) |
序列化器中字段參數(shù)是用來(lái)在反序列化時(shí)做校驗(yàn)數(shù)據(jù)的功能作用
如 max_length
是限制數(shù)據(jù)的字符長(zhǎng)度
重點(diǎn)記憶:
read_only
:該字段只能序列化,后端發(fā)送給前端看write_only
:該字段只能反序列化,由前端發(fā)送到后端保存例子:
# 什么都不寫(xiě),表示 name 字段既序列化,又反序列化
name=serializers.CharField(max_length=32,min_length=3)
# 只反序列化,author 字段只能由前端把作者信息發(fā)到后端保存
author=serializers.CharField(write_only=True)
# 這是錯(cuò)誤寫(xiě)法,write_only=True,read_only=True 邏輯矛盾
price=serializers.CharField(write_only=True,read_only=True)
選項(xiàng)參數(shù):
參數(shù)名稱(chēng) | 作用 |
---|---|
max_length | 最大長(zhǎng)度(CharField) |
min_lenght | 最小長(zhǎng)度(CharField) |
allow_blank | 是否允許為空(CharField) |
trim_whitespace | 是否截?cái)嗫瞻鬃址–harField) |
max_value | 最小值 (IntegerField) |
min_value | 最大值(IntegerField) |
通用參數(shù):
參數(shù)名稱(chēng) | 說(shuō)明 |
---|---|
read_only | 表明該字段僅用于序列化輸出,默認(rèn)False |
write_only | 表明該字段僅用于反序列化輸入,默認(rèn)False |
required | 表明該字段在反序列化時(shí)必須輸入,默認(rèn)True |
default | 反序列化時(shí)使用的默認(rèn)值 |
allow_null | 表明該字段是否允許傳入None,默認(rèn)False |
validators | 該字段使用的驗(yàn)證器(不太用) |
error_messages | 包含錯(cuò)誤編號(hào)與錯(cuò)誤信息的字典 |
label | 用于HTML展示API頁(yè)面時(shí),顯示的字段名稱(chēng) |
help_text | 用于HTML展示API頁(yè)面時(shí),顯示的字段幫助提示信息 |
方式一:在序列化類(lèi)中寫(xiě)
使用 serializers
的SerializerMethodField()
來(lái)定制,但必須配合一個(gè)方法,方法名get_字段名,方法返回什么,字段就是什么,obj是當(dāng)前序列化到的模型類(lèi)中的單個(gè)對(duì)象(queryset
或 單個(gè) book
)
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price=serializers.CharField()
author = serializers.CharField()
# 在序列化后返回給前端時(shí),前端就可以多看到一個(gè) price_info 值
price_info = serializers.SerializerMethodField()
def get_price_info(self, obj): # obj是當(dāng)前序列化到的單個(gè)對(duì)象
return "價(jià)格是:"+str(obj.price)
方式二:在模型類(lèi)中寫(xiě)
表模型中寫(xiě)方法,并且把方法包裝成數(shù)據(jù)屬性,在序列化類(lèi)中使用的時(shí)候把該方法當(dāng)作普通字段
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.DecimalField(decimal_places=2, max_digits=5)
author = models.CharField(max_length=32)
@property # 把方法包裝成數(shù)據(jù)屬性
def price_info(self):
return "價(jià)格是:" + str(self.price)
在序列化類(lèi)中使用:
只能給前端看,前端不能傳送該字段的值(只序列化)
price_info=serializers.CharField(read_only=True) # 只用來(lái)做序列化
反序列化同時(shí)可以進(jìn)行數(shù)據(jù)校驗(yàn)
具體步驟如下:
第一步:把前端傳入的數(shù)據(jù),放到Serializer對(duì)象中:ser=BookSerializer(data=request.data)
第二步:校驗(yàn)數(shù)據(jù):ser.is_valid():
第三步:保存,ser.save()---》必須重寫(xiě)create,在序列化類(lèi)中
# 校驗(yàn)通過(guò)的數(shù)據(jù)都存放在 validated_data 中
def create(self, validated_data):
book=Book.objects.create(**validated_data)
return book
如果instance為None,調(diào)用save本質(zhì)會(huì)調(diào)用create,父類(lèi)create是直接拋異常的,所以我們要重寫(xiě)
視圖層類(lèi):
class BookView(APIView):
def post(self,request):
# 反序列化,保存---》使用data參數(shù)
ser=BookSerializer(data=request.data) #
# 校驗(yàn)數(shù)據(jù)
if ser.is_valid(): # 如果是true表示數(shù)據(jù)校驗(yàn)通過(guò),通過(guò),就保存
ser.save() # 就會(huì)保存,重寫(xiě)create方法,如果不重寫(xiě),我們不知道存到哪個(gè)表中
return Response(ser.data)
return Response({'code':101,'msg':'數(shù)據(jù)校驗(yàn)失敗','err':ser.errors})
序列化類(lèi):
注意:重寫(xiě) create
方法后 不要忘記返回book對(duì)象
from rest_framework import serializers
from .models import Book
# drf提供的類(lèi):Serializer
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price=serializers.CharField()
author = serializers.CharField()
price_info=serializers.CharField(read_only=True) # 只用來(lái)做序列化
def create(self, validated_data):
# validated_data校驗(yàn)過(guò)后的數(shù)據(jù)
# 手動(dòng)存到book表中
book=Book.objects.create(**validated_data)
# book=Book.objects.create(name=validated_data.get('name'))
return book # 不要忘記返回book對(duì)象
視圖層類(lèi):
寫(xiě) put 方法,與 get
方法很像,但 put 方法序列化器中要有 instance
參數(shù)
class BookDetailView(APIView):
def put(self, request, pk):
# 修改:用什么數(shù)據(jù),修改哪個(gè)對(duì)象?
book = Book.objects.filter(pk=pk).first()
# 既有instance,又有data,表示修改
ser = BookSerializer(instance=book, data=request.data)
if ser.is_valid():
# 重寫(xiě)update方法
ser.save() # 調(diào)用save---》內(nèi)部根據(jù)instance判斷是觸發(fā)create還是update
return Response(ser.data)
return Response({'code': 102, 'msg': '修改出錯(cuò)', 'err': ser.errors})
序列化類(lèi):
修改,需要重寫(xiě) 序列化類(lèi) 中的update
方法,否則和新增一樣也會(huì)報(bào)錯(cuò)
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price=serializers.CharField()
author = serializers.CharField()
def update(self, instance, validated_data):
# validated_data校驗(yàn)過(guò)后的數(shù)據(jù),instance 是要修改的對(duì)象
instance.name = validated_data.get('name')
instance.price = validated_data.get('price')
instance.author = validated_data.get('author')
instance.save() # 模型對(duì)象自帶的save,保存到數(shù)據(jù)庫(kù)中
return instance # 要忘記返回instance對(duì)象
與 forms
組件類(lèi)中的校驗(yàn)局部鉤子全局鉤子書(shū)寫(xiě)方法幾乎一樣。
需要在序列化類(lèi)中書(shū)寫(xiě)局部和全局鉤子
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price=serializers.CharField()
author = serializers.CharField()
# 局部鉤子
# 字段有自己的校驗(yàn):max_length .... ,再校驗(yàn),就可以寫(xiě)局部鉤子
def validate_name(self, attr):
# attr就是前端傳入的數(shù)據(jù)
# 名字不能以sb開(kāi)頭
if attr.startswith('sb'):
raise ValidationError("名字不能以sb開(kāi)頭")
else:
return attr # 沒(méi)有問(wèn)題,正常返回
# 先走字段自己規(guī)則,再走局部鉤子,再走全局鉤子
# 全局鉤子
def validate(self, attrs):
# attrs校驗(yàn)過(guò)后的數(shù)據(jù)
if attrs.get('name') == attrs.get('author'):
raise ValidationError('作者名不能等于書(shū)名')
else:
return attrs
以后我們?cè)趯?shí)際開(kāi)發(fā)中會(huì)使用ModelSerializer
跟表模型做綁定比較多,不需要重寫(xiě)update
和create
方法了
序列化類(lèi):
class BookSerializer2(serializers.ModelSerializer):
class Meta:
model = Book # 跟哪個(gè)表有關(guān)系
fields='__all__' # 所有字段
# id是從表模型中映射過(guò)來(lái)的,auto,它會(huì)不要求你傳
# price_info:它不是數(shù)據(jù)庫(kù)中字段
# 即便擴(kuò)寫(xiě)的字段,也要在fields中注冊(cè)
# fields = ['id', 'name', 'price', 'author', 'price_info']
# 重寫(xiě)字段
# 局部和全局鉤子跟之前一樣
class BookSerializer2(serializers.ModelSerializer):
class Meta:
model = Book
fields = ['id', 'name', 'price', 'author', 'price_info']
# 原來(lái)的字段參數(shù),通過(guò)extra_kwargs傳進(jìn)去
extra_kwargs = {
'name': {'write_only': True, 'max_length': 8, 'min_length': 3}
}
圖書(shū)表:跨表查詢(xún)出版社表和作者表
定制序列化字段:
注意:在 sqlite
這中數(shù)據(jù)庫(kù)中如果存時(shí)間字段,查詢(xún)時(shí)會(huì)報(bào)錯(cuò)
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.DecimalField(max_digits=5, decimal_places=2)
publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)
authors = models.ManyToManyField(to='Author')
def __str__(self):
return self.name
@property
def publish_detail(self): # 定制序列化字段,想查詢(xún)什么就返回什么結(jié)果
return {'name': self.publish.name, 'addr': self.publish.city}
@property
def author_list(self):
l = []
print(self.authors.all()) # 查詢(xún)改圖書(shū)對(duì)應(yīng)的作者對(duì)象
for author in self.authors.all():
print(author.author_detail)
l.append({'name': author.name,'age':author.age,'addr':author.author_detail.addr})
return l
作者表、作者詳情表、出版社表:
class Author(models.Model):
name = models.CharField(max_length=32)
age = models.IntegerField()
author_detail = models.OneToOneField(to='AuthorDatail', on_delete=models.CASCADE)
# OneToOneField 就是ForeignKey+unique=True
class AuthorDatail(models.Model):
telephone = models.BigIntegerField()
# birthday = models.DateField()
addr = models.CharField(max_length=64)
class Publish(models.Model):
name = models.CharField(max_length=32)
city = models.CharField(max_length=32)
email = models.EmailField()
圖書(shū)表的序列化類(lèi):
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = ['id', 'name', 'price', 'authors', 'publish', 'publish_detail', 'author_list']
# depth=1 # 盡量不要用,關(guān)聯(lián)表一層全部取出來(lái)
extra_kwargs = {
'publish': {'write_only': True}, # 這兩個(gè)字段數(shù)據(jù)只能反序列化
'authors': {'write_only': True},
}
class AuthorSerialzier(serializers.ModelSerializer):
class Meta:
model = Author
fields = '__all__'
class AuthorDetailSerialzier(serializers.ModelSerializer):
class Meta:
model = AuthorDatail
fields = '__all__'
class PublishSerialzier(serializers.ModelSerializer):
class Meta:
model = Publish
fields = '__all__'
不需要傳入?yún)?shù) pk 的操作:獲取所有資源(get
請(qǐng)求)、新增一個(gè)資源(post
)請(qǐng)求
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
ser = BookSerializer(instance=book_list, many=True)
return Response(ser.data)
def post(self, request):
ser = BookSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({"code": 100, 'msg': '新增成功', 'data': ser.data})
return Response({"code": 101, 'msg': '新增出錯(cuò)', 'err': ser.errors})
需要傳入 pk 參數(shù),并且只操作單個(gè)資源對(duì)象的操作:獲取單個(gè)資源(get
請(qǐng)求)、修改資源(put
請(qǐng)求)、刪除資源(delete
請(qǐng)求)
class BookDetailView(APIView):
def get(self, request, pk):
book = Book.objects.all().filter(pk=pk).first()
ser = BookSerializer(instance=book)
return Response(ser.data)
def put(self, request, pk):
book = Book.objects.all().filter(pk=pk).first()
ser = BookSerializer(instance=book, data=request.data)
if ser.is_valid():
ser.save()
return Response({"code": 100, 'msg': '修改成功', 'data': ser.data})
return Response({"code": 101, 'msg': '修改出錯(cuò)', 'err': ser.errors})
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return Response({"code": 100, 'msg': '刪除成功'})
urlpatterns = [
path('admin/', admin.site.urls),
path('books/', views.BookView.as_view()),
path('books/', views.BookDetailView.as_view()),
]
新增測(cè)試: