1.序列化使用

settings.py註冊App

INSTALLED_APPS = [

    'rest_framework',
    'users',
]

urls.py 定義總路由

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

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

users/urls.py

#! /usr/bin/env python
# -*- coding: utf-8 -*-
from django.urls import path,re_path
from users import views

urlpatterns = [
    re_path(r'^info/$', views.UserInfoViewSet.as_view(), name='userinfo'),
]

users/models.py

from django.db import models

class UserInfo(models.Model):
    name = models.CharField(max_length=64,unique=True)
    ut = models.ForeignKey(to='UserType', on_delete=models.CASCADE)
    gp = models.ManyToManyField(to='UserGroup')

    def __str__(self):
        return self.name

class UserType(models.Model):
    type_name = models.CharField(max_length=64,unique=True)

    def __str__(self):
        return self.type_name

class UserGroup(models.Model):
    group = models.CharField(max_length=64)

    def __str__(self):
        return self.group

users/views.py

from rest_framework.views import APIView
from rest_framework.views import Response
import json

from users import serializers
from users import models as users_model

class UserInfoViewSet(APIView):
    # 查詢使用者資訊
    def get(self, request, *args, **kwargs):
        # 一對多、多對多查詢都是一樣的語法
        obj = users_model.UserInfo.objects.all()
        ser = serializers.UserInfoSerializer(instance=obj,many=True)  # 關聯資料多個
        # ser = serializers.UserInfoSerializer(instance=obj[0])   # 關聯資料一個
        return Response(ser.data, status=200)

    # 建立使用者
    '''建立使用者'''
    def post(self,request):
        ser = serializers.UserInfoSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            return Response(data=ser.data, status=201)
        return Response(data=ser.errors,status=400)

    # 更新使用者資訊
    def put(self, request):
        pk = request.data.get('pk')
        userinfo = users_model.UserInfo.objects.get(id = pk)
        # 建立序列化物件，並將要反序列化的資料傳遞給data構造引數，進而進行驗證
        ser = serializers.UserInfoSerializer(userinfo,data=request.data)
        if ser.is_valid():
            ser.save()
            return Response(data=ser.data, status=201)
        return Response(data=ser.errors,status=400)

users/serializers.py

from rest_framework import serializers
from users.models import UserInfo


class UserInfoSerializer(serializers.Serializer):
    name = serializers.CharField(min_length=3,max_length=20)                # 顯示普通欄位
    ut_id = serializers.IntegerField(write_only=True)                      # 外來鍵約束，關聯欄位要定義
    ut = serializers.CharField(source='ut.type_name',required=False)      # 顯示一對多欄位名稱
    gp = serializers.SerializerMethodField(read_only=True)                 # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name',required=False)              # 也可以自定義顯示欄位名稱

    '''PrimaryKeyRelatedField和StringRelatedField：可以用對 一對多 和 多對多 關聯物件序列化'''
    # gp = serializers.PrimaryKeyRelatedField(read_only=True, many=True)
    # gp = serializers.StringRelatedField(read_only=True,many=True)

    class Meta:
        model = UserInfo

    # 自定義顯示 多對多 欄位
    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的物件'''
        gp_obj_list = row.gp.all().values('id','group')  # 獲取使用者所有組
        return gp_obj_list

    # 定義建立語法
    def create(self, validated_data):
        return UserInfo.objects.create(**validated_data)

    # 定義更新方法
    def update(self, instance, validated_data):
        if validated_data.get('name'):
            instance.name = validated_data['name']
        if validated_data.get('ut_id'):
            instance.ut_id = validated_data['ut_id']
        instance.save()
        return instance

    # 定義單一欄位驗證的方法
    def validate_name(self, value):
        if value == 'root':
            raise serializers.ValidationError('不能建立root管理員賬號')
        return value

    # 定義多欄位驗證方法
    def validate(self, attrs):
        if attrs['name'] == 'admin':
            raise serializers.ValidationError('不能建立admin使用者')
        return attrs


# 一對多序列化（反向查詢）
class UserTypeSerializer(serializers.Serializer):
    type_name = serializers.CharField()
    # 法1一對多關聯物件序列化：此欄位將被序列化為關聯物件的主鍵
    userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)

    # 法2一對多關聯物件序列化：此欄位將被序列化為關聯物件的字串表示方式（即__str__方法的返回值）
    # userinfo_set = serializers.StringRelatedField(read_only=True,many=True)
    # 法3一對多關聯物件序列化：使用關聯物件的序列化器
    # userinfo_set = UserInfoSerializer(many=True)


# 多對多序列化（反向）
class UserGroupSerializer(serializers.Serializer):
    group = serializers.CharField()
    # 法1一對多關聯物件序列化：此欄位將被序列化為關聯物件的主鍵
    # userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)

    # 法2一對多關聯物件序列化：此欄位將被序列化為關聯物件的字串表示方式（即__str__方法的返回值）
    # userinfo_set = serializers.StringRelatedField(read_only=True,many=True)
    # 法3一對多關聯物件序列化：使用關聯物件的序列化器
    # userinfo_set = UserInfoSerializer(many=True)

2.序列化（serializers,Serializer）

　　1)序列化（正向查詢）

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.Serializer):
    name = serializers.CharField(min_length=3,max_length=20)               # 顯示普通欄位
    ut = serializers.CharField(source='ut.type_name',required=False)       # 顯示一對多欄位名稱
    gp = serializers.SerializerMethodField(read_only=True)                 # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name',required=False)              # 也可以自定義顯示欄位名稱
    ut_id = serializers.IntegerField(write_only=True)                      # 一對多關聯欄位定義(外來鍵約束)

    '''PrimaryKeyRelatedField和StringRelatedField：可以用對 一對多 和 多對多 關聯物件序列化'''
    # gp = serializers.PrimaryKeyRelatedField(read_only=True, many=True)
    # gp = serializers.StringRelatedField(read_only=True,many=True)

    class Meta:
        model = UserInfo

    # 自定義顯示 多對多 欄位
    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的物件'''
        gp_obj_list = row.gp.all().values('id','group')  # 獲取使用者所有組
        return gp_obj_list

　　2)序列化（反向查詢）

''' 一對多序列化（反向查詢）'''
class UserTypeSerializer(serializers.Serializer):
    type_name = serializers.CharField()
    # 法1一對多關聯物件序列化：此欄位將被序列化為關聯物件的主鍵
    userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)

    # 法2一對多關聯物件序列化：此欄位將被序列化為關聯物件的字串表示方式（即__str__方法的返回值）
    # userinfo_set = serializers.StringRelatedField(read_only=True,many=True)
    # 法3一對多關聯物件序列化：使用關聯物件的序列化器
    # userinfo_set = UserInfoSerializer(many=True)

　　3)檢視函式中使用序列化

class UserInfoViewSet(APIView):
    def get(self, request, *args, **kwargs):
        # 一對多、多對多查詢都是一樣的語法
        obj = users_model.UserInfo.objects.all()
        ser = serializers.UserInfoSerializer(instance=obj,many=True)  # 關聯資料多條
        # ser = serializers.UserInfoSerializer(instance=obj[0])       # 關聯資料一條
        return Response(ser.data, status=200)

3.反序列化

　　1)使用反序列化儲存資料

'''建立使用者'''
def post(self,request):
    ser = serializers.UserInfoSerializer(data=request.data)
    if ser.is_valid():
        ser.save()
        return Response(data=ser.data, status=201)
    return Response(data=ser.errors,status=400)

　　2)反序列化定義建立和更新方法

    # 定義建立語法
    def create(self, validated_data):
        return UserInfo.objects.create(**validated_data)

    # 定義更新方法
    def update(self, instance, validated_data):
        if validated_data.get('name'):
            instance.name = validated_data['name']
        if validated_data.get('ut_id'):
            instance.ut_id = validated_data['ut_id']
        instance.save()
        return instance

    # 定義單一欄位驗證的方法
    def validate_name(self, value):
        if value == 'root':
            raise serializers.ValidationError('不能建立root管理員賬號')
        return value

    # 定義多欄位驗證方法
    def validate(self, attrs):
        if attrs['name'] == 'admin':
            raise serializers.ValidationError('不能建立admin使用者')
        return attrs

4.序列化使用舉例（serializers.ModelSerializer）

　　1.ModelSerializer本質是繼承了Serielizer類添加了部分功能

　　2.在使用ModelSerializer可以使用 fields = '__all__'

serializers.ModelSerializer使用

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.ModelSerializer):
    # name = serializers.CharField()                       # 顯示普通欄位
    ut = serializers.CharField(source='ut.type_name')     # 顯示一對多欄位
    gp = serializers.SerializerMethodField()               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name')             # 也可以自定義顯示欄位名稱

    class Meta:
        model = UserInfo
        # fields = "__all__"
        fields = ["name",'ut','gp','xxx']  # 定義顯示那些欄位

    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的物件'''
        gp_obj_list = row.gp.all()  # 獲取使用者所有組
        ret = []
        for item in gp_obj_list:
            ret.append({'id':item.id,'gp':item.group})
        return ret

5.使用serializers.ModelSerializer

users/views.py

from rest_framework.views import APIView
from users.serializers.userinfo_serializers import UserInfoSerializer
from users.models import UserInfo

class UserInfoViewSet(APIView):
    def get(self, request, *args, **kwargs):
        obj = UserInfo.objects.all()
        ser = UserInfoSerializer(instance=obj,many=True)
        ret = json.dumps(ser.data,ensure_ascii=False)
        return HttpResponse(ret)

    def post(self, request, *args, **kwargs):
        ser = UserInfoSerializer(data=request.data)          # 驗證，對請求發來的資料進行驗證
        if ser.is_valid():
            print(ser.validated_data)  # post請求資料字典
        else:
            print(ser.errors)  # form驗證錯誤資訊
        return HttpResponse(json.dumps({'status':True}))

users/serializers/userinfo_serializers.py

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from django.core.exceptions import ValidationError
from users.models import UserInfo

class UserInfoSerializer(serializers.ModelSerializer):
    name = serializers.CharField(min_length=10, error_messages={'required': '該欄位必填'})                       # 顯示普通欄位
    ut = serializers.CharField(source='ut.type_name',required=False)     # 顯示一對多欄位
    gp = serializers.SerializerMethodField(required=False)               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name', required=False)             # 也可以自定義顯示欄位名稱

    class Meta:
        model = UserInfo
        # fields = "__all__"
        fields = ["name",'ut','gp','xxx']  # 定義顯示那些欄位

    # 區域性鉤子:
    def validate_name(self, value):  # value 是name欄位提交的值
        if value.startswith('sb'):  # 不能以sb開頭
            raise ValidationError('不能以sb開頭')
        else:
            return value

    # 全域性鉤子找到了
    def validate(self, value):  # value是所有校驗通過資料的字典
        name = value.get('name')
        if False:
            raise ValidationError('全域性鉤子引發異常')
        return value

'''1、ser.is_valid()'''
# 驗證post請求中資料是否合法

'''2、全域性校驗鉤子'''
def validate(self, value):        # value是所有校驗通過資料的字典

'''3、區域性鉤子'''
def validate_name(self, value):   # value 是name欄位提交的值