Django框架之drf

一、序列化器常用欄位及引數

# 序列化類---》欄位類 CharField，除此之外還有哪些其他的

# 序列化類---》欄位類，欄位類上，傳屬性的 ，序列化類上，也可以寫屬性
    models.CharField(max_length=32)

1、常用欄位

欄位	欄位構造方式
BooleanField	BooleanField()
NullBooleanField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
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(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=)

2、常用欄位引數

選項引數

引數名	說明
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、欄位引數針對性分類

選項引數：

# CharField及其子類的(EmailField) ---》反序列化的校驗,欄位自己的規則
    max_length	最大長度
    min_lenght	最小長度
    allow_blank	是否允許為空
    trim_whitespace	是否截斷空白字元

# IntegerField
    max_value	最小值
    min_value	最大值

    
# 所有欄位類都有的
required	表明該欄位在反序列化時必須輸入，預設True
default	    反序列化時使用的預設值
allow_null	表明該欄位是否允許傳入None，預設False
validators	該欄位使用的驗證器
----看一眼忘掉-----
error_messages	包含錯誤編號與錯誤資訊的字典
label	用於HTML展示API頁面時，顯示的欄位名稱
help_text	用於HTML展示API頁面時，顯示的欄位幫助提示資訊


# 重點：
read_only	表明該欄位僅用於序列化輸出，預設False
write_only	表明該欄位僅用於反序列化輸入，預設False


## 反序列化校驗執行流程
	-1 先執行欄位自己的校驗規則----》最大長度，最小長度，是否為空，是否必填，最小數位。。。。
    -2 validators=[方法，] ----》單獨給這個欄位加校驗規則
    	name=serializers.CharField(validators=[方法,])
    -3 區域性勾點校驗規則
    -4 全域性勾點校驗規則

二、序列化器高階用法之source

準備工作

### 建立關聯表
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)

    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE) 
    authors = models.ManyToManyField(to='Author')


class Publish(models.Model):
    name = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)


class Author(models.Model):
    name = models.CharField(max_length=32)
    phone = models.CharField(max_length=11)

# 遷移，錄入資料

1、客製化欄位名

在我們編寫序列化器的時候，序列化類中的欄位名字對應的是模型層下表名內對應的欄位名，但有的時候我們需要確保資料的安全，並不想直接將真實的欄位名返回給前端使用者檢視，這個時候我們就可以利用source引數來將返回給前端的欄位名進行修改

source引數：可以指定序列化欄位的名字

class BookSerializer(serializers.Serializer):
    # 自有欄位： 直接寫欄位名
    book_name = serializers.CharField(source='name')
    book_price = serializers.CharField(source='price')

    # 外來鍵欄位：多對多，欄位名字修改了，但是資料內容沒辦法顯示
    book_author = serializers.CharField(source='author.all')
    # 外來鍵欄位：一對多，可以顯示
    book_publish = serializers.CharField(source='publish.name')

三、客製化欄位資料的兩種的方法

客製化關聯欄位的顯示形式

一對多：顯示字典
多對多：顯示列表內套字典

1、在序列化器類中客製化

使用：SerializerMethodField欄位客製化

from rest_framework import serializers


class BookSerializer(serializers.Serializer):
    # 自有欄位
    book_name = serializers.CharField(source='name')
    book_price = serializers.CharField(source='price')

    # 外來鍵欄位
    book_publish = serializers.SerializerMethodField()

    def get_book_publish(self, obj):
        return {'name': obj.publish.name, 'address': obj.publish.address}

    book_author = serializers.SerializerMethodField()

    def get_book_author(self, obj):
        book_data_list = [{'name': author_obj.name, 'phone': author_obj.phone} for author_obj in obj.author.all()]
        return book_data_list

2、在模型表中客製化

在models.py檔案下表的類中客製化

### models.py 表的類中編寫方法
    from django.db import models


    class Book(models.Model):
        name = models.CharField(max_length=32)
        price = models.CharField(max_length=32)

        publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)

        def publish_detail(self):
            return {'name': self.publish.name, 'phone': self.publish.address}

        author = models.ManyToManyField(to='Author')

        def author_list(self):
            book_data_list = [{'name': author_obj.name, 'phone': author_obj.phone} for author_obj in self.author.all()]
            return book_data_list
    
    
### Serialiaer.py 序列化器中編寫方法
    from rest_framework import serializers


    class BookSerializer(serializers.Serializer):
        # 自有欄位
        book_name = serializers.CharField(source='name')
        book_price = serializers.CharField(source='price')

        # 外來鍵欄位
        publish_detail = serializers.DictField()
        author_list = serializers.ListField()

四、多表關聯反序列化儲存

前端傳入資料格式

# 前端傳入的資料格式：
	{'name':'紅樓夢','price':19,'publish':1,'authors':[1,2]}

1、新增介面

### view.py 檢視類
    class BookView(APIView):
        # 新增
        def post(self, request):
            ser_obj = BookSerializer(data=request.data)
            if ser_obj.is_valid():
                ser_obj.save()
                return Response({'code': 100, 'msg': '新增圖書成功', 'result': ser_obj.data})
            return Response({'code': 101, 'msg': ser_obj.errors})
        
        
### serializer.py 序列化器類
    class BookSerializer(serializers.Serializer):
        # 自有欄位
        name = serializers.CharField()
        price = serializers.CharField()

        # 設定write_only引數，只作為反序列化使用
        publish = serializers.CharField(write_only=True)
        author = serializers.ListField(write_only=True)

        # 外來鍵欄位，設定read_only引數，只作為序列化使用
        publish_detail = serializers.DictField(read_only=True)
        author_list = serializers.ListField(read_only=True)

        # 新增
        def create(self, validated_data):
            # 使用反序列化後的資料建立新的圖書
            new_book_obj = Book.objects.create(name=validated_data.get('name'),             price=validated_data.get('price')    ,                     publish_id=validated_data.get('publish'))
            # 作者外來鍵欄位同步更新
           new_book_obj.author.add(*validated_data.get('author'))
            return new_book_obj

2、修改介面

### view.py 檢視類:
    class BookDetailView(APIView):	
        # 修改
        def put(self, request, pk):
            # 獲取指定圖書
            target_book_obj = Book.objects.filter(pk=pk).first()
            if target_book_obj:
                ser_obj = BookSerializer(data=request.data, instance=target_book_obj)
                if ser_obj.is_valid():
                    ser_obj.save()
                    return Response(ser_obj.data)
                return Response({'code': 101, 'msg': ser_obj.errors})
            return Response({'code': 101, 'msg': '圖書不存在'})
        
        
### serializer.py 序列化器類:
	class BookSerializer(serializers.Serializer):
        # 自有欄位
        name = serializers.CharField()
        price = serializers.CharField()

        # 設定write_only引數，只作為反序列化使用
        publish = serializers.CharField(write_only=True)
        author = serializers.ListField(write_only=True)

        # 外來鍵欄位，設定read_only引數，只作為序列化使用
        publish_detail = serializers.DictField(read_only=True)
        author_list = serializers.ListField(read_only=True)
		  # 修改
		  def update(self, instance, validated_data):
            instance.name = validated_data.get('name')
            instance.price = validated_data.get('price')
            instance.publish_id = validated_data.get('publish')
            instance.author.clear()
            instance.author.add(*validated_data.get('author'))
            instance.save()
            return instance

五、反序列化欄位校驗（總結）

反序列化欄位校驗（共四層）

1、自有欄位：可直接在欄位後方引數填寫校驗規則
2、validators引數：同樣在欄位後方引數內填寫，通過繫結函數體程式碼進行校驗
3、區域性勾點
4、全域性勾點

六、ModelSerializer的使用

ModelSerializer繼承自Serializer，幫助我們完成了很多操作

特點：

和表模型強關聯
幫助我們完成很多請求，不用再create和update

使用方法：

class BookSerializer(serializers.ModelSerializer):
    # 控制欄位的校驗
    class Meta:
        # 與表進行關聯
        model = Book
        # 填寫__all__預設序列全部欄位，如果Meta寫了__all__ ,就相當於，複製了表模型中的所有欄位，放在了這裡，做了個對映
        # fields = '__all__'
        # 填寫列表是校驗部分欄位
        fields = ['name', 'price', 'publish', 'author', 'publish_detail', 'author_list']

        # 給欄位新增校驗或限制
        extra_kwargs = {
            'name': {'max_length': 3},
            'price': {'min_length': 2},
            'publish': {'write_only': True},
            'author': {'write_only': True},
            'author_list': {'read_only': True},
            'publish_detail': {'read_only': True},
        }

    # 假如Meta類中已經對欄位進行校驗，任然可以在外部（內部的校驗失效）重寫校驗，優先順序高於Meta內部的校驗
    name = serializers.CharField(max_length=8)
    # 同理，針對外來鍵欄位的方法也可以在外部重寫
    # book_publish = serializers.SerializerMethodField()
    #
    # def get_book_publish(self, obj):
    #     return {'name': obj.publish.name, 'address': obj.publish.address}
    #
    # book_author = serializers.SerializerMethodField()
    #
    # def get_book_author(self, obj):
    #     book_data_list = [{'name': author_obj.name, 'phone': author_obj.phone} for author_obj in obj.author.all()]
    #     return book_data_list

    # 勾點函數（不會影響，正常編寫即可）
    def validate_name(self, name):
        if name.startswith('sb'):
            raise ValidationError('不能sb')

        else:
            return name

django框架之drf：04、序列化器常用欄位及引數，序列化器高階用法之source、客製化欄位資料的兩種方法、多表關聯反序列化的儲存、ModelSerializer的使用