第二部分：初見RESTful

RESTful風格下，比較充分的利用了HTTP1.1標準中規定的集中請求方式

l GET:用於提交向伺服器獲取資料的請求

l POST:用於提交資料給伺服器進行資料更新的請求

l PUT:用於提交資料給伺服器進行資料新增的請求

l DELETE:用於提交給伺服器刪除條件資料的請求

在這樣的處理風格下，目前更加適合專案開發並且成本較低的一種比較流行的開發模式：專案的前後端分離結構模型的優勢更加突出，透過RESTful風格指定的格式定義不同的資料處理的請求方式，後端只需要提供對應的介面，前端檢視部分負責呼叫進行資料展示；資料的互動全部交給非同步呼叫進行實現，能最大程度的發揮專案開發過程中開發人員的能力！

下面是一個基本案例[參考官方文件整理]，瞭解一下RESTful在Django專案中的主要工作流程和操作方式

1. 建立案例專案

執行命令建立專案

django-admin startproject myrest_ex02

進入專案根目錄中，執行命令建立一個應用：用於進行程式碼檔案描述的應用

django-admin startapp snippet

2. 配置開發環境

確保在django的基礎上，安裝restful需要的各種依賴包

pip install django
pip install djangorestframework # restful框架
pip install pygments  # 程式碼檔案描述模組

開啟專案配置檔案settings.py，新增rest框架模組和我們的應用程式模組

INSTALLED_APPS =   [
       ……
'rest_framework',    
'snippet.apps.SnippetConfig',
   ]

3. 資料模型定義

開啟snippet應用的資料模型定義模組models.py，新增一個定義程式碼描述的型別

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 snippet
python manage.py migrate

4. 資料模型序列化處理

在snippet應用中，新增一個序列化模組，用於進行資料模型物件的序列化操作

在myrest_ex02/snippet/目錄下建立檔案：serializers.py

rest_framework serializers
   .models Snippet, LANGUAGE_CHOICES, STYLE_CHOICES
   
   SnippetSerializer(serializers.ModelSerializer):
     Meta:
         model = Snippet
         fields = [, , , , , ]

PS:序列化操作本身提供了一個基本介面serializers.Serializer型別，但是這個型別本身提供的實現機制不利於程式碼的複用性，封裝的ModelSerializer更加友好的提供了序列化的實現方式更加友好！

5. 互動測試

已經開發好了一部分序列互動的部分，我們接下來就可以透過django shell互動方式進行資料物件的序列化操作測試了，測試透過之後繼續開發檢視部分程式碼。

執行命令進入shell互動視窗

python   manage.py shell

(1) 在互動視窗中匯入我們需要的模組

from   snippet.models import Snippet
from   snippet.serializers import SnippetSerializer
from   rest_framework.renderers import JSONRenderer
from   rest_framework.parsers import JSONPerser

(2) 新增資料到資料庫

>>> snippet = Snippet(code='name =   "jerry"')
>>> snippet.save()
>>> 
>>> snippet2 = Snippet(code='print("hello   python")')
>>> snippet.save()

(3) 序列化物件資料

>>> serializer = SnippetSerializer(snippet2)
>>> serializer.data
{'id': None, 'title': '', 'code':   'print("hello python")', 'linenos': False, 'language': 'python',   'sty
le': 'friendly'}
 
>>> serializer2 = SnippetSerializer(snippet)
>>> serializer2.data
{'id': 3, 'title': '', 'code': 'name =   "jerry"', 'linenos': False, 'language': 'python', 'style': 'frie
ndly'}

(4) JSON格式化序列資料

透過JSON格式化渲染的資料，就是最終可以互動的JSON字串資料

>>> content = JSONRenderer().render(serializer.data)
>>> 
>>> content
b'{"id":null,"title":"","code":"print(\"hello   python\")","linenos":false,"language":"python","style":
"friendly"}'

(5) 反序列化JSON資料

反序列化在WEB應用中，主要用於解析檢視客戶端提交的JSON資料，轉化成資料物件之後進行CRUD的操作

>>> from django.utils.six import BytesIO
>>> 
>>> stream = BytesIO(content)
>>> data = JSONParser().parse(stream)
>>> 
>>> serializer = SnippetSerializer(data=data)
>>> serializer.is_valid()
True
>>> 
>>> serializer.save()

(6) 序列化查詢結果集

在實際專案操作過程中，我們在Django專案裡面操作的往往都是QuerySet查詢結果集

對於查詢結果集的序列化處理方式如下

>>> res =   SnippetSerializer(Snippet.objects.all(), many=True)
>>> res.data
[OrderedDict([('id', 1), ('title', ''),   ('code', 'foo="bar"n'), ('linenos', False), ('language', 'pyth
on'), ('style', 'friendly')]),   OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello   world")n'
), ('linenos', False), ('language',   'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title
', ''), ('code', 'name =   "jerry"'), ('linenos', False), ('language', 'python'), ('style',   'friendly')])
, OrderedDict([('id', 4), ('title', ''),   ('code', 'print("hello python")'), ('linenos', False), ('langu
age', 'python'), ('style', 'friendly')])]

6. 檢視函式：API資料介面

經過第5步的互動測試，已經完成了對資料的處理方式的基本操作測試

接下來開始開發檢視互動函式，也就是給其他呼叫的客戶端提供資料的API介面函式！

(1) 資料列表介面函式——snippet_list

開啟專案應用的檢視處理模組：snippet.views

開發資料列表介面函式

from django.http import HttpResponse,   JsonResponse
from django.views.decorators.csrf import   csrf_exempt
from rest_framework.renderers import   JSONRenderer
from rest_framework.parsers import   JSONParser
 
from .models import Snippet
from .serializers import   SnippetSerializer
 
@csrf_exempt
def snippet_list(reuqest):
 
if request.method   == “GET”:
    # 查詢所有資料
      snippets = Snippet.objects.all()
    # 序列化資料
      serializers = SnippetSerializer(snippets, many=True)
    # 返回資料           return JsonResponse(serializers.data,   safe=False)
 
elif request.method   == “POST”:
    # 解析提交的資料
    data   = JSONParser().parse(request)
    # 反解析序列資料
    serializers   = SnippetSerializer(data=data)
    # 驗證並儲存資料
    if   serializers.is_valid():
          serializers.save()
    # 返回檢視頁面
    return JsonResponse(serializer.data,   status=201)
return JsonResponse(serializer.errors, status=400)

(2) 物件資料增刪改API介面函式開發

定義一個介面函式，透過request.method直接判斷進行不同請求方式的處理

@csrf_exempt
def snippet_detail(request, pk):
# 首先查詢得到資料物件
try:
      snippet = Snippet.objects.get(pk=pk)
except   Snippet.DoesNotExist:
      return HttpResponse(status=404)
 
# 獲取單個資料的操作
if   request.method == “GET”:
    # 序列化資料
    serializers   = SnippetSerializer(snippet)
      return JsonResponse(serializers.data)
 
# 提交資料的操作
elif   request.method == “PUT”:
    # 反解析資料
      data = JSONParser().parse(request)
    # 序列化操作
      serializers = SnippetSerializer(data=data)
    # 驗證有效性並儲存
    if   serializers.is_valid():
          serializers.save()
        # 返回檢視處理介面
          return JsonResponse(serializers.data)
    return   JsonResponse(serializers.errors, status=400)
 
# 刪除資料的操作
elif   request.method ==”DELETE”:
      snippet.delete()
      return HttpResponse(status=204)