目錄
序列化器
serializer的介紹：
- 序列化，序列化器會把模型對象轉換成字典，經過
response之后變成json字符串。 - 反序列化，把客戶端發送過來的數據，經過
request之后變成字典，序列化器可以把字典裝換成模型。 - 反序列化，完成數據的校驗功能
為方便理解后面序列化器中的字段，我們先在創建的APP中的models.py 建立一個數據庫模型類。
class Book(models.Model):
id = models.AutoField(primary_key=True)
name = models.CharField(max_length=32)
price = models.DecimalField(max_digits=5, decimal_places=2)
author = models.CharField(max_length=32)
publish = models.CharField(max_length=32)
1、定義Serializer類
drf 中的序列化器使用類來定義，這個類必須繼承rest_framework.serializer.Serializer 。在類中寫需要序列化的字段，即需要序列化哪些字段就在類中寫哪個字段。為使代碼清晰、方便管理，我們可以新建一個ser.py 文件來存儲序列化器的代碼。簡單定義代碼如下所示：
# ser.py
from rest_framework import serializers
# 聲明序列化器，所有的序列化器都要直接或間接的繼承於Serializer
class BookSerializer(serializers.Serializer):
id=serializers.CharField()
name=serializers.CharField()
# price=serializers.DecimalField()
'''
可以將各個字段數據類型與數據庫中的數據字段類型匹配，也可以將其裝換稱字符類型進行序列化傳遞到前段，在前段處理數據時再進行數據類型的變換
'''
price=serializers.CharField()
author=serializers.CharField()
publish=serializers.CharField()
注意：serializer 不是只能為數據庫模型類定義，也可以為非數據庫模型類的數據定義。serializer 是獨立於數據庫之外的存在。
它的常用字段：
| 字段 | 字段構造方式 |
|---|---|
| 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) 正則字段，驗證正則模式 [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-1238041fb31a" 2） 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3）'int' - 如: "123456789012312313134124512351145145114" 4）'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a" |
| 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: 最多位數 decimal_palces: 小數點位置 |
| 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=) |
選項參數：
| 參數名稱 | 作用 |
|---|---|
| max_length | 最大長度 |
| min_lenght | 最小長度 |
| allow_blank | 是否允許為空 |
| trim_whitespace | 是否截斷空白字符 |
| max_value | 最小值 |
| min_value | 最大值 |
通用參數：
| 參數名稱 | 說明 |
|---|---|
| read_only | 表明該字段僅用於序列化輸出，默認False |
| write_only | 表明該字段僅用於反序列化輸入，默認False |
| required | 表明該字段在反序列化時必須輸入，默認True |
| default | 反序列化時使用的默認值 |
| allow_null | 表明該字段是否允許傳入None，默認False |
| validators | 該字段使用的驗證器 |
| error_messages | 包含錯誤編號與錯誤信息的字典 |
| label | 用於HTML展示API頁面時，顯示的字段名稱 |
| help_text | 用於HTML展示API頁面時，顯示的字段幫助提示信息 |
2、創建Serializer對象
在定義好序列化器類之后，我們就可以創建序列化對象了。
序列化對象的夠造方法為：
Serializer(instance=None, data=empty, **kwarg)
說明：
- 用於序列化時，將模型類對象傳入instance參數
- 用於反序列化時，將要被反序列化的數據傳入data參數
- 除了instance和data參數外，在構造Serializer對象時，還可通過context參數額外添加數據，如除了instance和data參數外，在構造Serializer對象時，還可通過context參數額外添加數據，如
serializer = AccountSerializer(account, context={'request': request})
通過context參數附加的數據可以通過序列化對象的context屬性獲取。
注意：
- 使用序列化器的時候一定要注意，序列化器聲明了以后，不會自動執行，需要我們在視圖中進行調用才可以。
- 序列化器無法直接接收數據，需要我們在視圖中創建序列化器對象時把使用的數據傳遞過來。
- 序列化器的字段聲明類似於我們前面使用過的表單系統。
- 開發restful api時，序列化器會幫我們把模型數據轉換成字典。
- drf提供的視圖會幫我們把字典轉換成json,或者把客戶端發送過來的數據轉換字典。
3、序列化器的使用
序列化器的使用分為兩個階段：即在客戶端請求（提交）數據時，使用序列化器可以完成對數據的反序列化。在服務端響應時，使用序列化器可以完成對數據的序列化。將模型類數據裝換和其他數據裝換成json 格式的數據。
3.1 序列化
假如客戶端以get put （查詢/修改 一條數據）的請求方式與服務端進行數據交互，其中urls.py 中的路由匹配為：
urlpatterns = [
url(r'^admin/', admin.site.urls),
re_path('books/(?P<pk>\d+)', views.BookView.as_view()),
]
即當所有請求url 為127.0.0.1:8080/books/1 的形式時，會匹配到視圖類BookView ，並將pk=1作為關鍵字參數傳遞給它。
其中views.py 中有：
from rest_framework.views import APIView
from books.models import Book
from .ser import BookSerializer
class BookView(APIView):
def get(self,request,pk):
book=Book.objects.filter(id=pk).first() #獲取一個書的對象
book_ser=BookSerializer(book) #將學生對象傳入上面已經聲明的Serializer類中，調用類的__init__方法，實例化一個serializer對象。
# book_ser.data 序列化對象.data----->就是序列化后的字典
return Response(book_ser.data)
def put(self,request,pk):
response_msg={'status':100,'msg':'成功'}
# 找到這個對象
book = Book.objects.filter(id=pk).first()
# 得到一個序列化類的對象
# book_ser=BookSerializer(book,request.data) # 按照位置傳遞參數
book_ser=BookSerializer(instance=book,data=request.data) # 按照關鍵字傳遞參數
# 要進行數據驗證
if book_ser.is_valid(): # 返回True表示驗證通過
book_ser.save()
# 此處的save方法是序列化類提供的。
# 如果沒有重寫父類的update方法會報錯 這是因為抽象接口限制子類必須要重寫該方法（多態）
response_msg['data']=book_ser.data
else:
response_msg['status']=101
response_msg['msg']='數據校驗失敗'
response_msg['data']=book_ser.errors
return Response(response_msg)
此時客戶端獲取到的數據即為序列化后的書數據。
在ser.py 對應的序列化類中重寫的update 方法：
def update(self, instance, validated_data):
#instance是book這個對象
#validated_data是校驗后的數據
instance.name=validated_data.get('name')
instance.price=validated_data.get('price')
instance.author=validated_data.get('author')
instance.publish=validated_data.get('publish')
instance.save() #book.save() 此處的save方法是django 的orm提供的
return instance
3.2 反序列化
假如客戶端以post get （創建一條 / 查詢所有）請求方式與服務端進行數據交互，其中urls.py 的路由匹配為：
urlpatterns = [
url(r'^admin/', admin.site.urls),
re_path('books/(?P<pk>\d+)', views.BookView.as_view()),
path('books/', views.BooksView.as_view()),
]
即當所有請求的url 為127.0.0.1:8080/books/ 形式時會匹配到視圖類BooksView 。
其中view.py 中有：
class BooksView(APIView):
def get(self,request):
response_msg = {'status': 100, 'msg': '成功'}
books=Book.objects.all()
book_ser=BookSerializer(books,many=True) #序列化多條,如果序列化一條，不需要寫
response_msg['data']=book_ser.data
return Response(response_msg)
def post(self,request):
response_msg = {'status': 100, 'msg': '成功'}
#修改才有instance，新增沒有instance，只有data
book_ser = BookSerializer(data=request.data)
# book_ser = BookSerializer(request.data) # 這個按位置傳request.data會給instance，就報錯了
# 校驗字段
if book_ser.is_valid():
book_ser.save() #沒有重寫create方法會報錯 原因同上
response_msg['data']=book_ser.data
else:
response_msg['status']=102
response_msg['msg']='數據校驗失敗'
response_msg['data']=book_ser.errors
return Response(response_msg)
此時服務端保存的就是經過校驗和反序列化的客戶端發送來的序列化數據。
在ser.py 對應的序列化類中重寫的create 方法：
def create(self, validated_data):
instance=Book.objects.create(**validated_data)
return instance
3.3 補充delete
假如客戶端以post get （創建一條 / 查詢所有）請求方式與服務端進行數據交互，其中urls.py 的路由匹配為：
urlpatterns = [
url(r'^admin/', admin.site.urls),
re_path('books/(?P<pk>\d+)', views.BookView.as_view()),
]
其中view.py 中有：
class BookView(APIView):
def delete(self,request,pk):
Book.objects.filter(pk=pk).delete()
return Response({'status':100,'msg':'刪除成功'})
4、數據驗證
4.1 is_valid() 方法
使用序列化器進行反序列化時，需要對數據進行驗證后，才能獲取驗證成功的數據或保存成模型類對象。
在獲取反序列化的數據前，必須調用is_valid() 方法進行驗證，驗證成功返回True，否則返回False。
驗證失敗，可以通過序列化器對象的errors 屬性獲取錯誤信息，返回字典，包含了字段和字段的錯誤。如果是非字段錯誤，可以通過修改REST framework 配置中的NON_FIELD_ERRORS_KEY 來控制錯誤字典中的鍵名。
驗證成功，可以通過序列化器對象的validated_data屬性獲取數據。
在定義序列化器時，指明每個字段的序列化類型和選項參數，本身就是一種驗證行為。
如我們前面定義過的BookSerializer 。
class BookSerializer(serializers.Serializer):
id=serializers.CharField(read_only=True)
name=serializers.CharField(max_length=16,min_length=4)
# price=serializers.DecimalField()
price=serializers.CharField(write_only=True,required=True)
author=serializers.CharField(validators=[check_author]) # validators=[] 列表中寫函數內存地址
publish=serializers.CharField()
is_valid() 方法還可以在驗證失敗時拋出異常serializers.ValidationError ，可以通過傳遞raise_exception=True 參數開啟，REST framework 接收到此異常，會向前端返回HTTP 400 Bad Request響應。
4.2 validate_字段名
例如對price 字段進行驗證，在BookSerializer中定義方法：
def validate_price(self, data): # validate_字段名 接收一個參數
#如果價格小於10，就校驗不通過
# print(type(data))
# print(data)
if float(data)>10:
return data
else:
#校驗失敗，拋異常
raise ValidationError('價格太低')
4.3 validate
def validate(self, validate_data): # 全局鈎子
print(validate_data)
author=validate_data.get('author')
publish=validate_data.get('publish')
if author == publish:
raise ValidationError('作者名字跟出版社一樣')
else:
return validate_data
4.4 validators
在字段中添加validators 選項參數，也可以補充驗證行為，如
def check_author(data):
if data.startswith('sb'):
raise ValidationError('作者名字不能以sb開頭')
else:
return data
class BookSerializer(serializers.Serializer):
author=serializers.CharField(validators=[check_author]) # validators=[] 列表中寫函數內存地址
5、模型類序列化器
如果我們想要使用序列化器對應的是Django的模型類，DRF為我們提供了ModelSerializer模型類序列化器來幫助我們快速創建一個Serializer類。
ModelSerializer與常規的Serializer相同，但提供了：
- 基於模型類自動生成一系列字段
- 基於模型類自動為Serializer生成validators，比如unique_together
- 包含默認的create()和update()的實現
5.1 定義
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model=Book # 對應上models.py中的模型
fields='__all__'
- model 指明參照哪個模型類
- fields 指明為模型類的哪些字段生成
5.2 指定字段
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model = Book # 對應上models.py中的模型
fields = '__all__'
# fields=('name','price','id','author') # 只序列化指定的字段
# exclude=('name',) #跟fields不能都寫，寫誰，就表示排除誰
# read_only_fields=('price',)
# write_only_fields=('id',) #棄用了，使用extra_kwargs
extra_kwargs = { # 類似於這種形式name=serializers.CharField(max_length=16,min_length=4)
'price': {'write_only': True},
}
我們可以使用extra_kwargs參數為ModelSerializer添加或修改原有的選項參數
class BookInfoSerializer(serializers.ModelSerializer):
"""圖書數據序列化器"""
class Meta:
model = BookInfo
fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')
extra_kwargs = {
'bread': {'min_value': 0, 'required': True},
'bcomment': {'min_value': 0, 'required': True},
}
# BookInfoSerializer():
# id = IntegerField(label='ID', read_only=True)
# btitle = CharField(label='名稱', max_length=20)
# bpub_date = DateField(allow_null=True, label='發布日期', required=False)
# bread = IntegerField(label='閱讀量', max_value=2147483647, min_value=0, required=True)
# bcomment = IntegerField(label='評論量', max_value=2147483647, min_value=0, required=True)
6、補充
many=True的實際用途
# 序列化多條，需要傳many=True
#
book_ser=BookModelSerializer(books,many=True)
book_one_ser=BookModelSerializer(book)
print(type(book_ser))
#<class 'rest_framework.serializers.ListSerializer'>
print(type(book_one_ser))
#<class 'app01.ser.BookModelSerializer'>
# 對象的生成--》先調用類的__new__方法，生成空對象
# 對象=類名(name=lqz)，觸發類的__init__()
# 類的__new__方法控制對象的生成
def __new__(cls, *args, **kwargs):
if kwargs.pop('many', False):
return cls.many_init(*args, **kwargs)
# 沒有傳many=True,走下面，正常的對象實例化
return super().__new__(cls, *args, **kwargs)
Serializer高級用法
# source的使用
1 可以改字段名字 xxx=serializers.CharField(source='title')
2 可以.跨表publish=serializers.CharField(source='publish.email')
3 可以執行方法pub_date=serializers.CharField(source='test') test是Book表模型中的方法
# SerializerMethodField(）的使用
1 它需要有個配套方法，方法名叫get_字段名，返回值就是要顯示的東西
authors=serializers.SerializerMethodField() #它需要有個配套方法，方法名叫get_字段名，返回值就是要顯示的東西
def get_authors(self,instance):
# book對象
authors=instance.authors.all() # 取出所有作者
ll=[]
for author in authors:
ll.append({'name':author.name,'age':author.age})
return ll
Author：Laoqi