Serializer序列化器
定義Serializer
1. 定義方法
Django REST framework中的Serializer使用類來定義，須繼承自rest_framework.serializers.Serializer。
例如，我們已有了一個數據庫模型類BookInfo
class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名稱') bpub_date = models.DateField(verbose_name='發布日期', null=True) bread = models.IntegerField(default=0, verbose_name='閱讀量') bcomment = models.IntegerField(default=0, verbose_name='評論量') image = models.ImageField(upload_to='booktest', verbose_name='圖片', null=True)
我們想為這個模型類提供一個序列化器，可以定義如下：
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名稱', max_length=20) bpub_date = serializers.DateField(label='發布日期', required=False) bread = serializers.IntegerField(label='閱讀量', required=False) bcomment = serializers.IntegerField(label='評論量', required=False) image = serializers.ImageField(label='圖片', required=False)
注意：serializer不是只能為數據庫模型類定義，也可以為非數據庫模型類的數據定義。serializer是獨立于數據庫之外的存在。
2. 字段與選項
常用字段類型：
| 字段 | 字段構造方式 |
|---|---|
| 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頁面時，顯示的字段幫助提示信息 |
3. 創建Serializer對象
定義好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屬性獲取。
序列化使用
我們在django shell中來學習序列化器的使用。
python manage.py shell
1 基本使用
1） 先查詢出一個圖書對象
from booktest.models import BookInfobook = BookInfo.objects.get(id=2)
2） 構造序列化器對象
from booktest.serializers import BookInfoSerializerserializer = BookInfoSerializer(book)
3）獲取序列化數據
通過data屬性可以獲取序列化后的數據
serializer.data# {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}4）如果要被序列化的是包含多條數據的查詢集QuerySet，可以通過添加many=True參數補充說明
book_qs = BookInfo.objects.all()serializer = BookInfoSerializer(book_qs, many=True)serializer.data# [OrderedDict([('id', 2), ('btitle', '天龍八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飛狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游記'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]2 關聯對象嵌套序列化
如果需要序列化的數據中包含有其他關聯對象，則對關聯對象數據的序列化需要指明。
例如，在定義英雄數據的序列化器時，外鍵hbook（即所屬的圖書）字段如何序列化？
我們先定義HeroInfoSerialzier除外鍵字段外的其他部分
class HeroInfoSerializer(serializers.Serializer): """英雄數據序列化器""" GENDER_CHOICES = ( (0, 'male'), (1, 'female') ) id = serializers.IntegerField(label='ID', read_only=True) hname = serializers.CharField(label='名字', max_length=20) hgender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性別', required=False) hcomment = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)
對于關聯字段，可以采用以下幾種方式：
1） PrimaryKeyRelatedField
此字段將被序列化為關聯對象的主鍵。
hbook = serializers.PrimaryKeyRelatedField(label='圖書', read_only=True)或hbook = serializers.PrimaryKeyRelatedField(label='圖書', queryset=BookInfo.objects.all())
指明字段時需要包含read_only=True或者queryset參數：
使用效果：
from booktest.serializers import HeroInfoSerializerfrom booktest.models import HeroInfohero = HeroInfo.objects.get(id=6)serializer = HeroInfoSerializer(hero)serializer.data# {'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 2}2) StringRelatedField
此字段將被序列化為關聯對象的字符串表示方式（即__str__方法的返回值）
hbook = serializers.StringRelatedField(label='圖書')
使用效果
{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': '天龍八部'}
3）HyperlinkedRelatedField
此字段將被序列化為獲取關聯對象數據的接口鏈接
hbook = serializers.HyperlinkedRelatedField(label='圖書', read_only=True, view_name='books-detail')
必須指明view_name參數，以便DRF根據視圖名稱尋找路由，進而拼接成完整URL。
使用效果
{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 'http://127.0.0.1:8000/books/2/'}
我們暫時還沒有定義視圖，此方式不再演示。
4）SlugRelatedField
此字段將被序列化為關聯對象的指定字段數據
hbook = serializers.SlugRelatedField(label='圖書', read_only=True, slug_field='bpub_date')
slug_field指明使用關聯對象的哪個字段
使用效果
{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': datetime.date(1986, 7, 24)}
5）使用關聯對象的序列化器
hbook = BookInfoSerializer()
使用效果
{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': OrderedDict([('id', 2), ('btitle', '天龍八部')te', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', None)])}
6） 重寫to_representation方法
序列化器的每個字段實際都是由該字段類型的to_representation方法決定格式的，可以通過重寫該方法來決定格式。
注意，to_representations方法不僅局限在控制關聯對象格式上，適用于各個序列化器字段類型。
自定義一個新的關聯字段：
class BookRelateField(serializers.RelatedField): """自定義用于處理圖書的字段""" def to_representation(self, value): return 'Book: %d %s' % (value.id, value.btitle)
指明hbook為BookRelateField類型
hbook = BookRelateField(read_only=True)
使用效果
{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 'Book: 2 天龍八部'}
many參數
如果關聯的對象數據不是只有一個，而是包含多個數據，如想序列化圖書BookInfo數據，每個BookInfo對象關聯的英雄HeroInfo對象可能有多個，此時關聯字段類型的指明仍可使用上述幾種方式，只是在聲明關聯字段時，多補充一個many=True參數即可。
此處僅拿PrimaryKeyRelatedField類型來舉例，其他相同。
在BookInfoSerializer中添加關聯字段：
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名稱', max_length=20) bpub_date = serializers.DateField(label='發布日期', required=False) bread = serializers.IntegerField(label='閱讀量', required=False) bcomment = serializers.IntegerField(label='評論量', required=False) image = serializers.ImageField(label='圖片', required=False) heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True) # 新增
使用效果：
from booktest.serializers import BookInfoSerializerfrom booktest.models import BookInfobook = BookInfo.objects.get(id=2)serializer = BookInfoSerializer(book)serializer.data# {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': Non以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持VEVB武林網。
新聞熱點
疑難解答
