测试博客

Posted 2021-03-26 suwanbin-thought

复习
1
"""
2
1、接口：url+请求参数+响应参数
3
Postman发送接口请求的工具
4
method: GET
5
url: https://api.map.baidu.com/place/v2/search
6
params:
7
ak: 6E823f587c95f0148c19993539b99295
8
region: 上海
9
query: 肯德基
10
output: json
11

12
?
13
2、restful接口规范
14
https://api.baidu.com/v1/books?ordering=-price&limit=3
15
get|post|put|patch|delete
16
{
17
‘status‘: 0,
18
‘msg‘: ‘ok‘,
19
‘results‘: [
20
{
21
‘title‘: ‘西游记‘,
22
‘img‘: ‘https://api.baidu.com/media/xyj.png‘
23
}
24
]
25
}
26
?
27
3、基于规范下原生django接口
28
api/books/ views.Book.as_view()
29
api/books/(?P.*)/ views.Book.as_view()
30

31
class Book(View):
32
def get(self, request, *args, **kwargs):
33
pk = kwagrs.get(‘pk‘)
34
if pk:
35
# 单查
36
else:
37
# 群查
38
def post(self, request, *args, **kwargs):
39
# 增
40
def delete(self, request, *args, **kwargs):
41
# 删
42
def put(self, request, *args, **kwargs):
43
# 整体改
44
def patch(self, request, *args, **kwargs):
45
# 局部改
46

47
4、drf
48
请求的生命周期
49
APIView（as_view）禁用csrf => View（as_view）=> APIView(dispatch) => 视图类的请求方法 => 响应
50
请求模块
51
request完全兼容_request
52
重点：data/query_params
53
渲染模块
54
response数据json与browser两种渲染方式
55
重点：全局配置/局部配置
56
self.render_classes
57
自定义视图类（局部） => APIView视图类 => 自定义drf配置(全局) => drf默认配置
58
"""
复习
解析模块
为什么要配置解析模块
源码入口
全局配置：项目settings.py文件
局部配置：应用views.py的具体视图类
异常模块
为什么要自定义异常模块
源码分析
如何使用：自定义exception_handler函数如何书写实现体
响应模块
响应类构造器：rest_framework.response.Response
使用：常规实例化响应对象
序列化组件：
知识点：Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
Serializer
序列化准备：
序列化使用
反序列化使用

解析模块
为什么要配置解析模块
1
"""
2
1）drf给我们通过了多种解析数据包方式的解析类
3
2）我们可以通过配置来控制前台提交的哪些格式的数据后台在解析，哪些数据不解析
4
3）全局配置就是针对每一个视图类，局部配置就是针对指定的视图来，让它们可以按照配置规则选择性解析数据
5
"""
源码入口
1

APIView类的dispatch方法中

2
request = self.initialize_request(request, *args, **kwargs) # 点进去
3
?
4

获取解析类

5
parsers=self.get_parsers(), # 点进去
6
?
7

去类属性(局部配置) 或 配置文件(全局配置) 拿 parser_classes

8
return [parser() for parser in self.parser_classes]
全局配置：项目settings.py文件
1
REST_FRAMEWORK = {
2
# 全局解析类配置
3
‘DEFAULT_PARSER_CLASSES‘: [
4
‘rest_framework.parsers.JSONParser‘, # json数据包
5
‘rest_framework.parsers.FormParser‘, # urlencoding数据包
6
‘rest_framework.parsers.MultiPartParser‘ # form-date数据包
7
],
8
}
局部配置：应用views.py的具体视图类
1
from rest_framework.parsers import JSONParser
2
class Book(APIView):
3
# 局部解析类配置，只要json类型的数据包才能被解析
4
parser_classes = [JSONParser]
5
pass
异常模块
为什么要自定义异常模块
1
"""
2
1）所有经过drf的APIView视图类产生的异常，都可以提供异常处理方案
3
2）drf默认提供了异常处理方案(rest_framework.views.exception_handler)，但是处理范围有限
4
3）drf提供的处理方案两种，处理了返回异常现象，没处理返回None(后续就是服务器抛异常给前台)
5
4）自定义异常的目的就是解决drf没有处理的异常，让前台得到合理的异常信息返回，后台记录异常具体信息
6
"""
源码分析
1

异常模块：APIView类的dispatch方法中

2
response = self.handle_exception(exc) # 点进去
3
?
4

获取处理异常的句柄(方法)

5

一层层看源码，走的是配置文件，拿到的是rest_framework.views的exception_handler

6

自定义：直接写exception_handler函数，在自己的配置文件配置EXCEPTION_HANDLER指向自己的

7
exception_handler = self.get_exception_handler()
8
?
9

异常处理的结果

10

自定义异常就是提供exception_handler异常处理函数，处理的目的就是让response一定有值

11
response = exception_handler(exc, context)
如何使用：自定义exception_handler函数如何书写实现体
1

修改自己的配置文件setting.py

2
REST_FRAMEWORK = {
3
# 全局配置异常模块
4
‘EXCEPTION_HANDLER‘: ‘api.exception.exception_handler‘,
5
}
1

1）先将异常处理交给rest_framework.views的exception_handler去处理

2

2）判断处理的结果(返回值)response，有值代表drf已经处理了，None代表需要自己处理

3
?
4

自定义异常处理文件exception，在文件中书写exception_handler函数

5
from rest_framework.views import exception_handler as drf_exception_handler
6
from rest_framework.views import Response
7
from rest_framework import status
8
def exception_handler(exc, context):
9
# drf的exception_handler做基础处理
10
response = drf_exception_handler(exc, context)
11
# 为空，自定义二次处理
12
if response is None:
13
# print(exc)
14
# print(context)
15
print(‘%s - %s - %s‘ % (context[‘view‘], context[‘request‘].method, exc))
16
return Response({
17
‘detail‘: ‘服务器错误‘
18
}, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True)
19
return response
响应模块
响应类构造器：rest_framework.response.Response
1
def init(self, data=None, status=None,
2
template_name=None, headers=None,
3
exception=False, content_type=None):
4
"""
5
:param data: 响应数据
6
:param status: http响应状态码
7
:param template_name: drf也可以渲染页面，渲染的页面模板地址（不用了解）
8
:param headers: 响应头
9
:param exception: 是否异常了
10
:param content_type: 响应的数据格式（一般不用处理，响应头中带了，且默认是json）
11
"""
12
pass
使用：常规实例化响应对象
1

status就是解释一堆 数字 网络状态码的模块

2
from rest_framework import status就是解释一堆 数字 网络状态码的模块
3

一般情况下只需要返回数据，status和headers都有默认值

4
return Response(data={数据}, status=status.HTTP_200_OK, headers={设置的响应头})
序列化组件：
知识点：Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
Serializer
序列化准备：
模型层：models.py

1
class User(models.Model):
2
SEX_CHOICES = [
3
[0, ‘男‘],
4
[1, ‘女‘],
5
]
6
name = models.CharField(max_length=64)
7
pwd = models.CharField(max_length=32)
8
phone = models.CharField(max_length=11, null=True, default=None)
9
sex = models.IntegerField(choices=SEX_CHOICES, default=0)
10
icon = models.ImageField(upload_to=‘icon‘, default=‘icon/default.jpg‘)
11
?
12
class Meta:
13
db_table = ‘old_boy_user‘
14
verbose_name = ‘用户‘
15
verbose_name_plural = verbose_name
16
?
17
def str(self):
18
return ‘%s‘ % self.name
后台管理层：admin.py

1
from django.contrib import admin
2
from . import models
3
?
4
admin.site.register(models.User)
配置层：settings.py

1

注册rest_framework

2
INSTALLED_APPS = [
3
# ...
4
‘rest_framework‘,
5]
6
?
7

配置数据库

8
DATABASES = {
9
‘default‘: {
10
‘ENGINE‘: ‘django.db.backends.mysql‘,
11
‘NAME‘: ‘day70‘,
12
‘USER‘: ‘root‘,
13
‘PASSWORD‘: ‘123‘
14
}
15
}
16
?
17

media资源

18
MEDIA_URL = ‘/media/‘ # 后期高级序列化类与视图类，会使用该配置
19
MEDIA_ROOT = os.path.join(BASE_DIR, ‘media‘) # media资源路径
20
?
21

国际化配置

22
LANGUAGE_CODE = ‘zh-hans‘
23
TIME_ZONE = ‘Asia/Shanghai‘
24
USE_I18N = True
25
USE_L10N = True
26
USE_TZ = False
主路由：项目下urls.py

1
urlpatterns = [
2
# ...
3
url(r‘^api/‘, include(‘api.urls‘)),
4
?
5
url(r‘^media/(?P.*)‘, serve, {‘document_root‘: settings.MEDIA_ROOT}),
6]
子路由：应用下urls.py

1
urlpatterns = [
2
url(r‘^users/$‘, views.User.as_view()),
3
url(r‘^users/(?P.*)/$‘, views.User.as_view()),
4]
序列化使用
序列化层：api/serializers.py

1
"""
2
1）设置需要返回给前台 那些model类有对应的 字段，不需要返回的就不用设置了
3
2）设置方法字段，字段名可以随意，字段值有 get_字段名 提供，来完成一些需要处理在返回的数据
4
"""
1

序列化组件 - 为每一个model类通过一套序列化工具类

2

序列化组件的工作方式与django froms组件非常相似

3
from rest_framework import serializers, exceptions
4
from django.conf import settings
5
?
6
from . import models
7
?
8
class UserSerializer(serializers.Serializer):
9
name = serializers.CharField()
10
phone = serializers.CharField()
11
# 序列化提供给前台的字段个数由后台决定，可以少提供，
12
# 但是提供的数据库对应的字段，名字一定要与数据库字段相同
13
# sex = serializers.IntegerField()
14
# icon = serializers.ImageField()
15
?
16
# 自定义序列化属性
17
# 属性名随意，值由固定的命名规范方法提供:
18
# get_属性名(self, 参与序列化的model对象)
19
# 返回值就是自定义序列化属性的值
20
gender = serializers.SerializerMethodField()
21
def get_gender(self, obj):
22
# choice类型的解释型值 get_字段_display() 来访问
23
return obj.get_sex_display()
24
?
25
?
26
icon = serializers.SerializerMethodField()
27
def get_icon(self, obj):
28
# settings.MEDIA_URL: 自己配置的 /media/，给后面高级序列化与视图类准备的
29
# obj.icon不能直接作为数据返回，因为内容虽然是字符串，但是类型是ImageFieldFile类型
30
return ‘%s%s%s‘ % (r‘http://127.0.0.1:8000‘, settings.MEDIA_URL, str(obj.icon))
视图层

1
"""
2
1）从数据库中将要序列化给前台的model对象，或是对个model对象查询出来
3
user_obj = models.User.objects.get(pk=pk) 或者
4
user_obj_list = models.User.objects.all()
5
2）将对象交给序列化处理，产生序列化对象，如果序列化的是多个数据，要设置many=True
6
user_ser = serializers.UserSerializer(user_obj) 或者
7
user_ser = serializers.UserSerializer(user_obj_list, many=True)
8
3）序列化 对象.data 就是可以返回给前台的序列化数据
9
return Response({
10
‘status‘: 0,
11
‘msg‘: 0,
12
‘results‘: user_ser.data
13
})
14
"""
1
class User(APIView):
2
def get(self, request, *args, **kwargs):
3
pk = kwargs.get(‘pk‘)
4
if pk:
5
try:
6
# 用户对象不能直接作为数据返回给前台
7
user_obj = models.User.objects.get(pk=pk)
8
# 序列化一下用户对象
9
user_ser = serializers.UserSerializer(user_obj)
10
# print(user_ser, type(user_ser))
11
return Response({
12
‘status‘: 0,
13
‘msg‘: 0,
14
‘results‘: user_ser.data
15
})
16
except:
17
return Response({
18
‘status‘: 2,
19
‘msg‘: ‘用户不存在‘,
20
})
21
else:
22
# 用户对象列表(queryset)不能直接作为数据返回给前台
23
user_obj_list = models.User.objects.all()
24
# 序列化一下用户对象
25
user_ser_data = serializers.UserSerializer(user_obj_list, many=True).data
26
return Response({
27
‘status‘: 0,
28
‘msg‘: 0,
29
‘results‘: user_ser_data
30
})
反序列化使用
反序列层：api/serializers.py

1
"""
2
1）设置必填与选填序列化字段，设置校验规则
3
2）为需要额外校验的字段提供局部钩子函数，如果该字段不入库，且不参与全局钩子校验，可以将值取出校验
4
3）为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值取出校验
5
4）重写create方法，完成校验通过的数据入库工作，得到新增的对象
6
"""
1
class UserDeserializer(serializers.Serializer):
2
# 1) 哪些自动必须反序列化
3
# 2) 字段都有哪些安全校验
4
# 3) 哪些字段需要额外提供校验
5
# 4) 哪些字段间存在联合校验
6
# 注：反序列化字段都是用来入库的，不会出现自定义方法属性，会出现可以设置校验规则的自定义属性(re_pwd)
7
name = serializers.CharField(
8
max_length=64,
9
min_length=3,
10
error_messages={
11
‘max_length‘: ‘太长‘,
12
‘min_length‘: ‘太短‘
13
}
14
)
15
pwd = serializers.CharField()
16
phone = serializers.CharField(required=False)
17
sex = serializers.IntegerField(required=False)
18
?
19
# 自定义有校验规则的反序列化字段
20
re_pwd = serializers.CharField(required=True)
21
?
22
# 小结：
23
# name，pwd，re_pwd为必填字段
24
# phone，sex为选填字段
25
# 五个字段都必须提供完成的校验规则
26
?
27
?
28
# 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值)
29
# 校验规则：校验通过返回原值，校验失败，抛出异常
30
def validate_name(self, value):
31
if ‘g‘ in value.lower(): # 名字中不能出现g
32
raise exceptions.ValidationError(‘名字非法，是个鸡贼！‘)
33
return value
34
?
35
# 全局钩子：validate(self, 系统与局部钩子校验通过的所有数据)
36
# 校验规则：校验通过返回原值，校验失败，抛出异常
37
def validate(self, attrs):
38
pwd = attrs.get(‘pwd‘)
39
re_pwd = attrs.pop(‘re_pwd‘)
40
if pwd != re_pwd:
41
raise exceptions.ValidationError({‘pwd&re_pwd‘: ‘两次密码不一致‘})
42
return attrs
43
?
44
# 要完成新增，需要自己重写 create 方法
45
def create(self, validated_data):
46
# 尽量在所有校验规则完毕之后，数据可以直接入库
47
return models.User.objects.create(**validated_data)
视图层

1
"""
2
1）book_ser = serializers.UserDeserializer(data=request_data) # 数据必须赋值data
3
2）book_ser.is_valid() # 结果为 通过 | 不通过
4
3）不通过返回 book_ser.errors 给前台，通过 book_ser.save() 得到新增的对象，再正常返回
5
"""
1
class User(APIView):
2
# 只考虑单增
3
def post(self, request, *args, **kwargs):
4
# 请求数据
5
request_data = request.data
6
# 数据是否合法（增加对象需要一个字典数据）
7
if not isinstance(request_data, dict) or request_data == {}:
8
return Response({
9
‘status‘: 1,
10
‘msg‘: ‘数据有误‘,
11
})
12
# 数据类型合法，但数据内容不一定合法，需要校验数据，校验(参与反序列化)的数据需要赋值给data
13
book_ser = serializers.UserDeserializer(data=request_data)
14
?
15
# 序列化对象调用is_valid()完成校验，校验失败的失败信息都会被存储在 序列化对象.errors
16
if book_ser.is_valid():
17
# 校验通过，完成新增
18
book_obj = book_ser.save()
19
return Response({
20
‘status‘: 0,
21
‘msg‘: ‘ok‘,
22
‘results‘: serializers.UserSerializer(book_obj).data
23
})
24
else:
25
# 校验失败
26
return Response({
27
‘status‘: 1,
28
‘msg‘: book_ser.errors,
29
})