做用:前端
1. 序列化,序列化器會把模型對象轉換成字典,通過response之後變成json字符串 2. 反序列化,把客戶端發送過來的數據,通過request之後變成字典,序列化器能夠把字典轉成模型 3. 反序列化,完成數據校驗功能
Django REST framework中的Serializer使用類來定義,須繼承自rest_framework.serializers.Serializer。python
接下來,爲了方便演示序列化器的使用,咱們先建立一個新的子應用sersgit
python manage.py startapp sers
咱們已有了一個數據庫模型類students/Student數據庫
from django.db import models # Create your models here. class Student(models.Model): # 模型字段 name = models.CharField(max_length=100,verbose_name="姓名",help_text="提示文本:帳號不能爲空!") sex = models.BooleanField(default=True,verbose_name="性別") age = models.IntegerField(verbose_name="年齡") class_null = models.CharField(max_length=5,verbose_name="班級編號") description = models.TextField(verbose_name="個性簽名") class Meta: db_table="tb_student" verbose_name = "學生" verbose_name_plural = verbose_name
咱們想爲這個模型類提供一個序列化器,能夠定義以下:django
from rest_framework import serializers # 聲明序列化器,全部的序列化器都要直接或者間接繼承於 Serializer # 其中,ModelSerializer是Serializer的子類,ModelSerializer在Serializer的基礎上進行了代碼簡化 class StudentSerializer(serializers.Serializer): """學生信息序列化器""" # 1. 須要進行數據轉換的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField() # 2. 若是序列化器集成的是ModelSerializer,則須要聲明調用的模型信息 # 3. 驗證代碼 # 4. 編寫添加和更新模型的代碼
注意:serializer不是隻能爲數據庫模型類定義,也能夠爲非數據庫模型類的數據定義。serializer是獨立於數據庫以外的存在。json
經常使用字段類型:後端
字段 | 字段構造方式 |
---|---|
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=) |
選項參數:api
參數名稱 | 做用 |
---|---|
max_length | 最大長度 |
min_length | 最小長度 |
allow_blank | 是否容許爲空 |
trim_whitespace | 是否截斷空白字符 |
max_value | 最大值 |
min_value | 最小值 |
通用參數:bash
參數名稱 | 說明 |
---|---|
read_only | 代表該字段僅用於序列化輸出,默認False |
write_only | 代表該字段僅用於反序列化輸入,默認False |
required | 代表該字段在反序列化時必須輸入,默認True |
default | 反序列化時使用的默認值 |
allow_null | 代表該字段是否容許傳入None,默認False |
validators | 該字段使用的驗證器 |
error_messages | 包含錯誤編號與錯誤信息的字典 |
label | 用於HTML展現API頁面時,顯示的字段名稱 |
help_text | 用於HTML展現API頁面時,顯示的字段幫助提示信息 |
定義好Serializer類後,就能夠建立Serializer對象了。服務器
Serializer的構造方法爲:
Serializer(instance=None, data=empty, **kwarg)
說明:
1)用於序列化時,將模型類對象傳入instance參數
2)用於反序列化時,將要被反序列化的數據傳入data參數
3)除了instance和data參數外,在構造Serializer對象時,還可經過context參數額外添加數據,如
serializer = AccountSerializer(account, context={'request': request})
經過context參數附加的數據,能夠經過Serializer對象的context屬性獲取。
序列化器的使用分兩個階段:
使用序列化器進行反序列化時,須要對數據進行驗證後,才能獲取驗證成功的數據或保存成模型類對象。
在獲取反序列化的數據前,必須調用is_valid()方法進行驗證,驗證成功返回True,不然返回False。
驗證失敗,能夠經過序列化器對象的errors屬性獲取錯誤信息,返回字典,包含了字段和字段的錯誤。若是是非字段錯誤,能夠經過修改REST framework配置中的NON_FIELD_ERRORS_KEY來控制錯誤字典中的鍵名。
驗證成功,能夠經過序列化器對象的validated_data屬性獲取數據。
在定義序列化器時,指明每一個字段的序列化類型和選項參數,自己就是一種驗證行爲。
爲了方便演示效果,咱們單獨再次建立一個子應用unsers,。
python manage.py startapp unsers
定義序列化器,代碼:
from rest_framework import serializers class StudentSerializer(serializers.Serializer): # 須要轉換的字段聲明 # 小括號裏面聲明主要提供給反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False,allow_null=True, allow_blank=True) #required=False,字段均可以不傳遞給後端,allow_null=True,容許提交過來的數據爲空值(null--None),allow_blank=True 容許提交過來的數據爲空字符串 # 若是序列化器調用的模型中的字段聲明,則須要聲明Meta類 # 驗證 # 添加和更新代碼
經過構造序列化器對象,並將要反序列化的數據傳遞給data構造參數,進而進行驗證
# Create your views here. from django.http import JsonResponse from django.views import View from .serializers import StudentSerializer from students.models import Student class StudentView(View): def post(self,request): """添加一個學生""" # 接受參數 post_data = request.POST data = { "name":post_data.get('name'), "age":post_data.get('age'), "sex":post_data.get('sex'), "description":post_data.get('description'), } # 調用序列化器進行反序列化驗證和轉換 serializer = StudentSerializer(data=data) serializer.errors #查看錯誤信息 # 當驗證失敗時,能夠直接經過聲明 raise_exception=True 讓django直接跑出異常,那麼驗證出錯以後,直接就再這裏報錯,程序中斷了就 result = serializer.is_valid(raise_exception=True) print( "驗證結果:%s" % result ) # 獲取經過驗證後的數據 print( serializer.validated_data ) # form -- clean_data # 保存數據 student = Student.objects.create( name=serializer.validated_data.get("name"), age=serializer.validated_data.get("age"), sex=serializer.validated_data.get("sex") ) print(student) # 返回響應結果給客戶端 # alt + enter,能夠實現快速導包 return JsonResponse({"message": "ok"})
is_valid()方法還能夠在驗證失敗時拋出異常serializers.ValidationError,能夠經過傳遞raise_exception=True參數開啓,REST framework接收到此異常,會向前端返回HTTP 400 Bad Request響應。
# Return a 400 response if the data was invalid. serializer.is_valid(raise_exception=True)
若是以爲這些還不夠,須要再補充定義驗證行爲,可使用如下三種方法:
局部鉤子
對<field_name>
字段進行驗證,如
class StudentSerializer(serializers.Serializer): """學生數據序列化器""" ... # 序列化器中能夠自定義單個字段的驗證方法 def validate_<字段名>(用戶提交的字段數據): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用戶名不能是老男孩") # 驗證完成之後務必要返回字段值 return data
全局鉤子
在序列化器中須要同時對多個字段進行比較驗證時,能夠定義validate方法來驗證,如
class StudentSerializer(serializers.Serializer): """學生數據序列化器""" ... # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用戶名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年齡不能是0") # 驗證完成之後務必要返回data return data
在字段中添加validators選項參數,也能夠補充驗證行爲,如
def check_age(age): if age ==50: raise serializers.ValidationError("年齡不能恰好是50") return age class StudentSerializer(serializers.Serializer): # 須要轉換的字段聲明 # 小括號裏面聲明主要提供給反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False,allow_null=True, allow_blank=True)
前面的驗證數據成功後,咱們可使用序列化器來完成數據反序列化的過程.這個過程能夠把數據轉成模型類對象.
首先咱們能夠在views中直接寫上保存數據的代碼
# Create your views here. from django.http import JsonResponse from django.views import View from .serializers import StudentSerializer from students.models import Student class StudentView(View): def post(self,request): """添加一個學生""" # 接受參數 post_data = request.POST data = { "name":post_data.get('name'), "age":post_data.get('age'), "sex":post_data.get('sex'), "description":post_data.get('description'), } serializer = StudentSerializer(data=data) serializer.errors result = serializer.is_valid(raise_exception=True) print( "驗證結果:%s" % result ) print( serializer.validated_data ) student = Student.objects.create( name=serializer.validated_data.get("name"), age=serializer.validated_data.get("age"), sex=serializer.validated_data.get("sex") ) print(student) return JsonResponse({"message": "ok"})
還能夠經過序列化器提供的create()和update()兩個方法來實現。
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年齡不能恰好是50") return age class StudentSerializer(serializers.Serializer): # 須要轉換的字段聲明 # 小括號裏面聲明主要提供給反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False,allow_null=True, allow_blank=True) #required=False, # 若是序列化器調用的模型中的字段聲明,則須要聲明Meta類 # 驗證 # 序列化器中能夠自定義單個字段的驗證方法 def validate_<字段名>(用戶提交的字段數據): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用戶名不能是老男孩") # 驗證完成之後務必要返回字段值 return data # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用戶名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年齡不能是0") # 驗證完成之後務必要返回data return data # 添加和更新代碼 # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): #instance表示當前更新的記錄對象 """更新學生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 調用模型的save更新保存數據 instance.save() return instance
實現了上述兩個方法後,在視圖中調用序列化器進行反序列化數據的時候,就能夠經過save()方法返回一個數據對象實例了
student = serializer.save() #若是是添加,自動會調用create,更新就自動調用update
視圖代碼:
# Create your views here. from django.http import JsonResponse from django.views import View from .serializers import StudentSerializer from students.models import Student class StudentView(View): def post(self,request): """添加一個學生""" .... def put(self,request): """更新學生信息""" # 接受參數 data = { "id":9, "name":"abc", "age":18, "sex":1, "description":"測試", } # 獲取要修改的數據 instance = Student.objects.get(pk=data.get("id")) # 調用序列化器 serializer = StudentSerializer(instance=instance,data=data) # 驗證 serializer.is_valid(raise_exception=True) # 轉換成模型數據 student = serializer.save() return JsonResponse({"message": "ok"})
若是建立序列化器對象的時候,沒有傳遞instance實例,則調用save()方法的時候,create()被調用,相反,若是傳遞了instance實例,則調用save()方法的時候,update()被調用。
1) 在對序列化器進行save()保存時,能夠額外傳遞數據,這些數據能夠在create()和update()中的validated_data參數獲取到
# request.user 是django中記錄當前登陸用戶的模型對象 serializer.save(owner=user)
2)默認序列化器必須傳遞全部required的字段,不然會拋出驗證異常。可是咱們可使用partial參數來容許部分字段更新
# 更新學生的部分字段信息,當數據庫容許爲空,可是序列化器要求必須字段填寫的時候,可使用如下方式避開 serializer = StudentSerializer(instance=instance, data=data, partial=True)
把上面序列化器子應用sers和反序列化器子應用unsers裏面的序列化器進行對比。
from rest_framework import serializers # 聲明序列化器,全部的序列化器都要直接或者間接繼承於 Serializer # 其中,ModelSerializer是Serializer的子類,ModelSerializer在Serializer的基礎上進行了代碼簡化 class StudentSerializer(serializers.Serializer): """學生信息序列化器""" # 1. 須要進行數據轉換的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField()
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年齡不能恰好是50") return age class StudentSerializer(serializers.Serializer): # 須要轉換的字段聲明 # 小括號裏面聲明主要提供給反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False, allow_null=True, allow_blank=True) # 若是序列化器調用的模型中的字段聲明,則須要聲明Meta類 # 驗證 # 序列化器中能夠自定義單個字段的驗證方法 def validate_<字段名>(用戶提交的字段數據): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用戶名不能是老男孩") # 驗證完成之後務必要返回字段值 return data # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用戶名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年齡不能是0") # 驗證完成之後務必要返回data return data # 添加和更新代碼 # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): """更新學生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 調用模型的save更新保存數據 instance.save() return instance
能夠發現,反序列化器中的代碼會包含了序列化器中的大部分代碼,除了ID字段的聲明。
因此在開發的時候,咱們通常都是直接寫在一塊兒,那麼有些字段只會出如今序列化器階段,例如ID。還有些字段只會出如今反序列化階段,例如:用戶密碼。
那麼, 咱們須要在序列化器類中,聲明那些字段是在序列化時使用,哪些字段在反序列化中使用了。
最終序列化器中的代碼:
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年齡不能恰好是50") return age class StudentSerializer(serializers.Serializer): # 須要轉換的字段聲明 # 小括號裏面聲明主要提供給反序列化使用的 id=serializers.IntegerField(read_only=True) #read_only=True讀取數據時能讀出來,反序列化校驗數據的時候不須要校驗。 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True,write_only=True)#write_only=True讀取數據時不能讀出來。可是反序列化校驗數據保存時,須要傳給咱們的序列化器 description = serializers.CharField(required=True, allow_null=True, allow_blank=True) # 若是序列化器調用的模型中的字段聲明,則須要聲明Meta類 # 驗證 # 序列化器中能夠自定義單個字段的驗證方法 def validate_<字段名>(用戶提交的字段數據): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用戶名不能是老男孩") # 驗證完成之後務必要返回字段值 return data # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用戶名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年齡不能是0") # 驗證完成之後務必要返回data return data # 添加和更新代碼 # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): """更新學生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 調用模型的save更新保存數據 instance.save() return instance
若是咱們想要使用序列化器對應的是Django的模型類,DRF爲咱們提供了ModelSerializer模型類序列化器來幫助咱們快速建立一個Serializer類。
ModelSerializer與常規的Serializer相同,但提供了:
爲了方便學習和查看效果, 新建一個子應用msers。
python manage.py startapp msers
好比咱們建立一個StudentModelSerializer
from rest_framework import serializers from students.models import Student class StudentModelSerializer(serializers.ModelSerializer): # 字段聲明 # 若是模型類序列化器,必須聲明本次調用是哪一個模型,模型裏面的哪些字段 class Meta: model = Student fields = ["id","name","age","description","sex"] # fields = "__all__" # 表示操做模型中的全部字段 # 添加額外的驗證選項 exclude = ['id',] # 排除字段 extra_kwargs = { "sex":{"write_only":True,}, "id":{"read_only":True,} }
__all__
表名包含全部字段,也能夠寫明具體哪些字段,如class StudentModelSerializer(serializers.ModelSerializer): """學生數據序列化器""" class Meta: model = Student fields = ['id', 'age', 'name',"description"]
class StudentModelSerializer(serializers.ModelSerializer): """學生數據序列化器""" class Meta: model = Student exclude = ['sex']
能夠經過read_only_fields指明只讀字段,即僅用於序列化輸出的字段
class StudentModelSerializer(serializers.ModelSerializer): """學生數據序列化器""" class Meta: model = Student fields = ['id', 'age', 'name',"description"] read_only_fields = ('id',) #write_only_fields = ('sex',)
咱們可使用extra_kwargs參數爲ModelSerializer添加或修改原有的選項參數
from rest_framework import serializers from students.models import Student class StudentModelSerializer(serializers.ModelSerializer): # 額外字段聲明,必須在fields裏面也要聲明上去,不然序列化器不會調用 # password2 = serializers.CharField(write_only=True,required=True) # 若是模型類序列化器,必須聲明本次調用是哪一個模型,模型裏面的哪些字段 class Meta: model = Student # fields = ["id","name","age","description","sex","password2"] fields = ["id","name","age","description","sex"] # fields = "__all__" # 表示操做模型中的全部字段 # 添加額外的驗證選項,好比額外的字段驗證 extra_kwargs = { "sex":{"write_only":True,}, "id":{"read_only":True,} } # 驗證代碼 # 也能夠從新聲明一個create和update
簡單作個示例
class StudentViewSet(View): def post(self,request): data = request.POST serializers = StudentsSerializer(data=data) status = serializers.is_valid() # print(status) # print(serializers.validated_data) student = serializers.save() #上面使用的ModelSerializer,因此不須要咱們本身寫create方法了 print(student) return JsonResponse({'msg':'henhao'})
上面只演示了添加操做,更新操做自行測試吧
何時繼承序列化器類Serializer,何時繼承模型序列化器類ModelSerializer?主要仍是看哪一個更適合你的應用場景
繼承序列化器類Serializer 字段聲明 驗證 添加/保存數據功能 繼承模型序列化器類ModelSerializer 字段聲明[可選,看須要] Meta聲明 驗證 添加/保存數據功能[可選]
看錶字段大小,看使用哪一個更加節省代碼了。