01 drf的入门规范及使用

一.Web应用模式

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

知识储备: 什么是动态页面(查数据库的),什么是静态页面(静止的html)

# 判断条件: 根据html页面内容是写死的还是从后端动态获取的
静态网页: 页面上的数据是直接写死的 万年不变
动态网页: 数据是实时获取的. 如下例子:
    1.后端获取当前时间展示到html页面上
   2.数据是从数据库中获取的展示到html页面上
  
# 总结
: 页面数据写死的
: 查数据库

1.前后端不分离(前后端混合开发)

前后端混合开发:返回的html的内容

2.前后端分离

只专注于写后端接口,返回的是json,xml的数据格式

3.总结:

# 动静态页面
   静态: 页面内容写死的, 内容都是固定不变的.
    动态: 页面内容含有需要从数据库中获取的.
       
# 前后端不分离
特点: 请求动态页面, 返回HTML数据或者重定向
      
# 前后端分离特点
特点:
        请求静态页面(向静态服务器), 返回静态文件
       请求需要填充的数据, 返回js或者xml格式数据

二.API接口

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

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

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

四个特点

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

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

  • 请求方式:get、post、put、patch、delete

    采用get方式请求上方接口

  • 请求参数:json或xml格式的key-value类型数据

    • ak:6E823f587c95f0148c19993539b99295

    • region:上海

    • query:肯德基

    • output:json

  • 响应结果:json或xml格式的数据

    上方请求参数的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"
       }
     ...
]
}

总结:

API接口就是前后端信息交互的媒介(提示: 表示的是前后端之间)

三.接口测试工具:postman

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

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

  • 百度地图接口

1594111667733

四.序列化

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可视化界面来方便查看测试接口。

特点

提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;

提供了丰富的类视图、Mixin扩展类,简化视图的编写;

丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;

多种身份认证和权限认证方式的支持;[jwt]

内置了限流系统;

直观的 API web 界面;

可扩展性,插件丰富

六.drf的安装和简单使用

安装:

pip install djangorestframework==3.10.3

使用:

1. 在setting.py 的app中注册
   INSTALLED_APPS = [
    'rest_framework'
   ]
   
2. 在models.py中写表模型
   class Book(models.Model):
        nid=models.AutoField(primary_key=True)
        name=models.CharField(max_length=32)
        price=models.DecimalField(max_digits=5,decimal_places=2)
        author=models.CharField(max_length=32)
       
3. 新建一个序列化类
   from rest_framework.serializers import ModelSerializer
    from app01.models import  Book
    class BookModelSerializer(ModelSerializer):
        class Meta:
            model = Book
            fields = "__all__"
           
4. 在视图中写视图类
   from rest_framework.viewsets import ModelViewSet
    from .models import Book
    from .ser import BookModelSerializer
    class BooksViewSet(ModelViewSet):
        queryset = Book.objects.all()
        serializer_class = BookModelSerializer
       
5. 写路由关系
   from app01 import views
    from rest_framework.routers import DefaultRouter
    router = DefaultRouter()  # 可以处理视图的路由器
   router.register('book', views.BooksViewSet# 向路由器中注册视图集
     # 将路由器中的所以路由信息追到到django的路由列表中
   urlpatterns = [
        path('admin/', admin.site.urls),
   ]
    #这是什么意思?两个列表相加
   # router.urls 列表
   urlpatterns += router.urls
   
6. 启动,在postman中测试即可

七.CBV中对继承的View源码分析

切入点1:urls.py中的.as_view()方法
path('books1/', views.Books.as_view())
切入点2:视图中的Books类
class Books(View):
    # 如果有个需求,只能接受get请求
   http_method_names = ['get', ]

    def get(self, request):
        print(self.request)   # 看: 这里可以通过self.request进行获取到request方法
        return HttpResponse('ok')
项目启动时执行
@classonlymethod
def as_view(cls, **initkwargs):
...

    def view(request, *args, **kwargs):
       ...

   ...
    return view

路由匹配时执行, 将执行的类进行实例化, 通过执行路由匹配中类实例化出的对象就可以执行到继承父类View中定义的dispatch方法

def view(request, *args, **kwargs):
        self = cls(**initkwargs)
        if hasattr(self, 'get') and not hasattr(self, 'head'):
            self.head = self.get
        self.request = request
        self.args = args
        self.kwargs = kwargs
        return self.dispatch(request, *args, **kwargs)

通过dispatch方法中使用反射获取请求的类型去执行对应类中定义的请求的方法

def dispatch(self, request, *args, **kwargs):
    # Try to dispatch to the right method; if a method doesn't exist,
    # defer to the error handler. Also defer to the error handler if the
    # request method isn't on the approved list.
    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
    return handler(request, *args, **kwargs)

上面的self.http_method_names判断, 如果子类中没有派生那么就会通过View中定义的进行判断

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

图示

1594113822778

总结

1. 项目启动: views.Books.as_view()就是View类中的view函数内存地址
2. 路由匹配: 将view加括号调用, 并传入request对象.
3. 执行view: 将Books类进行实例化, 实例化出Books类的对象. 这里的self就是Books类实例化出的对象
4. 执行self.dispatch方法: self就是Books类实例化出的对象, 如果之类以及对象中都没有定义, 就会执行View类中的dispatch方法
5. dispatch方法中就是通过用户当前的请求的小写字符串进行反射. 当继承View的类中有get方法, 根据对象属性查找顺序就会调用子类中定义的get方法.

八.CBV中对继承的APIView源码分析

1.图示

项目启动: BooksAPIView就是View类中的view函数的内存地址. 只不过由APIView进行了派生, 再次self.cls=cls等包装加工以后返回的

1594116872398

路由匹配加括号调用view(request)执行:

第一步: request包装. 在执行BooksAPIView中定义的请求方法之前, 先做了request的包装, BooksAPIView中获取的request不再是原生发过来的request对象了, 如果想要获取原生的request对象我们可以通过self.request._request 或者 request.request即可.

第二步: drf提供的三段认证组件. 执行完request包装以后执行了三段认证self.initial(…).

第三步: 执行BookAPiView类中定义的方法

第四步: response没有立即做了处理, 而是判断返回的渲染模式. 举例: 如果是postman访问, 那么就返回的是json格式. 如果是浏览器就会返回好看的页面, 这个好看的页面可以根据不同的请求方式对应对数据的操作方法.

1594116948203

三段请求认证组件: self.initial(…)

1594116974516

# APIView的initial方法
 	def initial(self, request, *args, **kwargs):
        # 认证组件:校验用户 - 游客、合法用户、非法用户
        # 游客:代表校验通过,直接进入下一步校验(权限校验)
        # 合法用户:代表校验通过,将用户存储在request.user中,再进入下一步校验(权限校验)
        # 非法用户:代表校验失败,抛出异常,返回403权限异常结果
        self.perform_authentication(request)
        # 权限组件:校验用户权限 - 必须登录、所有用户、登录读写游客只读、自定义用户角色
        # 认证通过:可以进入下一步校验(频率认证)
        # 认证失败:抛出异常,返回403权限异常结果
        self.check_permissions(request)
        # 频率组件:限制视图接口被访问的频率次数 - 限制的条件(IP、id、唯一键)、频率周期时间(s、m、h)、频率的次数(3/s)
        # 没有达到限次:正常访问接口
        # 达到限次:限制时间内不能访问,限制时间达到后,可以重新访问
        self.check_throttles(request)

继承APIView视图的类中含有的方法分析:

1594117077717

流程总结

1. 项目启动时: views.BooksAPIView.as_view()等于View中定义as_view方法中view函数. 只不过是通过APIView派生赋值了一些属性以后返回的
2. 路由匹配时: 在执行视图类中定义的方法之前. 先将request进行的包装, 在执行了三段认证组组件, 最后才是执行了视图类中定义的不同请求的方法
3. 视图返回时: 先对返回的response进行了处理. 再返回的渲染结果 或者 json格式数据

posted @ 2020-07-07 19:41  江湖有梦  阅读(270)  评论(0编辑  收藏  举报