Bootstrap

Django-rest-framework框架

目录

一 Web应用模式

1.1 前后端不分离

二 API接口

三 接口测试工具：Postman

 四 RESTful API规范

4.1 数据的安全保障

4.2 接口特征表现

4.3 多数据版本共存

4.4 数据即是资源，均使用名词（可复数）

4.5 资源操作由请求方式决定（method）

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

4.7 响应状态码

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

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

4.10 需要url请求的资源需要访问资源的请求链接

四 序列化

五 Django Rest_Framework

六,安装

 启动一个django项目

使用postman测试

 七 CBV源码分析

APIview的基本使用

1. 使用view+JsonResponse写

2. 使用APIView+drf的Response写

APIView 源码分析

总结

Request类源码分析

一 Web应用模式

在开发Web应用中，有两种应用模式：

1.1 前后端不分离

1.2 前后端分离 

二 API接口

为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点

1. url: 长得像返回数据的url链接

https://api.map.baidu.com/place/v2/search

2. 请求方式: get、post、put、patch、delete

采用get方式请求上方接口

3. 请求参数：json或xml格式的key-value类型数据

  • ak：6E823f587c95f0148c19993539b99295
  • region：上海
  • query：肯德基
  • output：json

4. 响应结果：json或xml格式的数据

上方请求参数的output参数值决定了响应数据的格式

数据;

 xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
    "status":0,
  	"message":"ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

三 接口测试工具：Postman

Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。

Postman可以直接从官网：https://www.getpostman.com/downloads/下载获得，然后进行傻瓜式安装。

  • 工作面板

 get请求

post请求

请求百度地图接口

 四 RESTful API规范

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

4.1 数据的安全保障

rl链接一般都采用https协议进行传输

注：采用https协议，可以提高数据交互过程中的安全性

4.2 接口特征表现

4.3 多数据版本共存

注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）

4.4 数据即是资源，均使用名词（可复数）

4.5 资源操作由请求方式决定（method）

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

4.7 响应状态码

HTTP协议：hypertext transport protocol（超文本传输协议），协议详细规定了浏览器和万维网服务器之间互相通信的规则。（一种约定，规则）

 常见响应状态码：

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

{
    error: "无权限操作"
}

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

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

4.10 需要url请求的资源需要访问资源的请求链接

# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比较好的接口返回

# 响应数据要有状态码、状态信息以及数据本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

四 序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：

序列化： 把我们识别的数据转换成指定的格式提供给别人。

例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。

反序列化：把别人提供的数据转换/还原成我们需要的格式。

例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。

五 Django Rest_Framework

核心思想: 缩减编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。

官方文档：Home - Django REST framework

github: https://github.com/encode/django-rest-framework/tree/master

 特点

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

六,安装

pycharm下载第三方模块

 或者终端执行命令行

pip install djangorestframework

 启动一个django项目

数据准备

urls.py


from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views

router = SimpleRouter()
router.register('books',views.BookView)


urlpatterns = [
    path('admin/', admin.site.urls),

]
urlpatterns += router.urls

 views.py


from .models import Book
from rest_framework.viewsets import ModelViewSet

from .serializer import BookSerializer


class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

 建一个serializer.py 

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

models.py

from django.db import models

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=64)

使用自带的数据库sqlit3

增加一点数据

 

 执行数据库迁移命令

python manage.py makemigrations
python manage.py migrate

使用postman测试

get请求,请求所有

请求单个

 新增图书

修改

删除

 七 CBV源码分析

以后都写cbv，都写基于类的试图

cbv写好后，路由配置如下
    -第一个参数是路径，第二个参数是试图函数的内存地址（视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址）

    path('test/', views.TestView.as_view()),

        -去找as_view，去TestView类中找，找不到，没有，去父类中找View
 

      @classonlymethod
        def as_view(cls, **initkwargs):
            def view(request, *args, **kwargs):
                return self.dispatch(request, *args, **kwargs)
            return view


    -当请求来了，路由匹配成功，会执行view(request)--->本质执行self.dispatch(request, *args, **kwargs)
    -去View中找到了dispatch
     

  def dispatch(self, request, *args, **kwargs):
            # 请求方式转成小写，假设 get 请求，符合if条件
            if request.method.lower() in self.http_method_names:
                # 反射 getattr(对象,'字符串','默认值')
                # self是TestView的对象
                # handler 就是TestView类的get方法
                handler = getattr(self, 'get', self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
            return handler(request, *args, **kwargs)  # get(request)

参见博客

 FBV与CBV, CBV源码剖析_Yietong309的博客-CSDN博客

APIview的基本使用

drf是一个第三方app. 只能在django上使用, 安装了drf之后,导入视图类APIView, 后期要使用drf写视图类,都是继承APIView及其子类

1. 使用view+JsonResponse写

from django.db import models

# Create your models here.

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)

from django.http import JsonResponse
from django.views import View
from .models import Book
class BookView(View):
    def get(self,request):
        book_list = Book.objects.all()  # bok_list是一个queryset对象,只能通过for循环,拼成列表桃子点的形式
        return JsonResponse(book_list)   # 只能序列化字典和列表


class BookView(View):
    def get(self,request):
        book_list = Book.objects.all()  # bok_list是一个queryset对象
        res = []
        for book in book_list:
            res.append({'name':book.name,'price':book.price,'publish':book.publish})
        return JsonResponse(res,safe=False,json_dumps_params={"ensure_ascii":False})   # 只能序列化字典和列表

2. 使用APIView+drf的Response写

先去app里注册rest_framework

 

from rest_framework.response import Response
from rest_framework.views import APIView
from serializer import BookSerializer
from .models import Book

class BookView(APIView):
    def get(self, request):
        print(request._request)
        print(type(request._request))
        print(request.method)
        print(request.path)
        print(request.GET)
        print(request.POST)
        book_list = Book.objects.all()
        res = []
        for book in book_list:
            res.append({'name': book.name, 'price': book.price, 'publish': book.publish})
            return Response(res)



<WSGIRequest: GET '/books/'>
<class 'django.core.handlers.wsgi.WSGIRequest'>
GET
/books/
<QueryDict: {}>
<QueryDict: {}>

APIView 源码分析

视图类继承APIView后,执行流程就发生了变化, 这个变化就是整个的drf的执行流程

一旦继承了APIView入口, 路由配置跟之前继承View是一样的, 先找视图类的as_view>>>APIView里的as_view

 


    @classmethod
    def as_view(cls, **initkwargs):
        
        view = super().as_view(**initkwargs)  # 调用了父类View里的as_view
    
      
        return csrf_exempt(view)
          '''
            # 从此以后，所有的请求都没有csrf的校验了
            # 在函数上加装饰器
            @csrf_exempt
            def index(request):
                pass
            本质等同于 index=csrf_exempt(index)
            '''

请求来了, 路由匹配成功会执行View类的as_view类的方法内的view播报函数(但是没有了csrf认证)

真正执行的是self.dispatch>>> APIView里的disptach方法

  def dispatch(self, request, *args, **kwargs):
        # 参数的request是原来的django原生的request,下边的request变成了drf提供的Request类的对象>>return Request(...)
     
        request = self.initialize_request(request, *args, **kwargs)
        
        # self 是视图类的对象, 视图类对象.request = request 是新的request
        self.request = request
       
        try:
            # 执行力认证,频率,权限
            self.initial(request, *args, **kwargs)

            # 原来的Viewde dispatch的东西
            if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

        except Exception as exc:
            # 如果出了异常,捕获异常, 处理异常, 正常返回
            # 在执行三大认证和视图类的方法过程中, 如果出现了异常, 是能被捕获并且处理的, >>> 全局异常的处理
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response

总结

1. 只要继承APIView都没有csrf的认证

2. 以后视图类中使用的request对象已经变成了drf提供的Request类的对象了

3. 执行视图类的方法之前,执行力三大认证(认证,权限, 频率)

4. 在执行三大认证和视图类的方法过程中, 只要报错就会被捕获处理

Request类源码分析

1. 视图类中使用的request对象, 已经变成了drf提供的Request类的对象了

        - 原生django的request是这个类的对象:django.core.handlers.wsgi.WSGIRequest
        -drf的request是这个类的对象：rest_framework.request.Request

2.request已经不是原来的request了, 还能像原来的request一样使用吗?

        可以的.

        print(request.method)  # get
        print(request.path)  # /books/
        print(request.GET)   # 原来的get请求提交的参数
        print(request.POST)  # 原来post请求提交的参数

3. request源码分析

request类中有个魔法方法 __getattr__

对象.属性, 属性不存在会触发他的执行


    def __getattr__(self, attr):
        
       # r如果去除的属性不存在回去原生django的request对象中取出来
        try:
           # 反射, 根据字符串获取属性或方法, self._request 是原来的request
            return getattr(self._request, attr)
        except AttributeError:
            return self.__getattribute__(attr)

以后用的所有的属性或方法, 直接使用即可, >>> 通过反射去原来的request中取

新的request内部有个老的request, 就是request._request

data 是个方法,被property装饰了, 变成了数据属性使用

以后body体中提交的数据, 都从request.POST里取

urlencoded,form-data 提交的数据在 request.POST中

json格式提交的数据,在request.POST中没有, 在request.body里

无论哪种格式,都从request.data里取值

auery_params:get请求提交的参数等同于request._request.GET或request.GET

去文件也是从request.FILES中取, 与之前一样

原生request.POST只有urlencoded和form-data格式提交的数据, json格式提交的数据在body中, 拿出来自己处理, 但是drf的request只有个data, data中可以渠道任意编码提交的数据

 request.data  有时候是(urlencoded,form-data)QueryDict，有时候(json)是字典

悦读

道可道，非常道；名可名，非常名。 无名，天地之始，有名，万物之母。 故常无欲，以观其妙，常有欲，以观其徼。 此两者，同出而异名，同谓之玄，玄之又玄，众妙之门。

最新收录
STM32H750XBH6使用LTDC点亮7英寸LCD(1024*600)
mysql 表优化
小白C语言基础详解：多字节字符
基于springboot的房屋租赁系统设计与实现（源码+论文）
侯捷——STL源码剖析 笔记
Gitlab提交时间错误问题修复
JAVA 基本数据类型长度
PHP 运算符：深入理解与高效使用
多目标跟踪MOT16_Benchmark数据集下载-------------送人玫瑰，手留余香
给LLM Agent应用插上视觉模型的翅膀，一文搞懂ONNX如何加载头部姿态评估模型
;