serializers是將復雜的數據結構變成json或者xml這個格式的
serializers有以下幾個作用:
- 將queryset與model實例等進行序列化,轉化成json格式,返回給用戶(api接口)。
- 將post與patch/put的上來的數據進行驗證。
- 對post與patch/put數據進行處理。
實現序列化二個類:Serializer與ModelSerializer 比較
一、serializers.fieild
我們知道在django中,form也有許多field,那serializers其實也是drf中發揮着這樣的功能。我們先簡單了解常用的幾個field。
1. 常用的field
CharField、BooleanField、IntegerField、DateTimeField這幾個用得比較多
# 舉例子 mobile = serializers.CharField(max_length=11, min_length=11) age = serializers.IntegerField(min_value=1, max_value=100) # format可以設置時間的格式,下面例子會輸出如:2018-1-24 12:10 pay_time = serializers.DateTimeField(read_only=True,format='%Y-%m-%d %H:%M') is_hot = serializers.BooleanField()
serializer的field不僅在進行數據驗證時起着至關重要的作用,在將數據進行序列化后返回也發揮着重要作用
2. Core arguments參數
read_only:True表示不允許用戶自己上傳,只能用於api的輸出。如果某個字段設置了read_only=True,那么就不需要進行數據驗證,只會在返回時,將這個字段序列化后返回
舉個簡單的例子:在用戶進行購物的時候,用戶post訂單時,肯定會產生一個訂單號,而這個訂單號應該由后台邏輯完成,而不應該由用戶post過來,如果不設置read_only=True,那么驗證的時候就會報錯。
order_sn = serializers.CharField(readonly=True)write_only : 與read_only對應
required: 顧名思義,就是這個字段是否必填。
allow_null/allow_blank:是否允許為NULL/空 。
error_messages:出錯時,信息提示。
name = serializers.CharField(required=True, min_length=6,
error_messages={
'min_length': '名字不能小於6個字符',
'required': '請填寫名字'})
label: 字段顯示設置,如 label=’驗證碼’ help_text: 在指定字段增加一些提示文字,這兩個字段作用於api頁面比較有用
style: 說明字段的類型,這樣看可能比較抽象,看下面例子:
# 在api頁面,輸入密碼就會以*顯示
password = serializers.CharField(
style={'input_type': 'password'})
# 會顯示選項框
color_channel = serializers.ChoiceField(
choices=['red', 'green', 'blue'],
style={'base_template': 'radio.html'})
3. HiddenField
HiddenField的值不依靠輸入,而需要設置默認的值,不需要用戶自己post數據過來,也不會顯式返回給用戶,最常用的就是user!!
我們在登錄情況下,進行一些操作,假設一個用戶去收藏了某一門課,那么后台應該自動識別這個用戶,然后用戶只需要將課程的id post過來,那么這樣的功能,我們配合CurrentUserDefault()實現。
# 這樣就可以直接獲取到當前用戶
user = serializers.HiddenField(
default=serializers.CurrentUserDefault())
二、save instance
save instance這是為post和patch所設置的。
post請求對應create方法,而patch請求對應update方法,這里提到的create方法與update方法,是指mixins中特定類中的方法。我們看一下源代碼:# 只截取一部分
class CreateModelMixin(object):
def create(self, request, *args, **kwargs):
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
def perform_create(self, serializer):
serializer.save()
class UpdateModelMixin(object):
def update(self, request, *args, **kwargs):
partial = kwargs.pop('partial', False)
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
serializer.is_valid(raise_exception=True)
self.perform_update(serializer)
if getattr(instance, '_prefetched_objects_cache', None):
# If 'prefetch_related' has been applied to a queryset, we need to
# forcibly invalidate the prefetch cache on the instance.
instance._prefetched_objects_cache = {}
return Response(serializer.data)
def perform_update(self, serializer):
serializer.save()
可以看出,無論是create與update都寫了一行:serializer.save( ),那么,這一行,到底做了什么事情,分析一下源碼。# serializer.py
def save(self, **kwargs):
# 略去一些稍微無關的內容
···
if self.instance is not None:
self.instance = self.update(self.instance, validated_data)
···
else:
self.instance = self.create(validated_data)
···
return self.instance
顯然,serializer.save的操作,它去調用了serializer的create或update方法,不是mixins中的!!!我們看一下流程圖(以post為例)
講了那么多,我們到底需要干什么!重載這兩個方法!!
如果你的viewset含有post,那么你需要重載create方法,如果含有patch,那么就需要重載update方法。
# 假設現在是個博客,有一個創建文章,與修改文章的功能, model為Article。
class ArticleSerializer(serializers.Serializer):
user = serializers.HiddenField(
default=serializers.CurrentUserDefault())
name = serializers.CharField(max_length=20)
content = serializers.CharField()
def create(self, validated_data):
# 除了用戶,其他數據可以從validated_data這個字典中獲取
# 注意,users在這里是放在上下文中的request,而不是直接的request
user = self.context['request'].user
name = validated_data['name ']
content = validated_data['content ']
return Article.objects.create(**validated_data)
def update(self, instance, validated_data):
# 更新的特別之處在於你已經獲取到了這個對象instance
instance.name = validated_data.get('name')
instance.content = validated_data.get('content')
instance.save()
return instance
可能會有人好奇,系統是怎么知道,我們需要調用serializer的create方法,還是update方法,我們從save( )方法可以看出,判斷的依據是:
if self.instance is not None:pass那么我們的mixins的create與update也已經在為開發者設置好了
# CreateModelMixin serializer = self.get_serializer(data=request.data) # UpdateModelMixin serializer = self.get_serializer(instance, data=request.data, partial=partial)也就是說,在update通過get_object( )的方法獲取到了instance,然后傳遞給serializer,serializer再根據是否有傳遞instance來判斷來調用哪個方法!
三、Validation自定義驗證邏輯
1、單獨的validate
在上面提到field,它能起到一定的驗證作用,但很明顯,它存在很大的局限性,舉個簡單的例子,我們要判斷我們手機號碼,如果使用CharField(max_length=11, min_length=11),它只能確保我們輸入的是11個字符,那么我們需要自定義!
mobile_phone = serializers.CharField(max_length=11, min_length=11)
def validate_mobile_phone(self, mobile_phone):
# 注意參數,self以及字段名
# 注意函數名寫法,validate_ + 字段名字
if not re.match(REGEX_MOBILE, mobile):
# REGEX_MOBILE表示手機的正則表達式
raise serializers.ValidationError("手機號碼非法")
return mobile_phone
當然,這里面還可以加入很多邏輯,例如,還可以判斷手機是否原本就存在數據庫等等。
2、聯合validate
上面驗證方式,只能驗證一個字段,如果是兩個字段聯合在一起進行驗證,那么我們就可以重載validate( )方法。
start = serializers.DateTimeField()
finish = serializers.DateTimeField()
def validate(self, attrs):
# 傳進來什么參數,就返回什么參數,一般情況下用attrs
if data['start'] > data['finish']:
raise serializers.ValidationError("finish must occur after start")
return attrs
這個方法非常的有用,我們還可以再這里對一些read_only的字段進行操作,我們在read_only提及到一個例子,訂單號的生成,我們可以在這步生成一個訂單號,然后添加到attrs這個字典中。
order_sn = serializers.CharField(readonly=True)
def validate(self, attrs):
# 調用一個方法生成order_sn
attrs['order_sn'] = generate_order_sn()
return attrs
這個方法運用在modelserializer中,可以剔除掉write_only的字段,這個字段只驗證,但不存在與指定的model當中,即不能save( ),可以在這delete掉!
3、Validators
validators可以直接作用於某個字段,這個時候,它與單獨的validate作用差不多
def multiple_of_ten(value):
if value % 10 != 0:
raise serializers.ValidationError('Not a multiple of ten')
class GameRecord(serializers.Serializer):
score = IntegerField(validators=[multiple_of_ten])
當然,drf提供的validators還有很好的功能:UniqueValidator,UniqueTogetherValidator等
UniqueValidator: 指定某一個對象是唯一的,如,用戶名只能存在唯一:
username = serializers.CharField(
max_length=11,
min_length=11,
validators=[UniqueValidator(queryset=UserProfile.objects.all())
)
UniqueTogetherValidator: 聯合唯一,如用戶收藏某個課程,這個時候就不能單獨作用於某個字段,我們在Meta中設置。
class Meta:
validators = [
UniqueTogetherValidator(
queryset=UserFav.objects.all(),
fields=('user', 'course'),
message='已經收藏'
)]
四、ModelSerializer
講了很多Serializer的,在這個時候,我還是強烈建議使用ModelSerializer,因為在大多數情況下,我們都是基於model字段去開發。
好處:
ModelSerializer已經重載了create與update方法,它能夠滿足將post或patch上來的數據進行進行直接地創建與更新,除非有額外需求,那么就可以重載create與update方法。
ModelSerializer在Meta中設置fields字段,系統會自動進行映射,省去每個字段再寫一個field。
class UserDetailSerializer(serializers.ModelSerializer):
"""
用戶詳情序列化
"""
class Meta:
model = User
fields = ("name", "gender", "birthday", "email", "mobile")
# fields = '__all__': 表示所有字段
# exclude = ('add_time',): 除去指定的某些字段
# 這三種方式,存在一個即可
ModelSerializer需要解決的2個問題:
1,某個字段不屬於指定model,它是write_only,需要用戶傳進來,但我們不能對它進行save( ),因為ModelSerializer是基於Model,這個字段在Model中沒有對應,這個時候,我們需要重載validate!
如在用戶注冊時,我們需要填寫驗證碼,這個驗證碼只需要驗證,不需要保存到用戶這個Model中:
def validate(self, attrs):
del attrs["code"]
return attrs
2,某個字段不屬於指定model,它是read_only,只需要將它序列化傳遞給用戶,但是在這個model中,沒有這個字段!我們需要用到SerializerMethodField。 假設需要返回用戶加入這個網站多久了,不可能維持這樣加入的天數這樣一個數據,一般會記錄用戶加入的時間點,然后當用戶獲取這個數據,我們再計算返回給它。
class UserSerializer(serializers.ModelSerializer):
days_since_joined = serializers.SerializerMethodField()
# 方法寫法:get_ + 字段
def get_days_since_joined(self, obj):
# obj指這個model的對象
return (now() - obj.date_joined).days
class Meta:
model = User
這個的SerializerMethodField用法還相對簡單一點,后面還會有比較復雜的情況。
關於外鍵的serializers
講了那么多,終於要研究一下外鍵啦~
其實,外鍵的field也比較簡單,如果我們直接使用serializers.Serializer,那么直接用PrimaryKeyRelatedField就解決了。
假設現在有一門課python入門教學(course),它的類別是python(catogory)。
# 指定queryset category = serializers.PrimaryKeyRelatedField(queryset=CourseCategory.objects.all(), required=True)ModelSerializer就更簡單了,直接通過映射就好了
不過這樣只是用戶獲得的只是一個外鍵類別的id,並不能獲取到詳細的信息,如果想要獲取到具體信息,那需要嵌套serializer
category = CourseCategorySerializer()注意:上面兩種方式,外鍵都是正向取得,下面介紹怎么反向去取,如,我們需要獲取python這個類別下,有什么課程。
首先,在課程course的model中,需要在外鍵中設置related_name
class Course(model.Model):
category = models.ForeignKey(CourseCategory, related_name='courses')
# 反向取課程,通過related_name # 一對多,一個類別下有多個課程,一定要設定many=True courses = CourseSerializer(many=True)有一個小問題:我們在上面提到ModelSerializer需要解決的第二個問題中,其實還有一種情況,就是某個字段屬於指定model,但不能獲取到相關數據。
假設現在是一個多級分類的課程,例如,編程語言–>python–>python入門學習課程,編程語言與python屬於類別,另外一個屬於課程,編程語言類別是python類別的一個外鍵,而且屬於同一個model,實現方法:
parent_category = models.ForeignKey('self', null=True, blank=True,
verbose_name='父類目別',
related_name='sub_cat')
現在獲取編程語言下的課程,顯然無法直接獲取到python入門學習這個課程,因為它們兩沒有外鍵關系。SerializerMethodField( )也可以解決這個問題,只要在自定義的方法中實現相關的邏輯即可!
courses = SerializerMethodField()
def get_courses(self, obj):
all_courses = Course.objects.filter(category__parent_category_id=obj.id)
courses_serializer = CourseSerializer(all_course, many=True,
context={'request': self.context['request']})
return courses_serializer.data
上面的例子看起來有點奇怪,因為我們在SerializerMethodField()嵌套了serializer,就需要自己進行序列化,然后再從data就可以取出json數據。 可以看到傳遞的參數是分別是:queryset,many=True多個對象,context上下文。這個context十分關鍵,如果不將request傳遞給它,在序列化的時候,圖片與文件這些Field不會再前面加上域名,也就是說,只會有/media/img…這樣的路徑!
加qq群:631575625 可交流咨詢python 項目開發實戰經驗
