serializers.fieild

我們知道在django中嘉抒，form也有許多field青灼，那serializers其實也是drf中發(fā)揮著這樣的功能棍好。我們先簡單了解常用的幾個field。

1. 常用的field

CharField茁瘦、BooleanField纽竣、IntegerField墓贿、DateTimeField這幾個用得比較多茧泪，我們把外鍵的field放到后面去說！

# 舉例子
mobile = serializers.CharField(max_length=11, min_length=11)
age = serializers.IntegerField(min_value=1, max_value=100)
# format可以設(shè)置時間的格式聋袋，下面例子會輸出如:2018-1-24 12:10
pay_time = serializers.DateTimeField(read_only=True,format='%Y-%m-%d %H:%M')
is_hot = serializers.BooleanField()

不同的是队伟，我們在django中，form更強(qiáng)調(diào)對提交的表單進(jìn)行一種驗證幽勒，而serializer的field不僅在進(jìn)行數(shù)據(jù)驗證時起著至關(guān)重要的作用嗜侮，在將數(shù)據(jù)進(jìn)行序列化后返回也發(fā)揮著重要作用！啥容！
??我們可以看出锈颗，不同的field可以用不同的關(guān)鍵參數(shù)，除此之外咪惠，還有一些十分重要有用的參數(shù)击吱。

2. Core arguments參數(shù)

read_only：True

表示不允許用戶自己上傳，只能用于api的輸出遥昧。如果某個字段設(shè)置了read_only=True覆醇，那么就不需要進(jìn)行數(shù)據(jù)驗證，只會在返回時炭臭，將這個字段序列化后返回
??舉個簡單的例子：在用戶進(jìn)行購物的時候永脓，用戶post訂單時，肯定會產(chǎn)生一個訂單號鞋仍，而這個訂單號應(yīng)該由后臺邏輯完成常摧，而不應(yīng)該由用戶post過來，如果不設(shè)置read_only=True威创，那么驗證的時候就會報錯落午。

order_sn = serializers.CharField(readonly=True)

write_only: 與read_only對應(yīng)

required: 顧名思義，就是這個字段是否必填那婉。

allow_null/allow_blank：是否允許為NULL/空 。

error_messages：出錯時党瓮，信息提示详炬。

name = serializers.CharField(required=True, min_length=6,
                error_messages={
                    'min_length': '名字不能小于6個字符',
                    'required': '請?zhí)顚懨?})

label: 字段顯示設(shè)置，如 label='驗證碼'

help_text: 在指定字段增加一些提示文字寞奸，這兩個字段作用于api頁面比較有用

style: 說明字段的類型呛谜，這樣看可能比較抽象，看下面例子：

# 在api頁面枪萄，輸入密碼就會以*顯示
password = serializers.CharField(
    style={'input_type': 'password'})
# 會顯示選項框
color_channel = serializers.ChoiceField(
    choices=['red', 'green', 'blue'],
    style={'base_template': 'radio.html'})
??這里面隐岛，還有一個十分有用的validators參數(shù)，這個我們會在后面提及瓷翻！

3. HiddenField

HiddenField的值不依靠輸入聚凹，而需要設(shè)置默認(rèn)的值割坠，不需要用戶自己post數(shù)據(jù)過來，也不會顯式返回給用戶妒牙，最常用的就是user!!
??我們在登錄情況下彼哼，進(jìn)行一些操作，假設(shè)一個用戶去收藏了某一門課湘今，那么后臺應(yīng)該自動識別這個用戶敢朱，然后用戶只需要將課程的id post過來，那么這樣的功能摩瞎，我們配合CurrentUserDefault()實現(xiàn)拴签。

# 這樣就可以直接獲取到當(dāng)前用戶
user = serializers.HiddenField(
    default=serializers.CurrentUserDefault())

ModelSerializer

在大多數(shù)情況下，我們都是基于model字段去開發(fā)旗们。

好處：

ModelSerializer已經(jīng)重載了create與update方法蚓哩，它能夠滿足將post或patch上來的數(shù)據(jù)進(jìn)行進(jìn)行直接地創(chuàng)建與更新，除非有額外需求蚪拦，那么就可以重載create與update方法杖剪。
　　ModelSerializer在Meta中設(shè)置fields字段，系統(tǒng)會自動進(jìn)行映射驰贷，省去每個字段再寫一個field盛嘿。

class UserDetailSerializer(serializers.ModelSerializer):
    """
    用戶詳情序列化
    """
    class Meta:
        model = User
        fields = ("name", "gender", "birthday", "email", "mobile")
        # fields = '__all__': 表示所有字段
        # exclude = ('add_time',):  除去指定的某些字段
        # 這三種方式，存在一個即可1234567891011

ModelSerializer需要解決的2個問題：

1括袒，某個字段不屬于指定model次兆，它是write_only，需要用戶傳進(jìn)來锹锰，但我們不能對它進(jìn)行save( )芥炭，因為ModelSerializer是基于Model，這個字段在Model中沒有對應(yīng)恃慧，這個時候园蝠，我們需要重載validate！
如在用戶注冊時痢士，我們需要填寫驗證碼彪薛，這個驗證碼只需要驗證，不需要保存到用戶這個Model中：

    def validate(self, attrs):
        del attrs["code"]
        return attrs123

2怠蹂，某個字段不屬于指定model善延，它是read_only，只需要將它序列化傳遞給用戶城侧，但是在這個model中易遣，沒有這個字段！我們需要用到SerializerMethodField嫌佑。
　　假設(shè)需要返回用戶加入這個網(wǎng)站多久了豆茫，不可能維持這樣加入的天數(shù)這樣一個數(shù)據(jù)侨歉，一般會記錄用戶加入的時間點(diǎn)，然后當(dāng)用戶獲取這個數(shù)據(jù)澜薄，我們再計算返回給它为肮。

class UserSerializer(serializers.ModelSerializer):  
    days_since_joined = serializers.SerializerMethodField()
    # 方法寫法：get_ + 字段
    def get_days_since_joined(self, obj):
    # obj指這個model的對象
        return (now() - obj.date_joined).days

    class Meta:
        model = User123456789

Validation自定義驗證邏輯

單獨(dú)的validate

我們在上面提到field，它能起到一定的驗證作用肤京，但很明顯颊艳，它存在很大的局限性，舉個簡單的例子忘分，我們要判斷我們手機(jī)號碼棋枕，如果使用CharField(max_length=11, min_length=11），它只能確保我們輸入的是11個字符妒峦，那么我們需要自定義重斑！

mobile_phone = serializers.CharField(max_length=11, min_length=11）

def validate_mobile_phone(self, mobile_phone):
    # 注意參數(shù)，self以及字段名
    # 注意函數(shù)名寫法肯骇，validate_ + 字段名字
    if not re.match(REGEX_MOBILE, mobile):
    # REGEX_MOBILE表示手機(jī)的正則表達(dá)式
        raise serializers.ValidationError("手機(jī)號碼非法")
    return mobile_phone123456789

當(dāng)然窥浪，這里面還可以加入很多邏輯，例如笛丙，還可以判斷手機(jī)是否原本就存在數(shù)據(jù)庫等等漾脂。

聯(lián)合validate

上面驗證方式，只能驗證一個字段胚鸯，如果是兩個字段聯(lián)合在一起進(jìn)行驗證骨稿，那么我們就可以重載validate( )方法。

    start = serializers.DateTimeField()
    finish = serializers.DateTimeField()

    def validate(self, attrs):
    # 傳進(jìn)來什么參數(shù)姜钳，就返回什么參數(shù)坦冠，一般情況下用attrs
        if data['start'] > data['finish']:
            raise serializers.ValidationError("finish must occur after start")
        return attrs12345678

這個方法非常的有用，我們還可以再這里對一些read_only的字段進(jìn)行操作哥桥，我們在read_only提及到一個例子辙浑，訂單號的生成，我們可以在這步生成一個訂單號拟糕，然后添加到attrs這個字典中判呕。

order_sn = serializers.CharField(readonly=True)
def validate(self, attrs):
    # 調(diào)用一個方法生成order_sn
    attrs['order_sn'] = generate_order_sn()
    return attrs12345

這個方法運(yùn)用在modelserializer中，可以剔除掉write_only的字段已卸，這個字段只驗證佛玄，但不存在與指定的model當(dāng)中硼一，即不能save( )累澡，可以在這delete掉！

Validators

validators可以直接作用于某個字段般贼，這個時候愧哟，它與單獨(dú)的validate作用差不多

def multiple_of_ten(value):
    if value % 10 != 0:
        raise serializers.ValidationError('Not a multiple of ten')

class GameRecord(serializers.Serializer):
    score = IntegerField(validators=[multiple_of_ten])123456

當(dāng)然奥吩，drf提供的validators還有很好的功能：UniqueValidator，UniqueTogetherValidator等
　　UniqueValidator: 指定某一個對象是唯一的蕊梧，如霞赫，用戶名只能存在唯一：

username = serializers.CharField(
        max_length=11, 
        min_length=11,
        validators=[UniqueValidator(queryset=UserProfile.objects.all())
    ）12345

UniqueTogetherValidator: 聯(lián)合唯一，如用戶收藏某個課程肥矢，這個時候就不能單獨(dú)作用于某個字段端衰，我們在Meta中設(shè)置。

    class Meta:
        validators = [
            UniqueTogetherValidator(
                queryset=UserFav.objects.all(),
                fields=('user', 'course'),
                message='已經(jīng)收藏'
            )]

關(guān)于外鍵的serializers

其實甘改，外鍵的field也比較簡單旅东，如果我們直接使用serializers.Serializer，那么直接用PrimaryKeyRelatedField就解決了十艾。
??假設(shè)現(xiàn)在有一門課python入門教學(xué)(course)抵代，它的類別是python(catogory)。

# 指定queryset
category = serializers.PrimaryKeyRelatedField(queryset=CourseCategory.objects.all(), required=True)

ModelSerializer就更簡單了忘嫉，直接通過映射就好了
??不過這樣只是用戶獲得的只是一個外鍵類別的id荤牍，并不能獲取到詳細(xì)的信息，如果想要獲取到具體信息庆冕，那需要嵌套serializer

category = CourseCategorySerializer()

注意：上面兩種方式康吵，外鍵都是正向取得，下面介紹怎么反向去取愧杯，如涎才，我們需要獲取python這個類別下，有什么課程力九。??首先耍铜，在課程course的model中，需要在外鍵中設(shè)置related_name

class Course(model.Model):
    category = models.ForeignKey(CourseCategory, related_name='courses')

# 反向取課程跌前，通過related_name
# 一對多棕兼，一個類別下有多個課程，一定要設(shè)定many=True
courses = CourseSerializer(many=True)

寫到這里抵乓，外鍵就基本講完了伴挚！還有一個小問題：我們在上面提到ModelSerializer需要解決的第二個問題中，其實還有一種情況灾炭，就是某個字段屬于指定model茎芋，但不能獲取到相關(guān)數(shù)據(jù)。
??假設(shè)現(xiàn)在是一個多級分類的課程蜈出，例如田弥，編程語言-->python-->python入門學(xué)習(xí)課程，編程語言與python屬于類別铡原，另外一個屬于課程偷厦，編程語言類別是python類別的一個外鍵商叹，而且屬于同一個model，實現(xiàn)方法：

parent_category = models.ForeignKey('self', null=True, blank=True, 
                    verbose_name='父類目別',
                    related_name='sub_cat')

現(xiàn)在獲取編程語言下的課程只泼，顯然無法直接獲取到python入門學(xué)習(xí)這個課程剖笙，因為它們兩沒有外鍵關(guān)系。SerializerMethodField( )也可以解決這個問題请唱，只要在自定義的方法中實現(xiàn)相關(guān)的邏輯即可弥咪！

courses = SerializerMethodField()
def get_courses(self, obj):
    all_courses = Course.objects.filter(category__parent_category_id=obj.id)
    courses_serializer = CourseSerializer(all_course, many=True, 
                    context={'request': self.context['request']})
    return courses_serializer.data

上面的例子看起來有點(diǎn)奇怪，因為我們在SerializerMethodField()嵌套了serializer十绑，就需要自己進(jìn)行序列化酪夷，然后再從data就可以取出json數(shù)據(jù)。
??可以看到傳遞的參數(shù)是分別是：queryset孽惰，many=True多個對象晚岭，context上下文。這個context十分關(guān)鍵勋功，如果不將request傳遞給它坦报，在序列化的時候，圖片與文件這些Field不會再前面加上域名狂鞋，也就是說片择，只會有/media/img...這樣的路徑！