一、說明

自己一是想跟上潮流二是習慣于直接干三是沒有人可以請教，由于這三點經常搞得要死要活。之前只簡單看過沒寫過Diango，沒看過Django REST framework，今天一步到位直接上又撞上了南墻。在此記一下以備忘，也希望對后來者能有所幫助。本文相當于Django REST framework官方文檔的重新實現(xiàn)。

1.1 Django是什么

Django是當下流行的一個python語言的web框架，類似于java的struts2,（如果struts2太舊不懂那也可以理解為spring boot）。

1.2 Django REST framework是什么

Django類似于struts2，也就是說其是mvc模式的，也就是說其v是前后端強耦合的，但現(xiàn)在都講REST。

Django REST framework就是Django的REST化庫，用于實現(xiàn)Django的REST化。

二、開發(fā)環(huán)境搭建

2.1 安裝PyCharm+conda

參見：http://www.dbjr.com.cn/article/205782.htm

2.2 在pycharm中新建項目

2.3 安裝Django和Django REST framework

依次點開pycharm----菜單----file----settings----project----project interpreter，安裝django、djangorestframework、pygments、pytest四個包

djangorestframework在conda-forge源中，如果找不到djangorestframework那應該是沒添加conda-forge源的原因（中科大：https://mirrors.ustc.edu.cn/anaconda/cloud/conda-forge/）

或者通過系統(tǒng)菜單開啟“Anaconda Prompt”用pip安裝，命令如下

conda activate DjangoTest

pip install django
pip install djangorestframework
pip install pygments
pip install pytest

2.4 創(chuàng)建真正的Django項目

在前面中我們已經創(chuàng)建了名稱為DjangoTest的項目，但要注意只是我們把名字命名為DjangoTest而已改項目到現(xiàn)在為止其實與Django無關。

Django項目需要通過django-admin命令來創(chuàng)建；所以我們要到項目所在文件夾下將現(xiàn)有DjangoTest文件夾刪掉，然后用django-admin命令來重新創(chuàng)建DjangoTest。

（前邊創(chuàng)建的DjangoTest的意義，是更多是為了創(chuàng)建DjangoTest虛擬環(huán)境。雖然有點繞，但這是我針對Scrapy和Django這種雞和蛋問題能想到的最好辦法）

而django-admin命令的位置，我們可以借助conda env list來查看DjangoTest虛擬環(huán)境所在的目錄，然后加上\Scripts\django-admin.exe即是其位置。比如我的操作如下：

cd F:\PycharmProjects
F:
rmdir /s /q DjangoTest
conda env list
D:\Language\Miniconda3\envs\DjangoTest\Scripts\django-admin.exe startproject DjangoTest

創(chuàng)建完成后目錄結構如下：

 2.5 設置運行環(huán)境

django項目需要通過python manage.py runserver形式運行，我們也需要配置成該形式。

依次點擊菜單----Run----Edit Configurations----左上角+號----Python，添加運行環(huán)境

Name----環(huán)境名稱，自己隨便填

Script path----manage.py所在的路徑，改成自己的

Parameters----runserver，ip和端口如果需要直接追加在后邊即可

一定要注意，后續(xù)不要隨便在一個頁面就右鍵run/debug，而是不管修改什么文件在什么位置都要run/debug上邊這個環(huán)境，不然運行不起來。（一直報錯django.core.exceptions.ImproperlyConfigured: Requested setting INSTALLED_APPS, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.）

2.6 將Django REST framework集成到Django

上邊我們創(chuàng)建了Django項目，至于Django REST framework只是安裝并沒有開始操作，下邊我們開始使用Django REST framework對上邊的Django項目進行REST化改造。

一般而言我們不直接大幅修改Django項目的文件，而是新建一個APP實現(xiàn)REST，然后原來的Django項目文件只寫一些包含命令即可。所謂APP可以理解為子文件夾或者一個新線程。

為了更好地證明我們的程序是能很好運行的，我這里會改用和官方例子不一樣的名稱包括app名稱model名稱等；并盡可能說明每個操作本質是在做什么。 

2.6.1 注冊drest和Django REST framework

首先，進入到manage.py所在目錄新建一個app（注意打開的cmd中的python和pycharm中的python同為python3不然運行就報錯了，我這里直接在前邊的Anaconda Prompt中運行）：

python manage.py startapp drest

向Django項目注冊drest，由于Django REST framework其實也以app形式注入所以也一同注冊。編緝DjangoTest/settings.py找到INSTALLED_APPS追加以下內容：

'rest_framework',
'drest.apps.DrestConfig',

 2.6.2 路由關聯(lián)調整等

在drest目錄下新建urls.py（內容先不寫），然后在DjangoTest/usrls.py中包含它；即DjangoTest/usrls.py修改如下：

from django.contrib import admin
from django.urls import path
from django.conf.urls import url, include

urlpatterns = [
  path('admin/', admin.site.urls),
  url(r'^', include('drest.urls')),
]

另外我們再在drest創(chuàng)建一個序列化文件serializers.py（內容先不寫）用于后續(xù)序列化。到此我們的環(huán)境算搭建好了，項目目錄結構如下：

三、開發(fā)示例

前邊我們已搭好了環(huán)境，創(chuàng)建了一個app----drest，這里我們即在drest上進行開發(fā)。

3.1 創(chuàng)建model

這里的model不是mvc中的m，而是orm中的表對應的類，稍后數據庫的表就是根據這個類來建立的。

編緝drest/model.py，寫入以下內容：

from django.db import models

# Create your models here.
class Test(models.Model):
  # 這些在創(chuàng)建數據表時是表字段，括號內為字段對應屬性
  # 不過注意default屬性，是說在實例化這個類時該字段默認是這個值，創(chuàng)建數據表時并不會當作一行括入數據表
  created = models.DateTimeField(auto_now_add=True)
  username = models.CharField(max_length=100, default='ls', )
  password = models.CharField(max_length=100, default='toor', )

  class Meta:
    # 這個表示數據表的內容按創(chuàng)建時間排序
    ordering = ('created',)

3.2 創(chuàng)建model對應序例化類

編寫drest/serializers.py寫入以下內容：

from rest_framework import serializers
from drest.models import Test

class TestSerializer(serializers.ModelSerializer):
  class Meta:
    # 此處指明本序列化對應的model
    model = Test
    # 此處指明從model對應數據表中讀出哪些字段
    # id字段我們在model中并沒指明應該是框架自己創(chuàng)建的
    # 另外我們還創(chuàng)建了created字段，但這里我們不加讀取他，當然你要讀取加上即可
    fields = ('id', 'username', 'password')

3.3 設定路由

編緝drest/urls.py，寫入以下內容：

from django.conf.urls import url
from drest import views

urlpatterns = [
  url(r'^test/$', views.test),
]

3.4 創(chuàng)建視圖

在REST中視圖已經不是mvc中的html與后端代碼混淆的那種.jsp或.aspx頁面了，所指的是生成并返回json/xml結果的東西（反而更像mvc中的m）。

在路由中我們設定鏈接test，指向test視圖；我們這里來實現(xiàn)test視圖，該視圖使用3.2中的序列化類讀取3.1中對應的數據表的所有內容實現(xiàn)序列化并返回。

from django.http import JsonResponse
from rest_framework.parsers import JSONParser
from drest.serializers import Test
from drest.serializers import TestSerializer

def test(request):
  """
  List all code snippets, or create a new snippet.
  """
  if request.method == 'GET':# 這里應該是model對應的所有字段
    test_obj = Test.objects.all()
    # 序列化
    serializer = TestSerializer(test_obj, many=True)
    # 返回
    return JsonResponse(serializer.data, safe=False)

  # 此框架想實現(xiàn)原始REST的思想，如果是post就保存到數據庫，這里暫且保留雖然我覺得不實用
  elif request.method == 'POST':
    data = JSONParser().parse(request)
    serializer = TestSerializer(data=data)
    if serializer.is_valid():
      serializer.save()
      return JsonResponse(serializer.data, status=201)
    return JsonResponse(serializer.errors, status=400)

在沒有if代碼對get/post等方法都進行同樣的響應，如果要區(qū)分那就在在如if request.method == 'POST':分支內編寫響應代碼即可。為方便post測試附上requests和curl post提交的形式。

requests post提交json：

import requests

url = "http://127.0.0.1:8000/test1/"
data = {"username":"ls", "password":"toor"}
requests.post(url,json=data)

curl post提交json：

curl -H "Content-Type:application/json" -X POST --data '{"username": "ls","password":"toor"}' http://127.0.0.1:8000/test1/

3.5 創(chuàng)建model對應數據表

我們在3.1中就建好了model，在官方文檔中都是建好model就建對應數據表的，但是由于我對實現(xiàn)步驟做了調整如果在3.1中就建表，會因程序有錯誤而創(chuàng)建失敗，所以我們只能到這里才創(chuàng)建類據表。

指示在數據庫中創(chuàng)建model對應的表，進入到manage.py目錄執(zhí)行以下命令：

python manage.py makemigrations drest
python manage.py migrate

執(zhí)行完成后在manage.py同級目錄下可以看到一個db.sqlite3文件，該文件是一個sqlite3數據庫。

使用SQLiteStudio等工具打開，可以看到有一個dres_test的表其字段“created”、“username”、“password”正是我們在model中配置好的。

3.6 向drest_test表插入數據

我們一直說TestSerializer的作用是讀取drest_test表的所有內容并序列化，在上一步中我們創(chuàng)建好了drest_test；但是我們在model的注釋中也說過創(chuàng)建數據表時不會向表中插入數據，也就是說此時drest_test表雖創(chuàng)建好了但其是一個空表是沒數據的，此時如果我們運行程序并訪問test鏈接那返回是空值。所以我們要向drest_test表中插入數據。

進入到manage.py目錄執(zhí)行以下命令啟動shell：

python manage.py shell

為了更好地說明model中default的作用我們插入兩條數據：

from drest.models import Test
from drest.serializers import TestSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

test = Test()
test.save()
test = Test(username='root')
test.save()

此時查看drest_test表的內容，如下所示正是我們插入的兩條數據：

3.7 啟動程序并訪問

我們前面說過運行django項目run的一定要是我們2.5中設置的運行環(huán)境，現(xiàn)在雖加項目進行了如些復雜的操作但項目還是django項目還是要運行那個環(huán)境（名為django）。

pycharm切換到manage.py----在其上右鍵----選擇Run ‘django'，程序成功運行如下：

 我們看到監(jiān)聽地址為http://127.0.0.1:8000/，而我們設置的路由是test

打開瀏覽器訪問http://127.0.0.1:8000/test，結果如下圖，返回結果與預期完全一致： 

四、更直接的restful方法

上一大節(jié)的示例依據官方示例整理而成，整個流程雖然還算清楚，但給人一種復雜感。

比如為什么一定要我創(chuàng)建model、為什么一定要我創(chuàng)建model序列化類、為什么一定要創(chuàng)建數據表、為什么一定要向數據表中插入數據----總而言之，為什么一定要涉及數據庫？

并非所有請求都要涉及數據庫的，或者我就只想一個請求過來然后直接簡單地返回隨便一個數，那該如何寫呢。以test1請求為例。

4.1 設定路由

編緝drest/urls.py，寫入以下內容：

from django.conf.urls import url
from drest import views

urlpatterns = [
  url(r'^test1/$', views.test1),
]

4.2 創(chuàng)建視圖

編緝drest/views.py追加test1方法：

def test1(request):
  # 要獲取客戶端提交的參數，可通過request.GET["param_name"]或request.POST["param_name"]獲取，param_name是要獲取的參數名
  # 但要另外注意對post提交django默認是有csrf token校驗的，要注意怎么處理好，最簡單的方法是到setting.py中將'django.middleware.csrf.CsrfViewMiddleware'項注釋掉
  # username = request.GET["username"]
  # username = request.POST["username"]
  # 如果前端通過json格式提交，那么需要使用以下方式獲取參數
  # data = JSONParser().parse(request)
  # username = data["username"]
  # Django執(zhí)行sql語句，第一種方法是依賴model的model.objects.get()等方法
  # 獲取第一條記錄
  # Test.objects.get(username="ls")
  # 獲取記錄集合
  # Test.objects.filter(username="ls")
  # Django執(zhí)行sql語句，第二種方法是直接執(zhí)行sql語句
  # cursor = connection.cursor()
  # cursor.execute('select * from drest_test')
  # 獲取第一條記錄
  # row = cursor.fetchone()
  # 遍歷數據表所有記錄
  # for row in cursor.fetchall():
  #   print(f"{row}")
  dict1 = {}
  dict1["id"] = 1
  dict1["result"] = "success"
  # JsonResponse()最正規(guī)的就是給他傳一個字典
  # 上一節(jié)傳的serializer.data是一個列表反而不那么正規(guī)，傳非字典參數要設置safe=False
  return JsonResponse(dict1)

4.3 啟動程序并訪問

和3.7一樣運行manage.py，然后訪問http://127.0.0.1:8000/test1/，結果如下圖。

五、使用總結

在第三大節(jié)上，網上現(xiàn)有的很多教和感覺就是自己把英文版翻譯成中文，但又不能很好地解框架到底在做什么，尤其是model其實是用來創(chuàng)建數據表和序列化類本質是讀取數據表的內容并返回這兩點，導致翻譯得似是而非反而讓人更難理解框架的本質。

如第四大節(jié)所言，我們寫程序工作總不會都是讀取數據庫表然后返回。增刪改查尤其是跨數據表的增刪改查還是得在dao層中另行實現(xiàn)，作為竄聯(lián)的邏輯代碼則在view上實現(xiàn)；view調用dao，dao調用model。

更多關于 Django framework 相關教程請點擊下面的相關鏈接

最新評論