Django-DRF組件學習-環境安裝與配置與序列化器學習

時間  2019-11-17
標籤 django drf 組件 學習 環境 安裝 配置 序列 欄目 Python 简体版
原文   原文鏈接

1.DRF環境安裝與配置

DRF須要如下依賴：前端

  • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)python

  • Django (1.10, 1.11, 2.0)mysql

DRF是以Django擴展應用的方式提供的，因此咱們能夠直接利用已有的Django環境而無需重新建立。（若沒有Django環境，須要先建立環境安裝Django）git

1.1 安裝DRF

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

#本次測試環境是在ubantu的18.0環境中
# mkvirtualenv drfdemo -p python3
# pip install django

pip install djangorestframework
pip install pymysql

1.1.1 建立django項目

cd ~/Desktop
django-admin startproject drfdemo
​1557022536078

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

1.2 添加rest_framework應用

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

INSTALLED_APPS = [
    ...
    'rest_framework',
]

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

  • 將請求的數據（如JSON格式）轉換爲模型類對象api

  • 操做數據庫瀏覽器

  • 將模型類對象轉換爲響應的數據（如JSON格式）

1.3 體驗DRF徹底簡寫代碼的過程（暫時不須要理解）

1.3.1 建立模型操做類

from django.db import models

# Create your models here.
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_number = models.CharField(max_length=5,verbose_name='班級簽名')
    description = models.TextField(max_length=1000,verbose_name='個性簽名')

    def __str__(self):
        return self.name

    class Meta:
        db_table="tb_student"
        # 一個是單數一個是複數
        verbose_name="學生"
        verbose_name_plural=verbose_name

爲了方便測試，因此咱們能夠先建立一個數據庫。

create database students charset=utf8;

1557023744365

1.3.1.1數據遷移

把students子應用添加到INSTALL_APPS中

1557023819604

初始化數據庫鏈接

安裝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

在測試中碰到以下問題

1.3.1.2 django 2.1.7 版本中，數據遷移無異常

1.3.1.3 安裝最新的django版本 2.2.版本後會出現遷移數據報錯

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

1557024349366

解決方案：

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

1557025991751

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

1557026113769

解決方法：

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

1557026224431

1.3.2 建立序列化器

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

python manage.py startapp students

在syudents應用目錄中新建serializers.py用於保存該應用的序列化器。建立一個StudentModelSerializer用於序列化與反序列化。

from rest_framework import serializers
from .models import Student

# 建立序列化器類，回頭會在試圖中被調用
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

  • model 指明該序列化器處理的數據字段從模型類BookInfo參考生成

  • fields 指明該序列化器包含模型類中的哪些字段，'all'指明包含全部字段

1.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 指明該視圖在進行序列化或反序列化時使用的序列化器

1.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")),
]

1.3.5 運行測試

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

python manage.py runserver

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

1557027948031

1）點擊連接127.0.0.1:8000/stu/students 能夠訪問獲取全部數據的接口，呈現以下頁面：

1557027878963

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

1557027999506

點擊POST後，返回以下頁面信息：

1557028072470

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

1557028115925

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

1557028168350

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

1557028208243

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

1557028242637

返回，以下頁面：

1557028266190

從上面咱們知道，一個drf的應用大概流程爲

  1. 建立模型類，進行數據遷移
  2. 建立序列化器
  3. 定義視圖函數：調用序列化器，在視圖中展現
  4. 定義路由，子應用的分發路由

2. 序列化器-serializer

序列化器的做用：

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

2.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='姓名')
    sex = models.BooleanField(default=1,verbose_name='性別')
    age = models.IntegerField(verbose_name='年齡')
    class_number = models.CharField(max_length=5,verbose_name='班級簽名')
    description = models.TextField(max_length=1000,verbose_name='個性簽名')

    def __str__(self):
        return self.name

    class Meta:
        db_table="tb_student"
        # 一個是單數一個是複數
        verbose_name="學生"
        verbose_name_plural=verbose_name

爲這個模型類提供一個序列化器，先新建一個serializers.py文件，定義以下

from rest_framework import serializers


class StudentSerializer(serializers.Serializer):
    # 學生信息序列化工具
    # 1.設定須要序列化的字段

    id= serializers.IntegerField()
    name = serializers.CharField()
    age = serializers.IntegerField()
    sex = serializers.BooleanField()
    description = serializers.CharField()

    # 2.聲明調用的模型信息
    # 3.驗證代碼
    # 4.添加以及更新模型的代碼

注意：serializer不是隻能爲數據庫模型類定義，也能夠爲非數據庫模型類的數據定義。serializer是獨立於數據庫以外的存在。

經常使用字段類型：

字段 字段構造方式
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=)

 

image

image

2.2 建立建立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屬性獲取。

  1. 使用序列化器的時候必定要注意，序列化器聲明瞭之後，不會自動執行，須要咱們在視圖中進行調用才能夠。

  2. 序列化器沒法直接接收數據，須要咱們在視圖中建立序列化器對象時把使用的數據傳遞過來。

  3. 序列化器的字段聲明相似於咱們前面使用過的表單系統。

  4. 開發restful api時，序列化器會幫咱們把模型數據轉換成字典.

  5. drf提供的視圖會幫咱們把字典轉換成json,或者把客戶端發送過來的數據轉換字典.

2.3 序列化器的使用

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

  1. 在客戶端請求時，使用序列化器能夠完成對數據的反序列化。

  2. 在服務器響應時，使用序列化器能夠完成對數據的序列化。

2.3.1 序列化

2.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 StudentView(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參數補充說明

"""使用序列化器序列化轉換多個模型數據"""
    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', '猴賽雷')])]

2.3.2 反序列化器

反序列化主要的做用爲

  • 數據驗證：在數據段的基本驗證以外添加本身獨有的驗證
  • 保存數據：對驗證後的數據進行數據保存

2.3.2.1 數據驗證

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

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

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

驗證成功，能夠經過序列化器對象的validated_data屬性獲取數據。

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

爲了方便演示效果，咱們單獨再次建立一個子應用unsers。

python manage.py startapp unsers

定義序列化器代碼：

from rest_framework import serializers
class StudentSerializer(serializers.Serializer):
    # 須要轉換的字段聲明
    # 小括號裏面聲明主要提供給反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True)
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True)
    # 若是序列化器調用的模型中的字段聲明，則須要聲明Meta類

    # 驗證

    # 添加和更新代碼

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

# Create your views here.
from django.http import JsonResponse
from django.views import View
from .serializers import StudentSerializer
from students.models import Student
class StudentView(View):
    def post(self,request):
        """添加一個學生"""
        # 接受參數
        post_data = request.POST
        data = {
            "name":post_data.get('name'),
            "age":post_data.get('age'),
            "sex":post_data.get('sex'),
            "description":post_data.get('description'),
        }
        # 調用序列化器進行反序列化驗證和轉換
        serializer = StudentSerializer(data=data)

        # 當驗證失敗時,能夠直接經過聲明 raise_exception=True 讓django直接跑出異常
        result = serializer.is_valid(raise_exception=True)
        print( "驗證結果:%s" % result )

        # 獲取經過驗證後的數據
        print( serializer.validated_data )
        # 保存數據
        student = Student.objects.create(
            name=serializer.validated_data.get("name"),
            age=serializer.validated_data.get("age"),
            sex=serializer.validated_data.get("sex")
        )

        print(student)
        # 返回響應結果給客戶端
        # alt + enter，能夠實現快速導包
        return JsonResponse({"message": "ok"})

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 StudentSerializer(serializers.Serializer):
    """學生數據序列化器"""
    ...

    # 序列化器中能夠自定義單個字段的驗證方法  def validate_<字段名>(用戶提交的字段數據):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用戶名不能是老男孩")

        # 驗證完成之後務必要返回字段值
        return data
2) validate

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

class StudentSerializer(serializers.Serializer):
    """學生數據序列化器"""
    ...

    # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用戶名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年齡不能是0")

        # 驗證完成之後務必要返回data
        return data
3) validators

在字段中添加validators選項參數，也能夠補充驗證行爲，如

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年齡不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 須要轉換的字段聲明
    # 小括號裏面聲明主要提供給反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True)

2.3.2.2 數據保存

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

能夠經過實現create()和update()兩個方法來實現。

from rest_framework import serializers
from students.models import Student

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年齡不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 須要轉換的字段聲明
    # 小括號裏面聲明主要提供給反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True)
    # 若是序列化器調用的模型中的字段聲明，則須要聲明Meta類

    # 驗證
    # 序列化器中能夠自定義單個字段的驗證方法  def validate_<字段名>(用戶提交的字段數據):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用戶名不能是老男孩")

        # 驗證完成之後務必要返回字段值
        return data

    # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用戶名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年齡不能是0")

        # 驗證完成之後務必要返回data
        return data

    # 添加和更新代碼
    # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的
    def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據
        student = Student.objects.create(
            name=self.validated_data.get("name"),
            age=self.validated_data.get("age"),
            sex=self.validated_data.get("sex")
        )

        return student

    def update(self,instance,validated_data):
        """更新學生信息"""
        instance.name=validated_data.get("name")
        instance.sex=validated_data.get("sex")
        instance.age=validated_data.get("age")
        instance.description=validated_data.get("description")
        # 調用模型的save更新保存數據
        instance.save()

        return instance

實現了上述兩個方法後，在視圖中調用序列化器進行反序列化數據的時候，就能夠經過save()方法返回一個數據對象實例了。

book = serializer.save()

視圖代碼以下：

# Create your views here.
from django.http import JsonResponse
from django.views import View
from .serializers import StudentSerializer
from students.models import Student
class StudentView(View):
    def post(self,request):
        """添加一個學生"""
        
        ....


    def put(self,request):
        """更新學生信息"""
        # 接受參數
        data = {
            "id":9,
            "name":"abc",
            "age":18,
            "sex":1,
            "description":"測試",
        }
        # 獲取要修改的數據
        instance = Student.objects.get(pk=data.get("id"))
        # 調用序列化器
        serializer = StudentSerializer(instance=instance,data=data)
        # 驗證
        serializer.is_valid(raise_exception=True)
        # 轉換成模型數據
        student = serializer.save()

        return JsonResponse({"message": "ok"})

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

2.3.2.3 附加說明

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

# request.user 是django中記錄當前登陸用戶的模型對象
serializer.save(owner=request.user)

2）默認序列化器必須傳遞全部required的字段，不然會拋出驗證異常。可是咱們可使用partial參數來容許部分字段更新

# 更新學生的部分字段信息，當數據庫容許爲空，可是序列化器要求必須字段填寫的時候，可使用如下方式避開
serializer = StudentSerializer(instance=instance, data=data, partial=True)

3）把上面序列化器子應用sers和反序列化器子應用unsers裏面的序列化器進行對比。

#sers中
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()
#unsers中
from rest_framework import serializers
from students.models import Student

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年齡不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 須要轉換的字段聲明
    # 小括號裏面聲明主要提供給反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=True, allow_null=True, allow_blank=True)
    # 若是序列化器調用的模型中的字段聲明，則須要聲明Meta類

    # 驗證
    # 序列化器中能夠自定義單個字段的驗證方法  def validate_<字段名>(用戶提交的字段數據):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用戶名不能是老男孩")

        # 驗證完成之後務必要返回字段值
        return data

    # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用戶名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年齡不能是0")

        # 驗證完成之後務必要返回data
        return data

    # 添加和更新代碼
    # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的
    def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據
        student = Student.objects.create(
            name=self.validated_data.get("name"),
            age=self.validated_data.get("age"),
            sex=self.validated_data.get("sex")
        )

        return student

    def update(self,instance,validated_data):
        """更新學生信息"""
        instance.name=validated_data.get("name")
        instance.sex=validated_data.get("sex")
        instance.age=validated_data.get("age")
        instance.description=validated_data.get("description")
        # 調用模型的save更新保存數據
        instance.save()

        return instance

能夠發現，反序列化器中的代碼會包含了序列化器中的大部分代碼，除了ID字段的聲明。

因此在開發的時候，咱們通常都是直接寫在一塊兒，那麼有些字段只會出如今序列化器階段，例如ID。還有些字段只會出如今反序列化階段，例如：用戶密碼。

那麼， 咱們須要在序列化器類中，聲明那些字段是在序列化時使用，哪些字段在反序列化中使用了。

最終序列化器中的代碼：

from rest_framework import serializers
from students.models import Student

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年齡不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 須要轉換的字段聲明
    # 小括號裏面聲明主要提供給反序列化使用的
    id=serializers.IntegerField(read_only=True)
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True,write_only=True)
    description = serializers.CharField(required=True, allow_null=True, allow_blank=True)
    # 若是序列化器調用的模型中的字段聲明，則須要聲明Meta類

    # 驗證
    # 序列化器中能夠自定義單個字段的驗證方法  def validate_<字段名>(用戶提交的字段數據):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用戶名不能是老男孩")

        # 驗證完成之後務必要返回字段值
        return data

    # 方法名時固定的,用於驗證多個字段,參數就是實例化序列化器類時的data參數
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用戶名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年齡不能是0")

        # 驗證完成之後務必要返回data
        return data

    # 添加和更新代碼
    # 序列化器中會提供了兩個方法: create 和 update,方法名是固定的
    def create(self, validated_data): # validated_data 參數,在序列化器調用時,會自動傳遞驗證完成之後的數據
        student = Student.objects.create(
            name=self.validated_data.get("name"),
            age=self.validated_data.get("age"),
            sex=self.validated_data.get("sex")
        )

        return student

    def update(self,instance,validated_data):
        """更新學生信息"""
        instance.name=validated_data.get("name")
        instance.sex=validated_data.get("sex")
        instance.age=validated_data.get("age")
        instance.description=validated_data.get("description")
        # 調用模型的save更新保存數據
        instance.save()

        return instance

2.4 模型類序列化器的使用

若是咱們想要使用序列化器對應的是Django的模型類，DRF爲咱們提供了ModelSerializer模型類序列化器來幫助咱們快速建立一個Serializer類。

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

  • 基於模型類自動生成一系列字段

  • 基於模型類自動爲Serializer生成validators，好比unique_together

  • 包含默認的create()和update()的實現

2.4.1 模型序列化器的定義

爲了方便學習和查看效果， 新建一個子應用msers。

python manage.py startapp msers

建立一個StudentModelSerializer

from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    # 字段聲明

    # 若是模型類序列化器,必須聲明本次調用是哪一個模型,模型裏面的哪些字段
    class Meta:
        model = Student
        fields = ["id","name","age","description","sex"]
        # fields = "__all__" # 表示操做模型中的全部字段
        # 添加額外的驗證選項
        extra_kwargs = {
            "sex":{"write_only":True,},
            "id":{"read_only":True,}
        }

  • model 指明參照哪一個模型類

  • fields 指明爲模型類的哪些字段生成

2.4.2 指定字段

1) 使用fields來明確字段，__all__表名包含全部字段，也能夠寫明具體哪些字段，如

class StudentModelSerializer(serializers.ModelSerializer):
    """學生數據序列化器"""
    class Meta:
        model = Student
        fields = ['id', 'age', 'name',"description"]

2）使用exclude能夠明確排除掉哪些字段

class StudentModelSerializer(serializers.ModelSerializer):
    """學生數據序列化器"""
    class Meta:
        model = Student
        exclude = ['sex']

3）指明只讀字段[少用]

能夠經過read_only_fields指明只讀字段，即僅用於序列化輸出的字段

class StudentModelSerializer(serializers.ModelSerializer):
    """學生數據序列化器"""
    class Meta:
        model = Student
        fields = ['id', 'age', 'name',"description"]
        read_only_fields = ('id')

2.4.3 添加額外參數

from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    # 額外字段聲明,必須在fields裏面也要聲明上去,不然序列化器不會調用
    # password2 = serializers.CharField(write_only=True,required=True)

    # 若是模型類序列化器,必須聲明本次調用是哪一個模型,模型裏面的哪些字段
    class Meta:
        model = Student
        # fields = ["id","name","age","description","sex","password2"]
        fields = ["id","name","age","description","sex"]
        # fields = "__all__" # 表示操做模型中的全部字段
        # 添加額外的驗證選項
        extra_kwargs = {
            "sex":{"write_only":True,},
            "id":{"read_only":True,}
        }

    # 驗證代碼

    # 也能夠從新聲明一個create和update

最後注意的是：後面在使用DRF的時候基本都是用最後一種方式去使用！

a

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程