Django_Restful_Framework

冀未然發表於2024-03-26

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"
PAddressField 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__'
  1. model 指明參照哪個模型類
  2. 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.3使用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)