引言
serializers是什么？
官網是這樣的”Serializers allow complex data such as querysets and model instances to be converted to native Python datatypes that can then be easily rendered into JSON, XML or other content types. “翻譯出來就是，將復雜的資料結構變成json或者xml這個格式的，- 將queryset與model實體等進行序列化，轉化成json格式，回傳給用戶(api介面)，
- 將post與patch/put的上來的資料進行驗證，
- 對post與patch/put資料進行處理，
1. 常用的field
CharField、BooleanField、IntegerField、DateTimeField這幾個用得比較多，我們把外鍵的field放到后面去說！ 例如：- mobile = serializers.CharField(max_length=11, min_length=11)
- age = serializers.IntegerField(min_value=https://www.cnblogs.com/jiangxiaolong-1996/p/1, max_value=100)
- pay_time = serializers.DateTimeField(read_only=True,format='%Y-%m-%d %H:%M')
- is_hot = serializers.BooleanField()
- HiddenField
HiddenField的值不依靠輸入，而需要設定默認的值，不需要用戶自己post資料過來，也不會顯式回傳給用戶，最常用的就是user!!
我們在登錄情況下，進行一些操作，假設一個用戶去收藏了某一門課，那么后臺應該自動識別這個用戶，然后用戶只需要將課程的id post過來，那么這樣的功能，我們配合CurrentUserDefault()實作，# 這樣就可以直接獲取到當前用戶 user = serializers.HiddenField(default=serializers.CurrentUserDefault()不同的是，我們在django中，form更強調對提交的表單進行一種驗證，而serializer的field不僅在進行資料驗證時起著至關重要的作用，在將資料進行序列化后回傳也發揮著重要作用！！
2. Core arguments引數
read_only：True表示不允許用戶自己上傳，只能用于api的輸出，如果某個欄位設定了read_only=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'})這里面，還有一個十分有用的validators引數，這個我們會在后面提及！
save instance
我們在view以及mixins的博客中提及到，post請求對應create方法，而patch請求對應update方法，這里提到的create方法與update方法，是指mixins中特定類中的方法# 只截取一部分 class CreateModelMixin(object): def create(self, request, *args, **kwargs): serializer = self.get_serializer(data=https://www.cnblogs.com/jiangxiaolong-1996/p/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=https://www.cnblogs.com/jiangxiaolong-1996/p/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(view視圖中是self.request.user) #super().create(**validated_data) 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 #super().update(instance, validated_data) 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=https://www.cnblogs.com/jiangxiaolong-1996/p/request.data) # UpdateModelMixin instance = self.get_object() serializer = self.get_serializer(instance, data=https://www.cnblogs.com/jiangxiaolong-1996/p/request.data, partial=partial)
也就是說，在update通過get_object( )的方法獲取到了instance，然后傳遞給serializer，serializer再根據是否有傳遞instance來判斷來呼叫哪個方法！
validate方法
常用驗證方式：如果是兩個欄位聯合在一起進行驗證，那么我們就可以多載validate( )方法start = serializers.DateTimeField() finish = serializers.DateTimeField() def validate(self, attrs): #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掉！ 如在用戶注冊時，我們需要填寫驗證碼，這個驗證碼只需要驗證，不需要保存到用戶這個Model中：
def validate(self, attrs): del attrs["code"] return attrs除了validate驗證欄位集合，也能通過validate_field來驗證欄位，這里不做說明，建議使用上方的validate方法
ModelSerializer
講了很多Serializer的，在這個時候，我還是強烈建議使用ModelSerializer，因為在大多數情況下，我們都是基于model欄位去開發， 好處： ModelSerializer已經多載了create與update方法，它能夠滿足將post或patch上來的資料進行進行直接地創建與更新，除非有額外需求，那么就可以多載create與update方法， ModelSerializer在Meta中設定fields欄位，系統會自動進行映射，省去每個欄位再寫一個fieldclass UserDetailSerializer(serializers.ModelSerializer): """ 用戶詳情序列化 """ class Meta: model = User fields = ("name", "gender", "birthday", "email", "mobile") #選擇欄位 # fields = '__all__': 表示所有欄位 # exclude = ('add_time',): 除去指定的某些欄位 # 這三種方式，存在一個即可
自定義顯示欄位
某個欄位不屬于指定model，它是read_only，只需要將它序列化傳遞給用戶，但是在這個model中，沒有這個欄位！我們需要用到SerializerMethodField，自定義顯示欄位class UserSerializer(serializers.ModelSerializer): #自定義顯示欄位 days_since_joined = serializers.SerializerMethodField() # 方法寫法：get_ + 欄位 def get_days_since_joined(self, obj): # obj指這個model的物件，既user物件 return (now() - obj.date_joined).days class Meta: model = User當然，這個的SerializerMethodField用法還相對簡單一點，后面還會有比較復雜的情況
serializers外鍵
其實，外鍵的field也比較簡單，如果我們直接使用serializers.Serializer，那么直接用PrimaryKeyRelatedField就解決了， 假設現在有一門課python入門教學(course)，它的類別是python(catogory)，#model class CourseCategory(model.Model): name = model.CharField(max_length=255) class Course(model.Model): name = model.CharField(max_length=255) category = models.ForeignKey(CourseCategory,on_delete=models.CASCADE,related_name='courses')
ModelSerializer就更簡單了，直接通過映射就好了 不過這樣只是用戶獲得的只是一個外鍵類別的id，并不能獲取到詳細的資訊，如果想要獲取到具體資訊，那需要嵌套serializer
# 指定queryset category = serializers.PrimaryKeyRelatedField(queryset=CourseCategory.objects.all(), required=True)
class CourseCategorySerializers(serializers.ModelSerializer): courses = CourseSerializers(many=True) #反向取值 #2 class Meta: model = CourseCategory fileds = "__all__" class CourseSerializers(serializers.ModelSerializer): category = CourseCategorySerializer() #正向取值 #1 class Meta: model = Course fileds = "__all__"
正向取值：課程取分類
#1處 category = CourseCategorySerializer() #正向取值
分類反向取課程，通過related_name
#2處 在課程course的model中，需要在外鍵中設定related_name 一對多，一個類別下有多個課程，一定要設定many=True
courses = CourseSerializer(many=True)
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/150260.html
標籤：Python
上一篇：LeetCode 45. 跳躍游戲 II | Python
下一篇：python裝飾器原理和用法總結