Python Web後端開發中的增查改刪處理

2022-08-24 18:03:46

前言

如果採用前後端分離的架構開發，後端幾乎不負責任何展現介面的工作，只負責對資料進行管理。資料的管理，主要就是：響應前端的請求，對資料資源的增加、修改、刪除、列出。

一、建立 mgr應用目錄

介面檔案明確說明了，這是針對管理員使用者的請求。

前面我們已經為 銷售員使用者專門建立了一個應用 sales 來處理相關的請求。

所以，我們可以再為 管理員使用者專門建立一個應用 mgr 來處理相關的請求進入根目錄，執行:

python manage.py startapp mgr

此時我們會看見，目錄下已將建立了一個mgr的資料夾：

二、新增處理請求模組和 url 路由

前面，我們都是在views.py 裡面定義函數，處理 http請求的。但是可以想象，以後，這個mgr應用要處理很多型別的http請求。都用這個views.py 就會讓這個檔案非常的龐大，不好維護。所以，我們可以用不同的 py 檔案處理不同型別的http請求。比如，這裡我們可以新增一個檔案 customer.py，專門處理使用者端對 customer 資料的操作。將來如果使用者端有對其他型別資料的操作，比如 order 資料，我們就可以新增 orders.py 來處理。從介面檔案，我們可以發現對資源的增刪改查操作，都是同一個URL，都是 /api/mgr/medicine 。 而且我們發現，不同的操作請求，使用不同的 HTTP 請求方法，比如新增是POST，查詢是 GET，修改是 PUT，刪除是 DELETE。且請求的引數中都有 action 參數列明這次請求的操作具體是什麼。 注意： Django 的 url路由功能 不支援根據 HTTP 請求的方法和請求體裡面的引數進行路由。 就是不能像下面這樣，來根據請求是 post 還是 get 來路由：

path('customers/', 'app.views.list_customer', method='get'),
path('customers/', 'app.views.add_customer',  method='post'),

那麼大家想想該怎麼辦？

2.1定義函數

一種方式是：自己編寫一個函數，來根據 http請求的型別和請求體裡面的引數分發（或者說路由）給不同的函數進行處理。

1.新建customer檔案，定義dispatcher函數

我們可以在 customer.py 中定義如下 dispatcher 函數：

def dispatcher(request):
    # 將請求引數統一放入request 的 params 屬性中，方便後續處理

    # GET請求 引數在url中，同過request 物件的 GET屬性獲取
    if request.method == 'GET':
        request.params = request.GET

    # POST/PUT/DELETE 請求 引數 從 request 物件的 body 屬性中獲取
    elif request.method in ['POST','PUT','DELETE']:
        # 根據介面，POST/PUT/DELETE 請求的訊息體都是 json格式
        request.params = json.loads(request.body)


    # 根據不同的action分派給不同的函數進行處理
    action = request.params['action']
    if action == 'list_customer':
        return listcustomers(request)
    elif action == 'add_customer':
        return addcustomer(request)
    elif action == 'modify_customer':
        return modifycustomer(request)
    elif action == 'del_customer':
        return deletecustomer(request)

    else:
        return JsonResponse({'ret': 1, 'msg': '不支援該型別http請求'})

首先建立一個custome.py檔案：

該函數把請求訊息中的引數統一放入到 request請求物件的params 屬性中。params 屬性被做成一個 dict 型別 ，方便後面的處理常式來獲取訊息中的引數。然後 dispatch函數再根據請求的型別和 action 引數的值決定由那個函數具體處理該請求訊息。比如 action 引數 為 ‘add_customer’ 的請求就由 addcustomer 函數進行處理。當然在檔案的開頭，我們需要先匯入 JsonResponse 和 json 的定義，像下面這樣：

from django.http import JsonResponse
import json

接下來，根據 API 介面，我們發現凡是 API 請求url為 /api/mgr/customers 的，都屬於客戶相關的API，都應該交由我們上面定義的dispatch函數進行分派處理。那麼我們需要在Django的url路由檔案中加入對應的路由。

2.總路由檔案 bysms/urls.py 中定義

我們應該在總路由檔案 bysms/urls.py 中定義瞭如下部分：

    # 凡是 url 以 api/mgr  開頭的，
    # 都根據 mgr.urls 裡面的 子路由表進行路由
    path('api/mgr/', include('mgr.urls')),

3.mgr下新增 urls.py 路由檔案

在 mgr 目錄下面新增 urls.py 路由檔案，並加入如下宣告即可，如下所示：

from django.urls import path
from mgr import customer
urlpatterns = [
    path('customers', customer.dispatcher),
]

這樣，就表示凡是 API 請求url為 /api/mgr/customers 的，都交由我們上面定義的dispatch函數進行分派處理。

三、列出客戶

通常資料資源的增查改刪裡面的查就是檢視，對應的就是列出資料資源。

根據介面檔案，列出客戶資料介面，後端返回的資料格式如下：

{
    "ret": 0,
    "retlist": [
        {
            "address": "江蘇省常州武進市白雲街44號",
            "id": 1,
            "name": "武進市 袁騰飛",
            "phonenumber": "13886666666"
        },

        {
            "address": "北京海淀區",
            "id": 4,
            "name": "北京海淀區代理 蔡國慶",
            "phonenumber": "13990123456"
        }
    ]
}

這裡我們無需將資料庫中獲取的資料轉化為供瀏覽器展示的HTML。在前後端分離的開發架構中，如何展示資料，那是前端的事情。我們後端只需要根據介面檔案，返回原始資料就行。我們可以使用如下的函數來返回資料庫的所有的客戶資料資訊：

def listcustomers(request):
    # 返回一個 QuerySet 物件 ，包含所有的表記錄
    qs = Customer.objects.values()

    # 將 QuerySet 物件 轉化為 list 型別
    # 否則不能 被 轉化為 JSON 字串
    retlist = list(qs)

    return JsonResponse({'ret': 0, 'retlist': retlist})

當然在檔案的開頭，我們需要先匯入 Customer 定義，像下面這樣：

# 匯入 Customer 
from common.models import Customer

可以發現，無需轉化資料為HTML，後端的程式碼任務也大大減輕。

四、新增客戶

通常資料資源的增查改刪裡面的增就是新增，對應的就是新增資料資源。根據介面檔案，新增客戶資料介面，前端提供的客戶資料格式如下：

{
    "action":"add_customer",
    "data":{
        "name":"武漢市橋西醫院",
        "phonenumber":"13345679934",
        "address":"武漢市橋西醫院北路"
    }
}

我們可以使用如下的函數來處理：

def addcustomer(request):

    info    = request.params['data']

    # 從請求訊息中 獲取要新增客戶的資訊
    # 並且插入到資料庫中
    # 返回值 就是對應插入記錄的物件 
    record = Customer.objects.create(name=info['name'] ,
                            phonenumber=info['phonenumber'] ,
                            address=info['address'])

    return JsonResponse({'ret': 0, 'id':record.id})

Customer.objects.create 方法就可以新增一條Customer表裡面的記錄。

五、臨時取消 CSRF 校驗

根據介面檔案，新增客戶請求是個Post請求

POST /網站名/api/mgr/signin  HTTP/1.1
Content-Type:   application/x-www-form-urlencoded

注意，預設建立的專案， Django 會啟用一個 CSRF （跨站請求偽造） 安全防護機制。在這種情況下，所有的Post、PUT 型別的請求都必須在HTTP請求頭中攜帶用於校驗的資料。為了簡單起見，我們先臨時取消掉CSRF的校驗機制，等以後有需要再開啟。要臨時取消掉CSRF的校驗機制，非常簡單，只需要在專案的組態檔 bysms/settings.py 中 MIDDLEWARE 設定項裡註釋掉 ‘django.middleware.csrf.CsrfViewMiddleware’ 即可。

六、修改客戶資訊

資料資源的增查改刪裡面的改就是改動，對應的就是修改資料資源。根據介面檔案，修改客戶資料介面，前端提供的資料格式如下：

{
    "action":"modify_customer",
    "id": 6,
    "newdata":{
        "name":"武漢市橋北醫院",
        "phonenumber":"13345678888",
        "address":"武漢市橋北醫院北路"
    }
}

我們可以使用如下的函數來處理：

def modifycustomer(request):

    # 從請求訊息中 獲取修改客戶的資訊
    # 找到該客戶，並且進行修改操作
    
    customerid = request.params['id']
    newdata    = request.params['newdata']

    try:
        # 根據 id 從資料庫中找到相應的客戶記錄
        customer = Customer.objects.get(id=customerid)
    except Customer.DoesNotExist:
        return  {
                'ret': 1,
                'msg': f'id 為`{customerid}`的客戶不存在'
        }


    if 'name' in  newdata:
        customer.name = newdata['name']
    if 'phonenumber' in  newdata:
        customer.phonenumber = newdata['phonenumber']
    if 'address' in  newdata:
        customer.address = newdata['address']

    # 注意，一定要執行save才能將修改資訊儲存到資料庫
    customer.save()

    return JsonResponse({'ret': 0})

七、刪除客戶

資料資源的增查改刪裡面的刪就是刪除，對應的就是刪除資料資源。根據介面檔案，刪除客戶資料介面，前端只需要提供要刪除的客戶的ID。

資料格式如下：

{
    "action":"del_customer",
    "id": 6
}

我們可以使用如下的函數來處理：

def deletecustomer(request):

    customerid = request.params['id']

    try:
        # 根據 id 從資料庫中找到相應的客戶記錄
        customer = Customer.objects.get(id=customerid)
    except Customer.DoesNotExist:
        return  {
                'ret': 1,
                'msg': f'id 為`{customerid}`的客戶不存在'
        }

    # delete 方法就將該記錄從資料庫中刪除了
    customer.delete()
    return JsonResponse({'ret': 0})

八、和前端整合

最終我們的產品前端和後端系統會整合在一起成為一個完整的系統。部署到生產環境（生產環境就是正式的線上運營環境）執行的架構往往比較複雜。我們在後面有專門的章節講述一個比較完整的線上環境如何搭建。

現在，請開啟 bysms/urls.py 檔案，在末尾新增一個：

+  static("/", document_root="./z_dist")

並新增如下宣告

# 靜態檔案服務
from django.conf.urls.static import static

最終，內容如下：

from django.contrib import admin

# 匯入一個include函數
from django.urls import path, include

# 靜態檔案服務
from django.conf.urls.static import static

urlpatterns = [
    path('admin/', admin.site.urls),

    # 凡是 url 以 sales/  開頭的，
    # 都根據 sales.urls 裡面的 子路由表進行路由
    path('sales/', include('sales.urls')),
    # 凡是 url 以 api/mgr  開頭的，
    # 都根據 mgr.urls 裡面的 子路由表進行路由
    path('api/mgr/', include('mgr.urls')),
]  +  static("/", document_root="./z_dist")

最後的+ static("/", document_root="./z_dist")就是在url 路由中加入前端靜態檔案的查詢路徑。這樣如果 http請求的url 不是以 admin/ sales/ api/mgr/ 開頭， Django 就會認為是要存取 z_dist目錄下面的靜態檔案。

好了，現在我們執行如下命令，啟動Django 開發伺服器：