Python进阶39-drf框架(一)

DriverZeng

发布于 2022-09-26 13:02:00

4K0

发布于 2022-09-26 13:02:00

-曾老湿, 江湖人称曾老大。

-多年互联网运维工作经验，曾负责过大规模集群架构自动化运维管理工作。 -擅长Web集群架构与自动化运维，曾负责国内某大型金融公司运维工作。 -devops项目经理兼DBA。 -开发过一套自动化运维平台（功能如下）： 1)整合了各个公有云API，自主创建云主机。 2)ELK自动化收集日志功能。 3)Saltstack自动化运维统一配置管理工具。 4)Git、Jenkins自动化代码上线及自动化测试平台。 5)堡垒机，连接Linux、Windows平台及日志审计。 6)SQL执行及审批流程。 7)慢查询日志分析web界面。

drf介绍

知识点

全称：Djang-Rest Framework

"""
1、接口：什么是接口、restful接口规范
2、CBV生命周期源码 - 基于restful规范下的CBV接口
3、请求组件、解析组件、响应组件
4、序列化组件(灵魂)
5、三大认证(重中之重)：认证、权限(权限六表)、频率
6、其他组件：过滤、筛选、排序、分页、路由
"""

# 难点：源码分析

什么是接口？

"""
接口：联系两个物质的媒介，完成信息交互
web程序中：联系前台页面与后台数据库的媒介
web接口组成：
    url：长得像返回数据的url链接
    请求参数：前台按照指定的key提供数据给后台
    响应数据：后台与数据库交互后将数据反馈给前台
"""

RESTful接口规范

什么是RESTful

1.REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

2.REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态

3.REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

4.所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性

5.对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

RESTful接口规范

接口规范：就是为了采用不同的后台语言，也能使用同样的接口获取到同样的数据

如何写接口：接口规范是,规范化书写接口的，

写接口要写:url、响应数据

注：如果将请求参数也纳入考量范围，那就是在写接口文档

RESTful API设计

URL：

1) 用api关键字标识接口url
    api.baidu.com | www.baidu.com/api
    
2) 接口数据安全性决定优先选择https协议

3) 如果一个接口有多版本存在，需要在url中标识体现
    api.baidu.com/v1/... | api.baidu.com/v2/...
    
4) 接口操作的数据源称之为 资源，在url中一般采用资源复数形式，一个接口可以概括对该资源的多种操作方式
    api.baidu.com/books | api.baidu.com/books/(pk)
    
5) 请求方式有多种，用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式
    /books      get         获取所有
    /books      post        增加一个(多个)
    /books/(pk) delete      删除一个
    /books/(pk) put         整体更新一个
    /books/(pk) patch       局部更新一个

6) 资源往往涉及数据的各种操作方式 - 筛选、排序、限制
    api.baidu.com/books/?search=西&ordering=-price&limit=3

响应数据：

1) http请求的响应会有响应状态码，接口用来返回操作的资源数据，可以拥有 操作数据结果的 状态码
    status  0(操作资源成功)  1(操作资源失败)  2(操作资源成功，但没匹配结果)
    注：资源状态码不像http状态码，一般都是后台与前台或是客户约定的
    
2) 资源的状态码文字提示
    status  ok  '账号有误'  '密码有误'  '用户锁定'
    
3) 资源本身
    results
    注：删除资源成功不做任何数据返回(返回空字符串)
    
4) 不能直接放回的资源(子资源、图片、视频等资源)，返回该资源的url链接

API与用户的通信协议，总是使用HTTPs协议

域名：

https://api.example.com                 尽量将API部署在专用域名（会存在跨域问题）
https://example.org/api/                API很简单

版本：

URL，如：https://api.example.com/v1/
请求头,跨域时，引发发送多次请求

路径，视网络上任何东西都是资源，均使用名词表示（可复数）

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

method

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

过滤，通过在url上传参的形式传递搜索条件

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

状态码

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

错误处理，应返回错误信息，error当做key

{
    error: "Invalid API key"
}

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

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

Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

摘自：阮一峰

原生Django实现接口准备工作

路由分发

在api目录下创建urls.py，并且导入include

rest_ful/urls.py

from django.conf.urls import url,include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^api/', include('api.urls')),
]

api/urls.py

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^books/', views.Book.as_view()),
]

视图层

from django.shortcuts import render
from django.http import JsonResponse
from  django.views import View
# Create your views here.

class Book(View):
    def get(self,request,*args,**kwargs):
        return JsonResponse('get ok',safe=False)
    def post(self,request,*args,**kwargs):
        return JsonResponse('post ok', safe=False)

模型层

from django.db import models

# Create your models here.
class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5,decimal_places=2)

    class Meta:
        ## 自定义表名
        db_table = 'zls_book'
        verbose_name =  '书籍'
        verbose_name_plural = verbose_name


    def __str__(self):
        return self.title

admin注册

from django.contrib import admin
from . import models
# Register your models here.
admin.site.register(models.Book)

数据库迁移

MacBook-pro:rest_ful driverzeng$ python3 manage.py makemigrations
MacBook-pro:rest_ful driverzeng$ python3 manage.py migrate
## 创建超级用户
MacBook-pro:rest_ful driverzeng$ python3 manage.py createsuperuser
Username (leave blank to use 'driverzeng'): admin
Email address:
Password:  admin123
Password (again):  admin123
Superuser created successfully.

访问admin添加数据

原生Django的get请求实现单查群查接口

六大基础接口

获取一个数据
获取所有数据
增加一个数据
删除一个数据
更新一个数据
    - 局部
    - 整体

十大接口

## 在上面的6个基础的接口之上还有4个
群增数据
群删数据
整体群改
局部群改

修改url

之前写的url没有办法实现获取一个或者获取多个

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^books/$', views.Book.as_view()),
    url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),
]

实现群查接口

from django.shortcuts import render
from django.http import JsonResponse
from django.views import View
from . import models
# Create your views here.

class Book(View):
    def get(self,request,*args,**kwargs):
        pk = kwargs.get('pk')
        print(pk)
        if not pk: # 群查
            book_obj_list = models.Book.objects.all()
            print(book_obj_list)

            ## 序列化
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            return JsonResponse({
                'status':0,
                'msg': 'OK',
                'results': book_list
            },json_dumps_params={'ensure_ascii':False})
        else:      # 单查
            pass
        return JsonResponse('get ok',safe=False)
    def post(self,request,*args,**kwargs):
        return JsonResponse('post ok', safe=False)

实现单查接口

from django.shortcuts import render
from django.http import JsonResponse
from django.views import View
from . import models


# Create your views here.

class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        print(pk)
        if not pk:  # 群查
            book_obj_list = models.Book.objects.all()
            print(book_obj_list)

            ## 序列化
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            return JsonResponse({
                'status': 0,
                'msg': 'OK',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 单查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'OK',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            else:
                return JsonResponse({
                    'status': 2,
                    'msg': '无结果',
                }, json_dumps_params={'ensure_ascii': False})

    def post(self, request, *args, **kwargs):
        return JsonResponse('post ok', safe=False)

原生Django的post请求

下载postman

post请求需要使用一个工具postman

postman官网

## 接收post请求，并且查看数据

from django.shortcuts import render
from django.http import JsonResponse
from django.views import View
from . import models


# Create your views here.

class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        print(pk)
        if not pk:  # 群查
            book_obj_list = models.Book.objects.all()
            print(book_obj_list)

            ## 序列化
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            return JsonResponse({
                'status': 0,
                'msg': 'OK',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 单查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'OK',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            else:
                return JsonResponse({
                    'status': 2,
                    'msg': '无结果',
                }, json_dumps_params={'ensure_ascii': False})

    def post(self, request, *args, **kwargs):
        print(request.POST)
        print(request.body)
        return JsonResponse('post ok', safe=False)

postman总结

postman可以完成不同方式的请求：

get
post
put
...

postman发送数据包有三种方式：

form-data
urlencoded
json

原生Django对urlencoded方式数据兼容最好

实现单增接口

from django.shortcuts import render
from django.http import JsonResponse
from django.views import View
from . import models


# Create your views here.

class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        print(pk)
        if not pk:  # 群查
            book_obj_list = models.Book.objects.all()
            print(book_obj_list)

            ## 序列化
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            return JsonResponse({
                'status': 0,
                'msg': 'OK',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 单查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'OK',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            else:
                return JsonResponse({
                    'status': 2,
                    'msg': '无结果',
                }, json_dumps_params={'ensure_ascii': False})

    def post(self, request, *args, **kwargs):
        # 前台通过urlencoded方式提交数据

        ## 解压赋值，添加数据
        try:
            book_obj = models.Book.objects.create(**request.POST.dict())
            if book_obj:
                return JsonResponse({
                    'status': 0,
                    'msg': 'OK',
                    'results': {'title': book_obj.title, 'price': book_obj.price}
                }, json_dumps_params={'ensure_ascii': False})
        except:
            return JsonResponse({
                'status': 1,
                'msg': '无效参数'
            }, json_dumps_params={'ensure_ascii': False})

        return JsonResponse({
            'status': 1,
            'msg': '新增数据失败'
        }, json_dumps_params={'ensure_ascii': False})

drf安装

命令安装

MacBook-pro:~ driverzeng$ pip3 install djangorestframework -i https://mirrors.aliyun.com/pypi/simple/

图形化安装

drf使用

注册drf

settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'api.apps.ApiConfig',
    'rest_framework',
]

drf封装风格

from rest_framework.views import APIView
from rest_framework.response import Response
from  rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle

接口测试

from django.shortcuts import render
from django.http import JsonResponse
from django.views import View
from . import models

from rest_framework.views import APIView
from rest_framework.response import Response
from  rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle

class Test(APIView):
    def get(self,request,*args,**kwargs):
        return Response('drf get ok')

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^books/$', views.Book.as_view()),
    url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),
    url(r'^test/$', views.Test.as_view()),
]

drf请求生命周期

"""
1) 请求走的是APIView的as_view函数

2) 在APIView的as_view调用父类(django原生)的as_view，还禁用了 csrf 认证

3) 在父类的as_view中dispatch分发请求走的又是APIView的dispatch

4) 完成任务方法交给视图类的请求函数处理，得到请求的响应结果，返回给前台
"""

请求模块

源码入口

APIView类的dispatch方法中：request = self.initialize_request(request, *args, **kwargs)

源码分析

"""
# 二次封装得到def的request对象
request = self.initialize_request(request, *args, **kwargs) 点进去

# 在rest_framework.request.Request实例化方法中
self._request = request  将原生request作为新request的_request属性

# 在rest_framework.request.Request的__getattr__方法中
try:
    return getattr(self._request, attr)  # 访问属性完全兼容原生request
except AttributeError:
    return self.__getattribute__(attr)
"""

重点总结

class Test(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的参数
        print(request._request.GET)  # 二次封装方式
        print(request.GET) # 兼容
        print(request.query_params) # 拓展

        return Response('drf get ok')

    def post(self, request, *args, **kwargs):
        # 所有请求方式携带的数据包
        print(request._request.POST)  # 二次封装方式
        print(request.POST)  # 兼容
        print(request.data)  # 拓展，兼容性最强，三种数据方式都可以

        print(request.query_params)

        return Response('drf post ok')

总结：

# 1) drf 对原生request做了二次封装，request._request就是原生request
# 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)
# 3) drf请求的所有url拼接参数均被解析到query_params中，所有数据包数据都被解析到data中

渲染模块

浏览器和Postman请求结果渲染数据的方式不一样

源码入口

APIView类的dispatch方法中：self.response = self.finalize_response(request, response, *args, **kwargs)

源码分析

"""
# 最后解析reponse对象数据
self.response = self.finalize_response(request, response, *args, **kwargs) 点进去

# 拿到运行的解析类的对象们
neg = self.perform_content_negotiation(request, force=True) 点进去

# 获得解析类对象
renderers = self.get_renderers() 点进去

# 从视图类中得到renderer_classes请求类，如何实例化一个个对象形参解析类对象列表
return [renderer() for renderer in self.renderer_classes]


# 重点：self.renderer_classes获取renderer_classes的顺序
#   自己视图类的类属性(局部配置) => 
#   APIView类的类属性设置 => 
#   自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => 
#   drf配置文件的DEFAULT_RENDERER_CLASSES
"""

自定义drf设置

全局配置 所有视图类统一处理，在项目的settings.py中

REST_FRAMEWORK = {
    # drf提供的渲染类
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ],
}

局部配置 某一个或一些实体类单独处理，在views.py视图类中提供对应的类属性

class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response('drf get ok')

    def post(self, request, *args, **kwargs):
        return Response('drf post ok')

# 在setting.py中配置REST_FRAMEWORK，完成的是全局配置，所有接口统一处理
# 如果只有部分接口特殊化，可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
    # 局部配置
    renderer_classes = [JSONRenderer]
    def get(self, request, *args, **kwargs):
        return Response('drf get ok 2')

    def post(self, request, *args, **kwargs):
        return Response('drf post ok 2')

总结：

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

2、restful接口规范
        https://api.baidu.com/v1/books?ordering=-price&limit=3
        get|post|put|patch|delete
        {
            'status': 0,
            'msg': 'ok',
            'results': [
                {
                    'title': '西游记',
                    'img': 'https://api.baidu.com/media/xyj.png'
                }
            ]
        }

3、基于规范下原生django接口
    api/books/                  views.Book.as_view()
    api/books/(?P<pk>.*)/       views.Book.as_view()
    
    class Book(View):
        def get(self, request, *args, **kwargs):
            pk = kwagrs.get('pk')
            if pk:
                # 单查
            else:
                # 群查
        def post(self, request, *args, **kwargs):
            # 增
        def delete(self, request, *args, **kwargs):
            # 删
        def put(self, request, *args, **kwargs):
            # 整体改
        def patch(self, request, *args, **kwargs):
            # 局部改
            
4、drf
    请求的生命周期
        APIView（as_view）禁用csrf => View（as_view）=> APIView(dispatch) => 视图类的请求方法 => 响应
    请求模块
        request完全兼容_request
        重点：data/query_params
    渲染模块
        response数据json与browser两种渲染方式
        重点：全局配置/局部配置
        self.render_classes
        自定义视图类（局部） => APIView视图类 => 自定义drf配置(全局) => drf默认配置
"""

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2019-04-29，如有侵权请联系 cloudcommunity@tencent.com 删除

django