Python从0到100（四十七）：前后端分离架构实践

前言： 零基础学Python：Python从0到100最新最全教程。 想做这件事情很久了，这次我更新了自己所写过的所有博客，汇集成了Python从0到100，共一百节课，帮助大家一个月时间里从零基础到学习Python基础语法、Python爬虫、Web开发、 计算机视觉、机器学习、神经网络以及人工智能相关知识，成为学习学习和学业的先行者！
欢迎大家订阅专栏：零基础学Python：Python从0到100最新最全教程！

前言

如果采用前后端分离的架构开发， 后端几乎不负责任何展现界面的工作，只负责对数据进行管理 。
数据的管理，主要就是：响应前端的请求， 对数据资源的 增加、修改、删除、列出 。

一、创建mgr应用目录

在Django项目中，每个应用都是独立的，拥有自己的模型（models）、视图（views）、模板（templates）等。为了管理管理员用户的相关请求，我们将创建一个新的应用mgr。

1. 在项目的根目录下执行以下命令来创建应用：

   python manage.py startapp mgr
   

   

2. 创建后，将看到一个新的mgr文件夹，包含了Django应用的标准结构。
   

二、添加处理请求模块和URL路由

随着应用的发展，views.py可能会变得庞大且难以维护。因此，我们将不同类型的请求分散到不同的文件中处理。例如，创建customer.py来专门处理客户数据的增删改查。前面，我们都是在views.py 里面定义函数，处理 http请求的。但是可以想象， 以后，这个mgr应用要处理很多类型的http请求。都用这个views.py 就会让这个文件非常的庞大， 不好维护。所以，我们可以用不同的 py 文件处理不同类型的http请求。比如，这里我们可以新增一个文件 customer.py， 专门处理 客户端对 customer 数据的操作。将来如果客户端有对其他类型数据的操作， 比如 order 数据， 我们就可以添加 orders.py 来处理。

2.1 定义分发器函数

在customer.py中，我们定义一个dispatcher函数，根据HTTP请求类型和请求体中的参数，将请求分发到不同的处理函数。

# customer.py
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.2 配置URL路由

我们需要在bysms/urls.py中包含mgr应用的路由，并在mgr/urls.py中定义具体的路由。

# bysms/urls.py
from django.urls import path, include

urlpatterns = [
    # 省略其他路由...
    path('api/mgr/', include('mgr.urls')),
]

# mgr/urls.py
from django.urls import path
from . import customer

urlpatterns = [
    path('customers', customer.dispatcher),
]

这样，就表示 凡是 API 请求url为 /api/mgr/customers 的，都交由 我们上面定义的dispatch函数进行分派处理。

三、实现增删改查功能

3.1 列出客户

根据接口文档，列出客户数据接口，后端返回的数据格式如下：

{
    "ret": 0,
    "retlist": [
        {
            "address": "江苏省常州武进市白云街44号",
            "id": 1,
            "name": "武进市 袁腾飞",
            "phonenumber": "13886666666"
        },
        
        {
            "address": "北京海淀区",
            "id": 4,
            "name": "北京海淀区代理 蔡国庆",
            "phonenumber": "13990123456"
        }
    ]              
}

这里我们无需 将数据库中获取的数据 转化为 供浏览器展示的HTML。在前后端分离的开发架构中，如何展示数据，那是前端的事情。我们后端只需要根据接口文档， 返回原始数据就行。我们可以使用如下的函数来返回数据库的所有的 客户数据信息：

# 在customer.py中定义list_customers函数
from common.models import Customer

def list_customers(request):
    qs = Customer.objects.values()
    retlist = list(qs)
    return JsonResponse({'ret': 0, 'retlist': retlist})

3.2 添加客户

通常数据资源的 增查改删 里面的 增 就是 添加，对应的就是添加数据资源。
根据接口文档，添加客户数据接口，前端提供的客户数据格式如下：

{
    "action":"add_customer",
    "data":{
        "name":"武汉市桥西医院",
        "phonenumber":"13345679934",
        "address":"武汉市桥西医院北路"
    }
}

我们可以使用如下的函数来处理：

# 在customer.py中定义add_customer函数
def add_customer(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表里面的记录。

3.3 修改客户信息

数据资源的 增查改删 里面的 改 就是 改动，对应的就是修改数据资源。
根据接口文档，修改客户数据接口，前端提供的数据格式如下：

{
    "action":"modify_customer",
    "id": 6,
    "newdata":{
        "name":"武汉市桥北医院",
        "phonenumber":"13345678888",
        "address":"武汉市桥北医院北路"
    }
}

# 在customer.py中定义modify_customer函数
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})

3.4 删除客户

数据资源的 增查改删 里面的 删 就是 删除，对应的就是删除数据资源。
根据接口文档，删除客户数据接口，前端只需要提供要删除的客户的ID。
数据格式如下：

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

# 在customer.py中定义delete_customer函数
def delete_customer(request):
    customer_id = request.params['id']
    try:
        customer = Customer.objects.get(id=customer_id)
        customer.delete()
    except Customer.DoesNotExist:
        return JsonResponse({'ret': 1, 'msg': f'id 为`{customer_id}`的客户不存在'})

四、临时取消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’ 即可。

五、与前端集成

最后，我们将后端服务与前端集成，确保它们能够无缝协作：

现在，请打开 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 开发服务器：

python manage.py runserver 0.0.0.0:8080

然后我们打开浏览器，输入如下网址：

http://127.0.0.1:8080/mgr/index.html#/

添加用户：

这是前端开发的 客户管理界面，可以在界面上进行客户的 增查改删操作， 这些操作会触发API 请求发送给我们的后端服务。