Python Web后端开发中的增查改删处理

前言

一、创建 mgr应用目录

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

2.1定义函数

1.新建customer文件，定义dispatcher函数

2.总路由文件 bysms/urls.py 中定义

3.mgr下添加 urls.py 路由文件

三、列出客户

四、添加客户

五、临时取消 CSRF 校验

六、修改客户信息

七、删除客户

八、和前端集成

前言

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

一、创建 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 开发服务器：

python manage.py runserver 0.0.0.0:8080

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

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