我家自动化

这个屌丝很懒，什么也没留下！

热门标签

四十五、python学习之Djnago(DRF框架一):介绍、序列化/反序列化及环境搭建_djanfo 结合proto 文件写serializers和services

作者：我家自动化 | 2024-08-22 06:46:10

踩

djanfo 结合proto 文件写serializers和services

引入DjangoRESTframework

一、Web应用模式:

在开发Web应用中,有两种应用模式:

前后端不分离
前后端分离

1.前后端不分离:

在这里插入图片描述
在前后端不分离的应用模式中,前端页面看到的效果都是有后端控制的,有后端渲染页面重定向,也就是后端需要控制前端的展示,前后端的耦合度很高.
这种应用模式比较适合纯网页应用,但是当后端对接App时,App可能并不需要后端返回一个html页面,而仅仅是数据本身,所以你后端原本返回页面的接口不再适合前端的App应用,为了对接App后端好需要开发一套接口.

2.前后端分离:

在这里插入图片描述
在前后端分离的应用模式中,后端仅返回前端所需要的数据,不再渲染html页面,不再控制前端效果. 至于前端用户看到什么效果,从后端请求的数据如何加载到前端中,都由自己决定,网页有网页的处理方式,App有App的处理方式,但无论那种前端,所需要的数据基本相同,后端仅需要开发一套逻辑对外提供数据即可.
在前后端分离的应用模式中,前端和后端的耦合度相对较低.
在前后端分离的应用模式中,我们通常将后端开发的每一个视图都成为一个***接口***,或者***API***,前端通过访问接口来对数据就你增删改查.

二、认识ERSTful风格:

在前后端分离的应用模式中,后端API接口如何定义

例如对于后端数据库中保存了商品的信息,前端可能需要对商品数据进行增删改查,那相应的每个操作后端都需要提供一个API接口:

1.POST/ add-goods : 增加商品
2.POST /delete-goods : 删除商品
3.POST /update-goods : 修改商品
1. GET /get-goods : 查询商品信息
  对于接口的请求方式与路径,每个后端开发人员可能都有自己的定义方式，风格迥异。
  是否存在一种统一的定义方式，被广大开发人员接受认可的方式呢？
  这就是被普遍采用的API的RESTful设计风格。

二、RESTful设计风格:

1. 域名:

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单, 不会有进一步扩展,可以考虑放在主域名下.

https://example.org/api

2.版本(versioning)

应该将API的版本号放在URL中:

http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo

另一种做法是, 将版本号放在HTTP头信息中,但不如放在URL方便和直观.Github采用这种方式.
因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）：

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0

3. 路径(Endpoint):

路径又称"终点"(endpoint), 表示API的具体网址,每个网址代表一种资源(resource)

3.1 资源作为网址,只能有名词,不能有动词,而且所有的名词往往与数据库的表名对应.

举例来说，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

对于一个简洁结构，你应该始终用名词。此外，利用的HTTP方法可以分离网址中的资源名称的操作。

GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH（或）PUT /products/4 ：将更新产品 4

3.HTTP动词:

对于资源的具体操作类型,有HTTP动词表示
常用的HTTP动词有下面四个(括号里是对应的SQL命令).

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。

还有三个不常用的HTTP动词。

PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
下面是一些例子:

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园（上传文件）
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

4.过滤信息(Filtering)

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

6.状态码:

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - []：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作
401 Unauthorized - []：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - []：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里或这里。

7.错误处理(Error handling)

如果状态码是4xx, 服务器就是向用户返回出错信息. 一般来说, 返回的信息中将error作为键名,出错信息作为键值即可.

{
	error:"Invalid API key"
}
1
2
3

8.返回结果:

针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

9.其他:

服务器返回的数据格式,应该尽量使用JSON, 避免使用XML

三、使用Djnago开发REST接口:

我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口，来理解REST API的开发。

在此案例中，前后端均发送JSON格式数据。

# views.py

from datetime import datetime

class BooksAPIVIew(View):
    """
    查询所有图书、增加图书
    """
    def get(self, request):
        """
        查询所有图书
        路由：GET /books/
        """
        queryset = BookInfo.objects.all()
        book_list = []
        for book in queryset:
            book_list.append({
                'id': book.id,
                'btitle': book.btitle,
                'bpub_date': book.bpub_date,
                'bread': book.bread,
                'bcomment': book.bcomment,
                'image': book.image.url if book.image else ''
            })
        return JsonResponse(book_list, safe=False)

    def post(self, request):
        """
        新增图书
        路由：POST /books/ 
        """
        json_bytes = request.body
        json_str = json_bytes.decode()
        book_dict = json.loads(json_str)

        # 此处详细的校验参数省略

        book = BookInfo.objects.create(
            btitle=book_dict.get('btitle'),
            bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
        )

        return JsonResponse({
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date,
            'bread': book.bread,
            'bcomment': book.bcomment,
            'image': book.image.url if book.image else ''
        }, status=201)


class BookAPIView(View):
    def get(self, request, pk):
        """
        获取单个图书信息
        路由： GET  /books/<pk>/
        """
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        return JsonResponse({
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date,
            'bread': book.bread,
            'bcomment': book.bcomment,
            'image': book.image.url if book.image else ''
        })

    def put(self, request, pk):
        """
        修改图书信息
        路由： PUT  /books/<pk>
        """
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        json_bytes = request.body
        json_str = json_bytes.decode()
        book_dict = json.loads(json_str)

        # 此处详细的校验参数省略

        book.btitle = book_dict.get('btitle')
        book.bpub_date = datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
        book.save()

        return JsonResponse({
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date,
            'bread': book.bread,
            'bcomment': book.bcomment,
            'image': book.image.url if book.image else ''
        })

    def delete(self, request, pk):
        """
        删除图书
        路由： DELETE /books/<pk>/
        """
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        book.delete()

        return HttpResponse(status=204)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# urls.py

urlpatterns = [
    url(r'^books/$', views.BooksAPIVIew.as_view()),
    url(r'^books/(?P<pk>\d+)/$', views.BookAPIView.as_view())
]
1
2
3
4
5
6

测试
使用Postman测试上述接口

1）获取所有图书数据

GET 方式访问 http://127.0.0.1:8000/books/，返回状态码200，数据如下:

[
    {
        "id": 1,
        "btitle": "射雕英雄传",
        "bpub_date": "1980-05-01",
        "bread": 12,
        "bcomment": 34,
        "image": ""
    },
    {
        "id": 2,
        "btitle": "天龙八部",
        "bpub_date": "1986-07-24",
        "bread": 36,
        "bcomment": 40,
        "image": ""
    },
    {
        "id": 3,
        "btitle": "笑傲江湖",
        "bpub_date": "1995-12-24",
        "bread": 20,
        "bcomment": 80,
        "image": ""
    },
    {
        "id": 4,
        "btitle": "雪山飞狐",
        "bpub_date": "1987-11-11",
        "bread": 58,
        "bcomment": 24,
        "image": ""
    },
    {
        "id": 5,
        "btitle": "西游记",
        "bpub_date": "1988-01-01",
        "bread": 10,
        "bcomment": 10,
        "image": "booktest/xiyouji.png"
    },
    {
        "id": 6,
        "btitle": "水浒传",
        "bpub_date": "1992-01-01",
        "bread": 10,
        "bcomment": 11,
        "image": ""
    },
    {
        "id": 7,
        "btitle": "红楼梦",
        "bpub_date": "1990-01-01",
        "bread": 0,
        "bcomment": 0,
        "image": ""
    }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

2）获取单一图书数据

GET 访问 http://127.0.0.1:8000/books/5/ ，返回状态码200，数据如下:

{
    "id": 5,
    "btitle": "西游记",
    "bpub_date": "1988-01-01",
    "bread": 10,
    "bcomment": 10,
    "image": "booktest/xiyouji.png"
}
1
2
3
4
5
6
7
8

GET 访问http://127.0.0.1:8000/books/100/，返回状态码404

3）新增图书数据

POST 访问http://127.0.0.1:8000/books/，发送JSON数据：

{
    "btitle": "三国演义",
    "bpub_date": "1990-02-03"
}
1
2
3
4

返回状态码201，数据如下:

{
    "id": 8,
    "btitle": "三国演义",
    "bpub_date": "1990-02-03",
    "bread": 0,
    "bcomment": 0,
    "image": ""
}
1
2
3
4
5
6
7
8

4）修改图书数据

PUT 访问http://127.0.0.1:8000/books/8/，发送JSON数据：

{
    "btitle": "三国演义（第二版）",
    "bpub_date": "1990-02-03"
}
1
2
3
4

返回状态码200，数据如下:

{
    "id": 8,
    "btitle": "三国演义（第二版）",
    "bpub_date": "1990-02-03",
    "bread": 0,
    "bcomment": 0,
    "image": ""
}
1
2
3
4
5
6
7
8

5）删除图书数据
DELETE 访问http://127.0.0.1:8000/books/8/，返回204状态码

四、明确REST接口开发的核心任务:

1. 明确REST接口开发的核心任务:

在开发REST API接口时,视图中做的最主要的三件事:

将请求的数据(json数据)转换为模型类对象
操作数据库
将模型类对象转化为相应数据(json格式)

2. 序列化(Serialization)与反序列化(Deserialize):

将程序中的一个数据结构类型转换为其他格式(字典、JSON、XML等), 例如将Django中模型类对象转换为JSON字符串,这个转换过程我们称为序列化

例如:

queryset = BookInfo.objects.all()
book_list = []
# 序列化
for book in queryset:
book_list.appemd({
	'id':book.id,
	'btitle': book.btitle,
	'bpub_date': book.bpub_date,
    'bread': book.bread,
     'bcomment': book.bcomment
})
return JsonResponse(book_list, safe = False)
1
2
3
4
5
6
7
8
9
10
11
12

反之,将其他格式(字典、JSON、XML等)转换为程序中的数据, 例如将JSON字符串转化成Django中的模型类对象,这个过程我们称为是反序列化。
如:

json_bytes = request.body
json_str = json_btyes.decode()

# 反序列化
book_dict = json.loads(json_str)
book = BookInfo.objects.create(
	btitle = book_dict.get("btitle"),
	bpub_date = datetime.strptime(book_dict.get("bpub_date"), '%Y-%m-%d').date()
)
1
2
3
4
5
6
7
8
9

在开发REST API时, 视图中要频繁的进行序列化与反序列化的编写.

2. 总结:

在开发REST API接口时, 我们在视图中需要做的最核心的事情是:

将数据库数据序列化为前端锁足要的格式,并返回
将前端发送的数据反序列化为模型类对象,并保存到数据库中

三、Django REST framework 简介:

在序列化与反序列化时，虽然操作的数据不尽相同，但是执行的过程却是相似的，也就是说这部分代码是可以复用简化编写的。
在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的：
- 增：校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 删：判断要删除的数据是否存在 -> 执行数据库删除
- 改：判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 查：查询数据库 -> 将数据序列化并返回
  *** Django REST framework可以帮助我们简化上述两部分代码的编写大大提高REST API 的开大速度 ***

1.认识Django REST framework:

在这里插入图片描述
Django REST framework框架是一个用于构建Web API的强大而又灵活的工具. 通常简称为DRF框架或 REST framework框架.

*** 特点 ***

提供了定义序列化器serializer的方法,可以快速根据Django ORM或者其他库自动序列化/反序列化;
提供了丰富的类视图、Mixin扩展类、简化视图的编写;
丰富的定制层级: 函数视图、类视图、视图集合到自动生成API,满足各种需求;
多中身份认证和权限认证方式的支持;
内置了限流系统;
直观的API web界面;
可扩展性, 插件丰富

*** 资料 ***

环境搭建

一、环境安装与配置

DRF框架需要以下依赖:

Python(2.1、3.2~6)
Django(1.10、1.11、1.20)

1.安装:

pip install djajngorestframework
1

2. 添加rest_framework应用:

我们利用在Django框架学习中创建的demo工程，在settings.py的INSTALLED_APPS中添加’rest_framework’。

INSTALLED_APPS = [
    ...
    'rest_framework',
]
1
2
3
4

接下来就可以使用DRF进行开发了。

二、DRF框架的简单应用:

1.创建序列化器:

在booktest应用中新建serializers.py用于保存该应用的序列化器。
创建一个BookInfoSerializer用于序列化与反序列化:

class BookInfoSerializer(serializers.ModelSerializer):
	"""图书数据序列化器"""
	class Meta:
		model = BookInfo
		fields = '__all__'
1
2
3
4
5

model : 指明该序列化器处理的数据字段从模型类BookInfo参考生成
fillds: 指明该序列化器包含模型类中的哪些字段, 'all’指明包含所有字段.

2.编写视图:

在booktest应用的views.py中创建BookInfoViewSet, 这是一个视图集合。

from rest_framework.viewsets import ModelViewSet
from .serializers import BookInfoSerializer
from .models import BookInfo

class BookInfo ViewSet(ModelViewSet):	
	queryset = BookInfo.objects.all()
	serializer_class = BookInfoSerializer
1
2
3
4
5
6
7

queryset : 指明视图集在查询数据时使用的查询集
serializer_class : 指明该视图在进行序列化/反序列化时使用的序列化器

3.定义路由:

在booktest应用的urls.py中定义路由信息:

from . import views
from rest_framework.routers import DefaultRouter

urlpatterns = [
	...
]

router = DefaultRouter()	# 可以处理视图的路由器
router.register(r"books", views.BookInfoViewSet)	# 想路由器中注册视图集

urlpatterns += router.urls	# 将路由器中的所有路由信息追加到django的路由列表中
1
2
3
4
5
6
7
8
9
10
11

4.运行测试:

运行当前程序(与运行django一样)

python manage.py runserver
1

在浏览器中输入网址127.0.0.1:8000, 可以看到DRF提供的API Web浏览页面
在这里插入图片描述

1)点击链接127.0.0.1:8000/books/ 可以访问获取所有数据的接口，呈现如下页面：
2）在页面底下表单部分填写图书信息，可以访问添加新图书的接口，保存新书：

点击POST后，返回如下页面信息：
3）在浏览器中输入网址127.0.0.1:8000/books/1/，可以访问获取单一图书信息的接口（id为1的图书），呈现如下页面：
4）在页面底部表单中填写图书信息，可以访问修改图书的接口：
点击PUT，返回如下页面信息：
5）点击DELETE按钮，可以访问删除图书的接口：

返回，如下页面：

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家自动化/article/detail/1015181