1. 程式人生 > 實用技巧 >drf之序列化元件

drf之序列化元件

序列化元件:

1. 序列化,序列化器會把模型物件轉換成字典,經過response以後變成json字串
2. 反序列化,把客戶端傳送過來的資料,經過request以後變成字典,序列化器可以把字典轉成模型
3. 反序列化,完成資料校驗功能

序列化類的欄位

欄位欄位構造方式
BooleanField BooleanField() 有true、false
NullBooleanField NullBooleanField() 有null、true、false三個值
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(max_length=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=)

選項引數:

引數名稱作用
max_length 最大長度
min_lenght 最小長度
allow_blank 是否允許為空
trim_whitespace 是否截斷空白字元
max_value 最小值
min_value 最大值

通用引數:

引數名稱說明
read_only 表明該欄位僅用於序列化輸出,預設False,設定為True的時候,可以看到,但是修改的時候不需要傳值
write_only 表明該欄位僅用於反序列化輸入,預設False,設定為True的時候,不可以看到,但是修改的時候需要傳值
required 表明該欄位在反序列化時必須輸入,預設True
default 反序列化時使用的預設值
allow_null 表明該欄位是否允許傳入None,預設False
validators 該欄位使用的驗證器
error_messages 包含錯誤編號與錯誤資訊的字典
label 用於HTML展示API頁面時,顯示的欄位名稱
help_text 用於HTML展示API頁面時,顯示的欄位幫助提示資訊

Serializer:

1、寫一個序列化類,繼承serializer。ser.py檔案如下:

class BookSerializers(serializers.Serializer):
   #對book表字段進行序列化 b_id
=serializers.CharField(read_only=True) name=serializers.CharField(max_length=10) price=serializers.DecimalField(max_digits=4,decimal_places=2) author=serializers.CharField(max_length=8,validators=['check_author']) #author欄位的校驗函式 def check_author(data): if data.startswitch('NQ'): raise ValidationError('名字不能以NQ開頭') else: return data #重寫update方法,對資料修改的時候,需要用到 def update(self, instance, validated_data): instance.name=validated_data.get('name') instance.price=validated_data.get('price') instance.author=validated_data.get('author') instance.save() return instance #重寫create方法,新增資料的時候需要重寫 def create(self, validated_data): instance=Book.objects.create(**validated_data) return instance #區域性鉤子 def validate_author(self, data): if data.startswith('sb'): raise ValidationError('作者名字不能以sb開頭') else: return data #全域性鉤子 def validate(self, validate_data): price=validate_data.get('price') if float(price)>10: return validate_data else: raise ValidationError('價格不能低於10元')

2、views檔案下的檢視類程式碼:

#實現書籍的單條資料查詢和書籍的修改,刪除
class BookView(APIView):
    def get(self,request,pk):
        res = MyRespont()
        book=Book.objects.filter(pk=pk).first()
        #序列化book物件
        book_ser=BookSerializers(book)
        res.get_dic['data']=book_ser.data
        return Response(res.get_dic)

    def put(self,request,pk):
        res = MyRespont()  #MyRespont()是自己封裝的類
        book=Book.objects.filter(pk=pk).first()

        book_ser=BookSerializers(instance=book,data=request.data)
        if book_ser.is_valid():
            book_ser.save()
            res.get_dic['data']=book_ser.data
        else:
            res.get_dic['statu']=101
            res.get_dic['msg']=book_ser.errors
            res.get_dic['data'] = book_ser.data
        return Response(res.get_dic)

    def delete(self,request,pk):
        res=MyRespont().get_dic
        Book.objects.filter(pk=pk).first().delete()
        res['msg']='刪除成功'
        return Response(res)


#實現書籍的新增,查詢所有
class BooksView(APIView):
  # 查詢所有書籍
def get(self,request): res=MyRespont() books=Book.objects.all() #序列化多條資料,需要設定many=True books_ser=BookSerializers(books,many=True) res.get_dic['data']=books_ser.data return Response(res.get_dic) def post(self,request): res=MyRespont() book_ser=BookSerializers(data=request.data) if book_ser.is_valid(): book_ser.save() res.get_dic['msg']='新增成功' res.get_dic['data']=book_ser.data else: res.get_dic['msg'] = '新增失敗' res.get_dic['data'] = book_ser.errors return Response(res.get_dic)

3、路由檔案urls下的程式碼:

from django.conf.urls import url
from django.contrib import admin
from app01 import views
from rest_framework.routers import DefaultRouter
#可以處理檢視的路由器
router = DefaultRouter()
#將路由器中註冊檢視集合
router.register('book', views.BooksViewSet)
#將路由器中的所有路由資訊追加到django的路由表中
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^books/',views.BooksView.as_view()),
    url(r'^book/(?P<pk>\d+)$',views.BookView.as_view()),
]

urlpatterns += router.urls

Serializer高階用法:

'''
serializers的高階用法:
  source的使用
  SerializerMethodField()的使用
'''
#1、可以改欄位名字,此時xxx是返回給前端的欄位名,欄位對應內容還是book.title
xxx = serializers.CharField(source='title')
#2、可以.跨表,此時返回的資料是public表的出版社郵箱。
publish = serializers.CharField(source='publish.email')
#3、可以執行方法
pub_date = serializers.CharField(source='test')
#test是Book表模型中的方法
'''
SerializerMethodField()的使用
它需要有個配套方法,方法名叫get_欄位名,返回值就是要顯示的東西
'''
authors = serializers.SerializerMethodField()  
def get_authors(self, instance):
    # book物件
    authors = instance.authors.all()  # 取出所有作者
    ll = []
    for author in authors:
        ll.append({'name': author.name, 'age': author.age})
    return ll

ModelSerializer(序列化模型)

'''
#模型序列化
不需要重新寫update方法和crater方法
'''
class BookModelSerializer(ModelSerializer):
    class Meta:
        model = Book
        fields = "__all__" #對book表中的所有欄位進行序列化
        fields=('name','price','author')#只對指定欄位進行序列化
        exclude=('name',) #除了name欄位外,其他欄位都進行序列化
        extra_kwargs = {
            # 類似於這種形式name=serializers.CharField(max_length=16,min_length=4)
            'price': {'write_only': True},
        }