Rest framework 學習（1）序列化

序列化定義

將一種對象的狀態信息裝換成可以存儲或者可以傳輸形式的過程。比如將模型類轉換成JSON數據,整個過程將序列化(序列化和反序列化執行的過程相似的,也就是可以封裝代碼)

創建新的APP

python manage.py startapp snippets

• 配置app

# 配置
INSTALLED_APPS = (
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
)

寫一個代碼片段model 帶代碼高亮

# snippets/models.py
# pygment 用於代碼高亮

from django.db import models
from pygments.lexers import get_all_lexers  # 詞法分析程序
from pygments.styles import get_all_styles  # 高亮樣式


LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted((item, item) for item in get_all_styles())


class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')
    code = models.TextField()
    linenos = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ('created',)

代碼段模型創建初始遷移，並首次同步數據庫。

python manage.py makemigrations snippets
python manage.py migrate

創建幾個代碼片段

# 進入shell
python manage.py shell

# 創建代碼片段對象

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

snippet = Snippet(code='foo = "bar"\n')
snippet.save()

snippet = Snippet(code='print("hello, world")\n')
snippet.save()

# 來看看序列化其中一個實例

serializer = SnippetSerializer(snippet)
serializer.data
# {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}

# 已將模型實例轉換爲Python本機數據類型
content = JSONRenderer().render(serializer.data)
content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'

# 反序列化是類似的 首先，我們將流解析爲Python本機數據類型

import io

stream = io.BytesIO(content)
data = JSONParser().parse(stream)


# 本機數據類型還原爲完全填充的對象實例

serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
# <Snippet: Snippet object>

# 查詢多少對象時，需要設置many=True

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

使用ModelSerializers

這是我們建議採用的模式，與Django提供Form類和ModelForm類的方式相同，REST框架包括Serializer類和ModelSerializer類。現在我們用ModelSerializers重構snippets/serializers.py

。。。
class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ('id', 'title', 'code', 'linenos', 'language', 'style')
。。。

 打開shell 我們驗證一下：

from snippets.serializers import SnippetSerializer
serializer = SnippetSerializer()
print(repr(serializer))

## repr() 函數將對象轉化爲供解釋器讀取的形式
# SnippetSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    title = CharField(allow_blank=True, max_length=100, required=False)
#    code = CharField(style={'base_template': 'textarea.html'})
#    linenos = BooleanField(required=False)
#    language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
#    style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...

 ModelSerializer 在這裏主要做兩件事：

• 自動確定的字段集。
• 簡單默認實現create()和update()方法

使用Serializer編寫常規Django視圖

編輯snippets/views.py文件，並添加以下內容

# snippets/views.py

from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@csrf_exempt  # 跳過csrf認證
def snippet_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return JsonResponse(serializer.data, safe=False)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)


@csrf_exempt
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

添加snippets/urls.py

# snippets/urls.py

from django.urls import path
from snippets import views

# root-snippets/
urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]

修改tutorial/urls.py

urlpatterns = [
    path('', include(router.urls)),
    # 包含默認登錄和註銷,身份驗證
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
    path('root-snippets/', include('snippets.urls')),
]

啓動項目，這裏可以用Postman測試也可以直接通過瀏覽器訪問。

訪問：
http://127.0.0.1:8000/root-snippets/snippets/

http://127.0.0.1:8000/root-snippets/snippets/2/

訪問結果如下：

個人感受：

這部分相對與採用rest 框架的View來說， 直接使用django.http.JsonResponse+django.core.serializers（以前我就是這樣乾的）能實現更加靈活的自定義接口API。

現在對rest-framework 和直接JsonResponse自己封裝的json格式response的區別不太清楚。

前者可能對比較規範的model開發接口會方便些，複雜些的估計夠嗆（目前學的還不深入），但採用的設計思想都是一樣的，都是有瀏覽器發ajax請求，服務器不在返回渲染好的html以及模型數據了，而是json數據，將渲染的任務給了瀏覽器，這也是前後端分離的原理。