Rest_Framework

1. Web應用模式

在開發Web應用中，有兩種應用模式：

1. 前后端不分離

2)前后端分離

2. api接口

為了在團隊內部形成共識、防止個人習慣差異引起的混亂，我們需要找到一種大家都覺得很好的接口實現規范，而且這種規范能夠讓后端寫的接口，用途一目了然，減少雙方之間的合作成本。

目前市面上大部分公司開發人員使用的接口服務架構主要有：restful、rpc。

rpc: 翻譯成中文:遠程過程調用[遠程服務調用],通過視圖函數的函數名進行調用.

接口多了,對應函數名和參數就多了,前端在請求api接口時,就會比較難找.容易出現重復的接口

restful: 翻譯成中文: 資源狀態轉換.

把后端所有的數據/文件都看成資源.

那么接口請求數據,本質上來說就是對資源的操作了.

web項目中操作資源,無非就是增刪查改.所以要求在地址欄中聲明要操作的資源是什么,然后通過http請求動詞來說明對資源進行哪一種操作.

POST http://www.xxx.com/api/students/ 添加學生數據

GET http://www.xxx.com/api/students/ 獲取所有學生數據

GET http://www.xxx.com/api/students/ 獲取一個學生

DELETE http://www.xxx.com/api/students/ 刪除1個學生

3. RESTful API規范

REST全稱是Representational State Transfer，中文意思是表述（編者注：通常譯為表征）性狀態轉移。 它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API接口的設計風格，尤其適用於前后端分離的應用模式中。

這種風格的理念認為后端開發任務就是提供數據的，對外提供的是數據資源的訪問接口，所以在定義接口時，客戶端訪問的URL路徑就表示這種要操作的數據資源。

而對於數據資源分別使用POST、DELETE、GET、UPDATE等請求動作來表達對數據的增刪查改。

請求方法	請求地址	后端操作
GET	/students	獲取所有學生數據
POST	/students	添加學生
GET	/students/	獲取編號為pk的學生數據
PUT	/students/	修改編號為pk的學生數據
DELETE	/students/	刪除編號為pk的學生數據

事實上，我們可以使用任何一個框架都可以實現符合restful規范的API接口。

參考文檔：http://www.runoob.com/w3cnote/restful-architecture.html

4. 序列化

api接口開發，最核心最常見的一個過程就是序列化，所謂序列化就是把數據轉換格式，序列化可以分兩個階段：

序列化： 把我們識別的數據轉換成指定的格式提供給別人。

例如：我們在django的ORM中獲取到的數據默認是模型對象，但是模型對象數據無法直接提供給前端或別的平台使用，所以我們需要把數據進行序列化，變成字符串或者json數據，提供給別人。

反序列化：把別人提供的數據轉換/還原成我們需要的格式。

例如：前端js提供過來的json數據，對於python而言就是字符串，我們需要進行反序列化換成模型類對象，這樣我們才能把數據保存到數據庫中。

1. 接收數據[反序列化]
2. 操作數據
3. 響應數據[序列化]

5. Django Rest_Framework

核心思想: 縮減編寫api接口的代碼

Django REST framework是一個建立在Django基礎之上的Web 應用開發框架，可以快速的開發REST API接口應用。在REST framework中，提供了序列化器Serializer的定義，可以幫助我們簡化序列化與反序列化的過程，不僅如此，還提供豐富的類視圖、擴展類、視圖集來簡化視圖的編寫工作。REST framework還提供了認證、權限、限流、過濾、分頁、接口文檔等功能支持。REST framework提供了一個API 的Web可視化界面來方便查看測試接口。

中文文檔：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework

github: https://github.com/encode/django-rest-framework/tree/master

特點

• 提供了定義序列化器Serializer的方法，可以快速根據 Django ORM 或者其它庫自動序列化/反序列化；
• 提供了豐富的類視圖、Mixin擴展類，簡化視圖的編寫；
• 豐富的定制層級：函數視圖、類視圖、視圖集合到自動生成 API，滿足各種需要；
• 多種身份認證和權限認證方式的支持；
• 內置了限流系統；
• 直觀的 API web 界面；
• 可擴展性，插件豐富

6. 環境安裝與配置

DRF需要以下依賴：

• Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
• Django (1.10, 1.11, 2.0)

DRF是以Django擴展應用的方式提供的，所以我們可以直接利用已有的Django環境而無需從新創建。（若沒有Django環境，需要先創建環境安裝Django）

6.1 安裝DRF

前提是已經安裝了django，建議安裝在虛擬環境

# mkvirtualenv drfdemo -p python3
# pip install django

pip install djangorestframework
pip install pymysql
# 激活或切換虛擬環境
workon   虛擬環境名字

linux的粘貼命令: shift+insert

6.1.1 創建django項目

cd ~/Desktop
django-admin startproject drfdemo

使用pycharm打開項目，設置虛擬環境的解析器，並修改manage.py中的后綴參數。

6.2 添加rest_framework應用

在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

接下來就可以使用DRF提供的功能進行api接口開發了。在項目中如果使用rest_framework框架實現API接口，主要有以下三個步驟：

• 將請求的數據（如JSON格式）轉換為模型類對象
• 操作數據庫
• 將模型類對象轉換為響應的數據（如JSON格式）

6.3 體驗drf完全簡寫代碼的過程

6.3.1. 創建模型操作類

class Student(models.Model):
    # 模型字段
    name = models.CharField(max_length=100,verbose_name="姓名")
    sex = models.BooleanField(default=1,verbose_name="性別")
    age = models.IntegerField(verbose_name="年齡")
    class_null = models.CharField(max_length=5,verbose_name="班級編號")
    description = models.TextField(max_length=1000,verbose_name="個性簽名")

    class Meta:
        db_table="tb_student"
        verbose_name = "學生"
        verbose_name_plural = verbose_name

為了方便測試，所以我們可以先創建一個數據庫。

create database students charset=utf8;

6.3.1.1 執行數據遷移

例如，在django項目中創建學生子應用。

python manage.py startapp students

把students子應用添加到INSTALLED_APPS中

初始化數據庫連接

# 安裝pymysql
pip install pymysql

主引用中__init__.py設置使用pymysql作為數據庫驅動

import pymysql

pymysql.install_as_MySQLdb()

settings.py配置文件中設置mysql的賬號密碼

DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    }
}

終端下，執行數據遷移。

python manage.py makemigrations
python manage.py migrate

可能的報錯信息

# 執行數據遷移 python manage.py makemigrations 報錯如下：

解決方案：

注釋掉 backends/mysql/base.py中的35和36行代碼。

# 執行數據遷移發生以下錯誤：

解決方法：

backends/mysql/operations.py146行里面新增一個行代碼：

6.3.2. 創建序列化器

在students應用目錄中新建serializers.py用於保存該應用的序列化器。

創建一個StudentModelSerializer用於序列化與反序列化。

# 創建序列化器類，回頭會在試圖中被調用
from rest_framework import serializers
from .models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

• model 指明該序列化器處理的數據字段從模型類Student參考生成
• fields 指明該序列化器包含模型類中的哪些字段，__all__指明包含所有字段

6.3.3. 編寫視圖

在students應用的views.py中創建視圖StudentViewSet，這是一個視圖集合。

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

• queryset 指明該視圖集在查詢數據時使用的查詢集
• serializer_class 指明該視圖在進行序列化或反序列化時使用的序列化器

6.3.4. 定義路由

在students應用的urls.py中定義路由信息。

from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

router = DefaultRouter()  # 可以處理視圖的路由器
router.register('students', views.StudentViewSet)  # 向路由器中注冊視圖集

urlpatterns += router.urls  # 將路由器中的所有路由信息追到到django的路由列表中

最后把students子應用中的路由文件加載到總路由文件中.

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("stu/",include("students.urls")),
]

6.3.5. 運行測試

運行當前程序（與運行Django一樣）

python manage.py runserver

在瀏覽器中輸入網址127.0.0.1:8000，可以看到DRF提供的API Web瀏覽頁面：

1）點擊鏈接127.0.0.1:8000/stu/students 可以訪問獲取所有數據的接口，呈現如下頁面：

2）在頁面底下表單部分填寫學生信息，可以訪問添加新學生的接口，保存學生信息：

點擊POST后，返回如下頁面信息：

3）在瀏覽器中輸入網址127.0.0.1:8000/stu/students/5/，可以訪問獲取單一學生信息的接口（id為5的學生），呈現如下頁面：

4）在頁面底部表單中填寫學生信息，可以訪問修改學生的接口：

點擊PUT，返回如下頁面信息：

5）點擊DELETE按鈕，可以訪問刪除學生的接口：

返回，如下頁面：

7. 序列化器-Serializer

作用：

1. 序列化,序列化器會把模型對象轉換成字典,經過response以后變成json字符串
2. 反序列化,把客戶端發送過來的數據,經過request以后變成字典,序列化器可以把字典轉成模型
3. 反序列化,完成數據校驗功能

7.1 定義序列化器

Django REST framework中的Serializer使用類來定義，須繼承自rest_framework.serializers.Serializer。

接下來，為了方便演示序列化器的使用，我們先創建一個新的子應用sers

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

我們想為這個模型類提供一個序列化器，可以定義如下：

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是獨立於數據庫之外的存在。

常用字段類型：

字段	字段構造方式 serializers.字段構造方式()
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_length	最小長度
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頁面時，顯示的字段幫助提示信息

7.2 創建Serializer對象

定義好Serializer類后，就可以創建Serializer對象了。

Serializer的構造方法為：

Serializer(instance=None, data=empty, **kwarg)

說明：

1）用於序列化時，將模型類對象傳入instance參數

2）用於反序列化時，將要被反序列化的數據傳入data參數

3）除了instance和data參數外，在構造Serializer對象時，還可通過context參數額外添加數據，如

serializer = StudentSerializer(instance, context={'request': request})

通過context參數附加的數據，可以通過Serializer對象的context屬性獲取。

1. 使用序列化器的時候一定要注意，序列化器聲明了以后，不會自動執行，需要我們在視圖中進行調用才可以。
2. 序列化器無法直接接收數據，需要我們在視圖中創建序列化器對象時把使用的數據傳遞過來。
3. 序列化器的字段聲明類似於form表單系統。
4. 開發restful api時，序列化器會幫我們把模型數據轉換成字典.
5. drf提供的視圖會幫我們把字典轉換成json,或者把客戶端發送過來的數據轉換字典.

7.3 序列化器的使用

序列化器的使用分兩個階段：

1. 在客戶端請求時，使用序列化器可以完成對數據的反序列化。
2. 在服務器響應時，使用序列化器可以完成對數據的序列化。

7.3.1 序列化

7.3.1.1 基本使用

1） 先查詢出一個學生對象

from students.models import Student

student = Student.objects.get(id=3)

2） 構造序列化器對象

from .serializers import StudentSerializer

serializer = StudentSerializer(instance=student)

3）獲取序列化數據

通過data屬性可以獲取序列化后的數據

serializer.data
# {'id': 4, 'name': '小張', 'age': 18, 'sex': True, 'description': '猴賽雷'}

完整視圖代碼：

from django.views import View
from students.models import Student
from .serializers import StudentSerializer
from django.http.response import JsonResponse
class StudentRetrieveView(View):
    """使用序列化器序列化轉換單個模型數據"""
    def get(self,request,pk):
        # 獲取數據
        student = Student.objects.get(pk=pk)
        # 數據轉換[序列化過程]
        serializer = StudentSerializer(instance=student)
        print(serializer.data)
        # 響應數據
        return JsonResponse(serializer.data)

4）如果要被序列化的是包含多條數據的查詢集QuerySet，可以通過添加many=True參數補充說明

class StudentView(View):    
    """使用序列化器序列化轉換多個模型數據"""
    def get(self,request):
        # 獲取數據
        student_list = Student.objects.all()

        # 轉換數據[序列化過程]
        # 如果轉換多個模型對象數據，則需要加上many=True
        serializer = StudentSerializer(instance=student_list,many=True)
        print( serializer.data ) # 序列化器轉換后的數據

        # 響應數據給客戶端
        # 返回的json數據，如果是列表，則需要聲明safe=False
        return JsonResponse(serializer.data,safe=False)
    
    
    # 訪問結果：
    # [OrderedDict([('id', 1), ('name', 'xiaoming'), ('age', 20), ('sex', True), ('description', '測試')]), OrderedDict([('id', 2), ('name', 'xiaohui'), ('age', 22), ('sex', True), ('description', '后面來的測試')]), OrderedDict([('id', 4), ('name', '小張'), ('age', 18), ('sex', True), ('description', '猴賽雷')])]

7.3.2 反序列化

7.3.2.1 數據驗證

使用序列化器進行反序列化時，需要對數據進行驗證后，才能獲取驗證成功的數據或保存成模型類對象。

在獲取反序列化的數據前，必須調用is_valid()方法進行驗證，驗證成功返回True，否則返回False。

驗證失敗，可以通過序列化器對象的errors屬性獲取錯誤信息，返回字典，包含了字段和字段的錯誤。如果是非字段錯誤，可以通過修改REST framework配置中的NON_FIELD_ERRORS_KEY來控制錯誤字典中的鍵名。

驗證成功，可以通過序列化器對象的validated_data屬性獲取數據。

在定義序列化器時，指明每個字段的序列化類型和選項參數，本身就是一種驗證行為。

新建一個子應用books。

python manage.py startapp books

在settings.py中的INSTALLED_APPS中新增books子應用

INSTALLED_APPS = [
	# ...
    'ser',
    'unser',
]

如我們定義一個圖書的模型和序列化器，

Book模型，代碼：

from django.db import models
class Book(models.Model):
    """圖書模型"""
    title = models.CharField(verbose_name='名稱', max_length=20)
    pub_date = models.DateField(verbose_name='發布日期')
    read = models.IntegerField(verbose_name='閱讀量',default=0)
    comment = models.IntegerField(verbose_name='評論量', null=True, blank=True)

    class Meta:
        db_table = "tb_book"
        verbose_name="圖書"
        verbose_name_plural=verbose_name

    def __str__(self):
        return self.title

執行數據遷移，代碼：

python manage.py makemigrations
python manage.py migrate

BookSerializer序列化器，代碼：

class BookSerializer(serializers.Serializer):
    """圖書數據序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    title = serializers.CharField(label='名稱', max_length=20)
    pub_date = serializers.DateField(label='發布日期', required=False)
    read = serializers.IntegerField(label='閱讀量', required=False)
    comment = serializers.IntegerField(label='評論量', required=False)

通過構造序列化器對象，並將要反序列化的數據傳遞給data構造參數，進而進行驗證

from book.serializers import BookSerializer
data = {'pub_date': 123}
serializer = BookSerializer(data=data)
serializer.is_valid()  # 返回False
serializer.errors
# {'title': [ErrorDetail(string='This field is required.', code='required')], 'pub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data  # {}

data = {'title': 'python'}
serializer = BookSerializer(data=data)
serializer.is_valid()  # True   驗證結果返回值
serializer.errors  # {}  錯誤信息
serializer.validated_data  #  OrderedDict([('btitle', 'python')])

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)

如果覺得這些還不夠，需要再補充定義驗證行為，可以使用以下三種方法：

1) validate_字段名

對<field_name>字段進行驗證，如

class BookSerializer(serializers.Serializer):
    """圖書數據序列化器"""
    ...

    def validate_title(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("圖書不是關於Django的")
        return value

測試

from book.serializers import BookSerializer
data = {'title': 'python'}
serializer = BookSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'title': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}

2) validate

在序列化器中需要同時對多個字段進行比較驗證時，可以定義validate方法來驗證，如

class BookSerializer(serializers.Serializer):
    """圖書序列化器"""
    ...

    def validate(self, attrs):
        read = attrs['read']
        comment = attrs['comment']
        if read < comment:
            raise serializers.ValidationError('閱讀量小於評論量，不可以通過')
        return attrs

測試

from book.serializers import BookSerializer
data = {'title': 'about django', 'read': 10, 'comment': 20}
s = BookSerializer(data=data)
s.is_valid()  # False
s.errors
#  {'non_field_errors': [ErrorDetail(string='閱讀量小於評論量', code='invalid')]}

3) validators

在字段中添加validators選項參數，也可以補充驗證行為，如

def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("圖書不是關於Django的")

class BookSerializer(serializers.Serializer):
    """圖書序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    title = serializers.CharField(label='名稱', max_length=20, validators=[about_django])
    pub_date = serializers.DateField(label='發布日期', required=False)
    read = serializers.IntegerField(label='閱讀量', required=False)
    comment = serializers.IntegerField(label='評論量', required=False)

測試：

from book.serializers import BookSerializer
data = {'title': 'python'}
serializer = BookSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'title': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}

7.3.2.2 反序列化-保存數據

前面的驗證數據成功后,我們可以使用序列化器來完成數據反序列化的過程.這個過程可以把數據轉成模型類對象.

可以通過實現create()和update()兩個方法來實現。

class BookSerializer(serializers.Serializer):
    """圖書數據序列化器"""
    ...

    def create(self, validated_data):
        """新建"""
        return Book(**validated_data)

    def update(self, instance, validated_data):
        """更新，instance為要更新的對象實例"""
        instance.title = validated_data.get('title', instance.title)
        instance.pub_date = validated_data.get('pub_date', instance.pub_date)
        instance.read = validated_data.get('read', instance.read)
        instance.comment = validated_data.get('comment', instance.comment)
        instance.save()
        return instance

如果需要在返回數據對象的時候，也將數據保存到數據庫中，則可以進行如下修改

class BookSerializer(serializers.Serializer):
    """圖書數據序列化器"""
    ...

    def create(self, validated_data):
        """新建"""
        return Book.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """更新，instance為要更新的對象實例"""
        instance.title = validated_data.get('title', instance.title)
        instance.pub_date = validated_data.get('pub_date', instance.pub_date)
        instance.read = validated_data.get('read', instance.read)
        instance.comment = validated_data.get('comment', instance.comment)
        instance.save()
        return instance

實現了上述兩個方法后，在反序列化數據的時候，就可以通過save()方法返回一個數據對象實例了

book = serializer.save()

如果創建序列化器對象的時候，沒有傳遞instance實例，則調用save()方法的時候，create()被調用，相反，如果傳遞了instance實例，則調用save()方法的時候，update()被調用。

from .serializers import BookSerializer
data = {'title': 'python入門指南'}
serializer = BookSerializer(data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: python入門指南>

from .models import Book
book = Book.objects.get(id=2)
data = {'title': 'django入門指南'}
serializer = BookSerializer(book, data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: django入門指南>
book.title  # 'django入門指南'

7.3.2.3 附加說明

1） 在對序列化器進行save()保存時，可以額外傳遞數據，這些數據可以在create()和update()中的validated_data參數獲取到

# request.user 是django中記錄當前登錄用戶的模型對象
serializer.save(自定義字段名=request.user)

2）默認序列化器必須傳遞所有required的字段，否則會拋出驗證異常。但是我們可以使用partial參數來允許部分字段更新

# Update `comment` with partial data
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)

7.3.3 模型類序列化器

如果我們想要使用序列化器對應的是Django的模型類，DRF為我們提供了ModelSerializer模型類序列化器來幫助我們快速創建一個Serializer類。

ModelSerializer與常規的Serializer相同，但提供了：

• 基於模型類自動生成一系列字段
• 基於模型類自動為Serializer生成validators，比如unique_together
• 包含默認的create()和update()的實現

7.3.3.1 定義

比如我們創建一個BookSerializer

class BookSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = Book
        fields = '__all__'

• model 指明參照哪個模型類
• fields 指明為模型類的哪些字段生成

我們可以在python manage.py shell中查看自動生成的BookSerializer的具體實現

>>> from booktest.serializers import BookSerializer
>>> serializer = BookSerializer()
>>> serializer
BookSerializer():
    id = IntegerField(label='ID', read_only=True)
    title = CharField(label='名稱', max_length=20)
    pub_date = DateField(allow_null=True, label='發布日期', required=False)
    read = IntegerField(label='閱讀量', max_value=2147483647, min_value=-2147483648, required=False)
    comment = IntegerField(label='評論量', max_value=2147483647, min_value=-2147483648, required=False)

7.3.3.2 指定字段

1. 使用fields來明確字段，__all__表名包含所有字段，也可以寫明具體哪些字段，如

class BookSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = Book
        fields = "__all__"

2. 使用exclude可以明確排除掉哪些字段

class BookSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = Book
        exclude = ('pub_date',)

3. 顯示指明字段，如：

class BookSerializer(serializers.ModelSerializer):
    
    class Meta:
        model = Book
        fields = ('id', 'title', 'comment', 'read')

4. 指明只讀字段

可以通過read_only_fields指明只讀字段，即僅用於序列化輸出的字段

class BookSerializer(serializers.ModelSerializer):
    """圖書序列化器"""
    class Meta:
        model = Book
        fields = ('id', 'title', 'pub_date'， 'read', 'comment')
        read_only_fields = ('id', 'read', 'comment')

7.3.3.3 添加額外參數

我們可以使用extra_kwargs參數為ModelSerializer添加或修改原有的選項參數

class BookSerializer(serializers.ModelSerializer):
    """圖書序列化器"""
    class Meta:
        model = Book
        fields = ('id', 'title', 'pub_date', 'read', 'comment')
        extra_kwargs = {
            'read': {'min_value': 0, 'required': True},
            'comment': {'min_value': 0, 'required': True},
        }

# 查看序列化器的構造
# BookSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    title = CharField(label='名稱', max_length=20)
#    pub_date = DateField(allow_null=True, label='發布日期', required=False)
#    read = IntegerField(label='閱讀量', max_value=2147483647, min_value=0, required=True)
#    comment = IntegerField(label='評論量', max_value=2147483647, min_value=0, required=True)