後臺的數據多之後臺類的對象存在,通過序列化後,就能夠格式化成能返回給前臺的數據前端
models.pypython
from django.db import models # Create your models here. class User(models.Model): CHOICE_SEX = ((0, '男'), (1, '女')) name = models.CharField(max_length=64) age = models.IntegerField(default=0) height = models.DecimalField(max_digits=5, decimal_places=2, default=0) icon = models.ImageField(upload_to='icon', default='default.png') sex = models.IntegerField(choices=CHOICE_SEX, default=0) # pwd = models.CharField(max_length=64,default='123456') class Meta: db_table = 'ob_user' verbose_name = '用戶表' verbose_name_plural = verbose_name def __str__(self): return self.name
api/urls.pygit
from django.conf.urls import url, include from . import views urlpatterns = [ url(r'^user/$', views.UserAPIView.as_view()), url(r'^user/(?P<pk>\d+)/$', views.UserAPIView.as_view()), ]
settings.py數據庫
# 規定用戶上傳的靜態文件都在這個media文件夾下 MEDIA_URL='/media/' MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
LANGUAGE_CODE = 'zh-hans' TIME_ZONE = 'Asia/Shanghai' USE_I18N = True USE_L10N = True USE_TZ = False
#返回的數據類型 return Response({ 'status': 1, 'msg': '單查 error' })
from . import models from rest_framework.views import APIView from rest_framework.response import Response from django.conf import settings class UserAPIView(APIView): def get(self, request, *args, **kwargs): print(kwargs) pk = kwargs.get('pk') print(pk) if pk: # ORM操做數據庫拿到資源數據 # 格式化成能返回給前臺的數據(序列化) # 返回格式化後的數據 user_obj = models.User.objects.filter(pk=pk).first() if not user_obj: return Response({ 'status': 1, 'msg': '單查 error' }) # 完成序列化 user_data = { 'name': user_obj.name, 'age': user_obj.age, 'height': user_obj.height, 'sex': user_obj.get_sex_display(), 'icon': 'http://127.0.0.1:8000%s%s' % (settings.MEDIA_URL, user_obj.icon), } # class MySerializer: pass # user_data = MySerializer(user_obj) return Response({ 'status': 0, 'msg': '單查 ok', 'results': user_data }) # 羣查 user_query = models.User.objects.all() if not user_query: return Response({ 'static': 7, 'msg': '請求錯誤', }) # 完成序列化 user_list_data = [] for user_obj in user_query: user_list_data.append( { 'name': user_obj.name, 'age': user_obj.age, 'height': user_obj.height, 'sex': user_obj.get_sex_display(), 'icon': 'http://127.0.0.1:8000%s%s' % (settings.MEDIA_URL, user_obj.icon), } ) # class MySerializer: pass # user_list_data = MySerializer(user_query, many=True) return Response({ 'status': 0, 'msg': '羣查 ok', 'results': user_list_data })
1、視圖類的三步操做
1)ORM操做數據庫拿到資源數據
2)格式化(序列化)成能返回給前臺的數據
3)返回格式化後的數據django
2、視圖類的序列化操做
1)直接將要序列化的數據傳給序列化類
2)要序列化的數據若是是單個對象,序列化的參數many爲False,數據若是是多個對象(list,queryset)序列化的參數many爲Truejson
3、序列化類
1)model了中要反饋給前臺的字段,在序列化類中要進行聲明,屬性名必須就是model的字段名,且Field類型也要保持一致(不須要明確規則)
2)model了中不須要反饋給前臺的字段,在序列化類中不須要聲明(省略)
3)自定義序列化字段用 SerializerMethodField() 做爲字段類型,該字段的值來源於 get_自定義字段名(self, obj) 方法的返回值api
# @Author : OceanSkychen # @File : serializers.py from rest_framework import serializers class UserSerializer(serializers.Serializer): # model已有的屬性字段 # 若是要參與序列化,名字必定要與model的屬性同名 # 若是不參與序列化的model屬性,在序列化類中不作聲明 name = serializers.CharField() age = serializers.IntegerField() height = serializers.DecimalField(max_digits=5, decimal_places=2) # sex = serializers.IntegerField() # 自定義序列化字段,序列化的屬性值由方法來提供, # 方法的名字:固定爲 get_屬性名, # 方法的參數:序列化對象,序列化的model對象 # 強烈建議自定義序列化字段名不要與model已有的屬性名重名 gender = serializers.SerializerMethodField() def get_gender(self, obj): # print('>>>>>>', type(self)) # print('>>>>>>', type(obj)) return obj.get_sex_display()
from rest_framework.views import APIView from rest_framework.response import Response from . import models, serializers from rest_framework import status class UserAPIView(APIView): # 單查羣查 def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if pk: # ORM操做數據庫拿到資源數據 # 格式化成能返回給前臺的數據(序列化) # 返回格式化後的數據 user_obj = models.User.objects.filter(pk=pk).first() if not user_obj: return Response({ 'status': 1, 'msg': '單查 error' }) # 完成序列化 user_ser = serializers.UserSerializer(user_obj, many=False) user_data = user_ser.data return Response({ 'status': 0, 'msg': '單查 ok', 'results': user_data }) # 羣查 user_query = models.User.objects.all() # 完成序列化 user_list_data = serializers.UserSerializer(user_query, many=True).data return Response({ 'status': 0, 'msg': '羣查 ok', 'results': user_list_data })
1、視圖類的三步操做
1)從請求對象中拿到前臺的數據
2)校驗前臺數據是否合法
3)反序列化成後臺Model對象與數據庫交互服務器
2、視圖類的反序列化操做
1)將要反序列化的數據傳給序列化類的data參數
2)要反序列化的數據若是是單個字典,反序列化的參數many爲False,數據若是是多個字典的列表,反序列化的參數many爲Truerestful
3、反序列化類
1)系統的字段,能夠在Field類型中設置系統校驗規則(name=serializers.CharField(min_length=3))
2)required校驗規則絕對該字段是必校驗仍是可選校驗字段(默認required爲True,數據庫字段有默認值或能夠爲空的字段required能夠賦值爲False)
3)自定義的反序列字段,設置系統校驗規則同系統字段,可是須要在自定義校驗規則中(局部、全局鉤子)將自定義反序列化字段取出(返回剩餘的數據與數據庫交互)
4)局部鉤子的方法命名 validate_屬性名(self, 屬性的value),校驗規則爲 成功返回屬性的value 失敗拋出校驗錯誤的異常
5)全局鉤子的方法命名 validate(self, 全部屬性attrs),校驗規則爲 成功返回attrs 失敗拋出校驗錯誤的異常app
# @Author : OceanSkychen # @File : serializers.py from rest_framework import serializers from . import models class UserDeserializer(serializers.Serializer): # 系統校驗規則 # 系統必須反序列化的字段 # 序列化屬性名不是必須與model屬性名對應,可是與之對應會方便序列化將校驗經過的數據與數據庫進行交互 name = serializers.CharField(min_length=3, max_length=64, error_messages={ 'required': '姓名必填', 'min_length': '過短', }) pwd = serializers.CharField(min_length=3, max_length=64) # 系統可選的反序列化字段:沒有提供不進行校驗(數據庫中有默認值或能夠爲空),提供了就進行校驗 age = serializers.IntegerField(min_value=0, max_value=150, required=False) # 自定義反序列化字段:必定參與校驗,且要在校驗過程當中,將其從入庫的數據中取出,剩餘與model對應的數據纔會入庫 re_pwd = serializers.CharField(min_length=3, max_length=64) # 自定義校驗規則:局部鉤子,全局鉤子 # 局部鉤子:validate_字段名(self, 字段值) # 規則:成功返回value,失敗拋異常 def validate_aaa(self, value): if 'g' in value.lower(): raise serializers.ValidationError('名字中不能有g') return value # 全局鉤子:validate(self, 全部校驗的數據字典) # 規則:成功返回attrs,失敗拋異常 def validate(self, attrs): # 取出聯合校驗的字段們:須要入庫的值須要拿到值,不須要入庫的須要從校驗字段中取出 pwd = attrs.get('pwd') re_pwd = attrs.pop('re_pwd') if pwd != re_pwd: raise serializers.ValidationError({'re_pwd': '兩次密碼不一致'}) return attrs # create重寫,完成入庫 def create(self, validated_data): return models.User.objects.create(**validated_data)
# 單增 def post(self, request, *args, **kwargs): # 從請求對象中拿到前臺的數據 # 校驗前臺數據是否合法 # 反序列化成後臺Model對象與數據庫交互 request_data = request.data # 反序列化目的:封裝數據的校驗過程,以及數據庫交互的過程 user_ser = serializers.UserDeserializer(data=request_data) # 調用反序列化的校驗規則:系統規則,自定義規則(局部鉤子,全局鉤子) result = user_ser.is_valid() if result: # 校驗經過,能夠與數據庫進行交互:增(create),改(update) user_obj = user_ser.save() return Response({ 'status': 0, 'msg': 'ok', 'results': serializers.UserSerializer(user_obj).data }) else: # 校驗失敗,返回錯誤信息 return Response({ 'status': 1, 'msg': user_ser.errors }, status=status.HTTP_400_BAD_REQUEST)
Django REST framework中的Serializer使用類來定義,須繼承自rest_framework.serializers.Serializer。
例如,咱們已有了一個數據庫模型類BookInfo
class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名稱') bpub_date = models.DateField(verbose_name='發佈日期', null=True) bread = models.IntegerField(default=0, verbose_name='閱讀量') bcomment = models.IntegerField(default=0, verbose_name='評論量') image = models.ImageField(upload_to='booktest', verbose_name='圖片', null=True)
咱們想爲這個模型類提供一個序列化器,能夠定義以下:
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名稱', max_length=20) bpub_date = serializers.DateField(label='發佈日期', required=False) bread = serializers.IntegerField(label='閱讀量', required=False) bcomment = serializers.IntegerField(label='評論量', required=False) image = serializers.ImageField(label='圖片', required=False)
注意: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(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 |
write_only | 代表該字段僅用於反序列化輸入,默認False |
required | 代表該字段在反序列化時必須輸入,默認True |
default | 反序列化時使用的默認值 |
allow_null | 代表該字段是否容許傳入None,默認False |
validators | 該字段使用的驗證器 |
error_messages | 包含錯誤編號與錯誤信息的字典 |
label | 用於HTML展現API頁面時,顯示的字段名稱 |
help_text | 用於HTML展現API頁面時,顯示的字段幫助提示信息 |
定義好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) 先查詢出一個圖書對象
from booktest.models import BookInfo book = BookInfo.objects.get(id=2)
2) 構造序列化器對象
from booktest.serializers import BookInfoSerializer serializer = BookInfoSerializer(book)
3)獲取序列化數據
經過data屬性能夠獲取序列化後的數據
serializer.data # {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}
4)若是要被序列化的是包含多條數據的查詢集QuerySet,能夠經過添加many=True參數補充說明
book_qs = BookInfo.objects.all() serializer = BookInfoSerializer(book_qs, many=True) serializer.data # [OrderedDict([('id', 2), ('btitle', '天龍八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飛狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西遊記'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]
使用序列化器進行反序列化時,須要對數據進行驗證後,才能獲取驗證成功的數據或保存成模型類對象。
在獲取反序列化的數據前,必須調用is_valid()方法進行驗證,驗證成功返回True,不然返回False。
驗證失敗,能夠經過序列化器對象的errors屬性獲取錯誤信息,返回字典,包含了字段和字段的錯誤。若是是非字段錯誤,能夠經過修改REST framework配置中的NON_FIELD_ERRORS_KEY來控制錯誤字典中的鍵名。
驗證成功,能夠經過序列化器對象的validated_data屬性獲取數據。
在定義序列化器時,指明每一個字段的序列化類型和選項參數,自己就是一種驗證行爲。
如咱們前面定義過的BookInfoSerializer
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名稱', max_length=20) bpub_date = serializers.DateField(label='發佈日期', required=False) bread = serializers.IntegerField(label='閱讀量', required=False) bcomment = serializers.IntegerField(label='評論量', required=False) image = serializers.ImageField(label='圖片', required=False)
經過構造序列化器對象,並將要反序列化的數據傳遞給data構造參數,進而進行驗證
from booktest.serializers import BookInfoSerializer data = {'bpub_date': 123} serializer = BookInfoSerializer(data=data) serializer.is_valid() # 返回False serializer.errors # {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]} serializer.validated_data # {} data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.errors # {} serializer.validated_data # OrderedDict([('btitle', 'python')])
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)
若是以爲這些還不夠,須要再補充定義驗證行爲,可使用如下三種方法:
對<field_name>
字段進行驗證,如
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" ... def validate_btitle(self, value): if 'django' not in value.lower(): raise serializers.ValidationError("圖書不是關於Django的") return value
測試
from booktest.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}
在序列化器中須要同時對多個字段進行比較驗證時,能夠定義validate方法來驗證,如
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" ... def validate(self, attrs): bread = attrs['bread'] bcomment = attrs['bcomment'] if bread < bcomment: raise serializers.ValidationError('閱讀量小於評論量') return attrs
測試
from booktest.serializers import BookInfoSerializer data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20} s = BookInfoSerializer(data=data) s.is_valid() # False s.errors # {'non_field_errors': [ErrorDetail(string='閱讀量小於評論量', code='invalid')]}
在字段中添加validators選項參數,也能夠補充驗證行爲,如
def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("圖書不是關於Django的") class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名稱', max_length=20, validators=[about_django]) bpub_date = serializers.DateField(label='發佈日期', required=False) bread = serializers.IntegerField(label='閱讀量', required=False) bcomment = serializers.IntegerField(label='評論量', required=False) image = serializers.ImageField(label='圖片', required=False)
測試:
from booktest.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}
前面的驗證數據成功後,咱們可使用序列化器來完成數據反序列化的過程.這個過程能夠把數據轉成模型類對象.
能夠經過實現create()和update()兩個方法來實現。
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" ... def create(self, validated_data): """新建""" return BookInfo(**validated_data) def update(self, instance, validated_data): """更新,instance爲要更新的對象實例""" instance.btitle = validated_data.get('btitle', instance.btitle) instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date) instance.bread = validated_data.get('bread', instance.bread) instance.bcomment = validated_data.get('bcomment', instance.bcomment) return instance
若是須要在返回數據對象的時候,也將數據保存到數據庫中,則能夠進行以下修改
class BookInfoSerializer(serializers.Serializer): """圖書數據序列化器""" ... def create(self, validated_data): """新建""" return BookInfo.objects.create(**validated_data) def update(self, instance, validated_data): """更新,instance爲要更新的對象實例""" instance.btitle = validated_data.get('btitle', instance.btitle) instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date) instance.bread = validated_data.get('bread', instance.bread) instance.bcomment = validated_data.get('bcomment', instance.bcomment) instance.save() return instance
實現了上述兩個方法後,在反序列化數據的時候,就能夠經過save()方法返回一個數據對象實例了
book = serializer.save()
若是建立序列化器對象的時候,沒有傳遞instance實例,則調用save()方法的時候,create()被調用,相反,若是傳遞了instance實例,則調用save()方法的時候,update()被調用。
from db.serializers import BookInfoSerializer data = {'btitle': '封神演義'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 封神演義> from db.models import BookInfo book = BookInfo.objects.get(id=2) data = {'btitle': '倚天劍'} serializer = BookInfoSerializer(book, data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 倚天劍> book.btitle # '倚天劍'
1) 在對序列化器進行save()保存時,能夠額外傳遞數據,這些數據能夠在create()和update()中的validated_data參數獲取到
# request.user 是django中記錄當前登陸用戶的模型對象 serializer.save(owner=request.user)
2)默認序列化器必須傳遞全部required的字段,不然會拋出驗證異常。可是咱們可使用partial參數來容許部分字段更新
# Update `comment` with partial data serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)