drf知识-08

Django之了解DRF框架

# 介绍:DRF全称 django rest framework

# 背景:

        在序列化与反序列化时,虽然操作的数据不尽相同,但是执行的过程却是相似的,也就是说这部分代码是可以复用简化编写
        增:校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
        删:判断要删除的数据是否存在 -> 执行数据库删除
        改:判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
        查:查询数据库 -> 将数据序列化并返回
# 作用:Django REST framework可以帮助我们简化上述两部分的代码编写,大大提高REST API的开发速度

# DRF特点:

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

# 环境安装与配置:

1、安装DRF

pip install djangorestframework

2、在settings.py的INSTALLED_APPS中添加’rest_framework’

INSTALLED_APPS = [...'rest_framework',
]

# DRF牛刀小试:

1、创建序列化器,在books应用中新建serializers.py用于保存该应用的序列化器,创建一个类用于序列化与反序列化:

from rest_framework import serializers
from books.models import Bookclass BookInfoSerializer(serializers.ModelSerializer):"""图书数据序列化器"""class Meta:model = Bookfields = '__all__'

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

2、编写视图,在books应用的views.py中创建视图BookViewSet,这是一个视图集合:

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import Bookclass BookViewSet(ModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializer

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

3、定义路由,在books应用的urls.py中定义路由信息

from . import views
from rest_framework.routers import DefaultRouterrouter = DefaultRouter()  # 可以处理视图的路由器
router.register(r'books', views.BookViewSet, 'books')  # 向路由器中注册视图集
urlpatterns = [
]
urlpatterns += router.urls  # 将路由器中的所以路由信息追到到django的路由列表中

三大认证组件回顾

# 认证类的编写
用户登录后,会有登录标识,早期直接写入到浏览器中了

session['name']='lqz'
obj.set_cookie()

写认证类的目的:校验它携带的登录标识,是否合法,是否在库中存着
只需要按照固定规则去写即可:
  1、写一个类,继承 BaseAuthentication
  2、重写 authenticate 方法
  3、在方法中完成校验--》用户标识

             用户标识带在请求头 / 请求地址 / 请求体
            校验携带的标识正不正确---> 去数据库查
            查到返回俩值:第一个值会给后续的request.user,第二个值给request.auth
            校验失败:抛异常

class LoginAuth(BaseAuthentication):   # 不一定继承BaseAuthenticationdef authenticate(self, request):   # 目的是重写authenticate,有authenticate就是认证类token = request.query_params.get('token') or request.META.get('HTTP_TOKEN')user_token = UserToken.objects.filter(token=token).first()if user_token:user = user_token.user      # 重写是因为源码里在一个个调用这个方法,在方法中完成校验return user, user_token     # 返回两个值,第一个值会给request.user,第二个给了request.authelse:                           # 标识一般带到请求头、请求地址和请求体中,由后端决定raise AuthenticationFailed("您没有登录")

  4、放在视图类上,局部禁用:
            authentication_classes=[ ]
 5、放在配置文件中--drf配置文件中找 :         

 REST_FRAMEWORK = {'DEFAULT_AUTHENTICATION_CLASSES': ['app01.auth.LoginAuth'],}

#  权限类
  用户登录了,有没有权限访问接口
  权限放在了认证之后,request.user :当前登录用户,根据是谁来做权限
  编写规则:
 1、写一个类类,继承 BasePermission
 2、 重写 has_permission 方法
 3、在方法中完成权限校验--》当前登录用户
            能有用户,就能取出用户的权限
            如果有,返回True,没有返回False
            前端看到中文提示:self.message

class CommonPermission(BasePermission):def has_permission(self, request, view):try:user_type = request.user.user_typeif user_type == 2:return Trueelse:# user.get_字段名_display()  返回这个字段的choice对应的文字self.message = '您是:%s,您没有权限操作这个' % request.user.get_user_type_display()return Falseexcept Exception as e:# 未登录用户也没有权限if 'login' in request.path:return Trueelse:self.message = '您没有登录,您没有权限操作这个'return False

  4、放在视图类上(可以配多个),局部禁用:
            permission_classes=[ ]
 5、放在配置文件中--drf配置文件中找:

 REST_FRAMEWORK = {'DEFAULT_permission_CLASSES': [''],}

# 频率类使用
限制用户访问频次:用户登录或不登录都可能会限制
限制条件:ip,用户id
编写步骤:
    1、写一个类类,继承 SimpleRateThrottle
    2、重写 get_cache_key 方法
           返回什么就以什么做限制:ip或id号
            类上写个属性:rate = '5/d'    # s m h d 

class CommonThrottle(SimpleRateThrottle):rate = '3/m'def get_cache_key(self, request, view):ip = request.META.get('REMOTE_ADDR')return ip

  3、放在视图类上(可以配多个),局部禁用:
            throttle_classes=[ ]
  4、 放在配置文件中--drf配置文件中找:            

REST_FRAMEWORK = {'DEFAULT_throttle_CLASSES': [''],}

排序之继承GenericAPIView

# 1 只有查询所有需要排序
# 2 如何使用
     1 必须是继承 GenericAPIView 及其子类
    2 在类中配置类属性
        filter_backends = [OrderingFilter]
    3 类中写属性
        ordering_fields = ['price','id']  # 必须表的字段        
    4 以后再前端,就可以访问
        http://127.0.0.1:8000/api/v1/books/?ordering=price 按price升序排
        http://127.0.0.1:8000/api/v1/books/?ordering=-price 按price降序排
        http://127.0.0.1:8000/api/v1/books/?ordering=-price,id

from .models import Book
from rest_framework.viewsets import ViewSetMixin
from rest_framework.generics import ListAPIView
from .serializer import BookSerializer# 排序之继承 GenericAPIView
from rest_framework.filters import OrderingFilter
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [OrderingFilter]  # 排序ordering_fields = ['price','id']# http://127.0.0.1:8000/api/v1/books/?ordering=-price,id

排序之继承APIview

# 如果继承APIView,过滤规则自己写

# 单条排序:

# 排序之继承 APIView
from rest_framework.views import APIView
from rest_framework.response import Response
class BookView(ViewSetMixin, APIView):def list(self, request):# 从地址兰中取出用户过滤条件# http://127.0.0.1:7000/api/v1/books/?ordering=-pricequery_params = request.query_params  #< QueryDict: {'ordering': ['-price']}>obj_list = Book.objects.all().order_by(query_params.get('ordering'))ser = BookSerializer(instance=obj_list, many=True)return Response(ser.data)

# 多条排序:

# 排序之继承 APIView
from rest_framework.views import APIView
from rest_framework.response import Response
class BookView(ViewSetMixin, APIView):def list(self, request):# 从地址兰中取出用户过滤条件# http://127.0.0.1:7000/api/v1/books/?ordering=-price,idquery_params = request.query_params  #<QueryDict: {'ordering': ['-price,id']}>print(query_params)if ',' in query_params.get('ordering'):query = query_params.get('ordering').split(',')obj_list = Book.objects.all().order_by(*query)ser = BookSerializer(instance=obj_list, many=True)return Response(ser.data)

过滤之使用drf内置过滤类

#  restful规范中有一条是请求地址中带过滤条件,查询所有数据,只查询出我们想要的

# 如何使用
     1 必须是继承 GenericAPIView 及其子类
     2 在类中配置类属性
        filter_backends = [SearchFilter]
     3 类中写属性
       search_fields = ['price','id']  # 必须表的字段        
    4 以后再前端,就可以访问
        http://127.0.0.1:7000/api/v1/books/?search=风

        http://127.0.0.1:7000/api/v1/books/?search=摆

# 过滤之使用drf内置过滤类
from rest_framework.filters import SearchFilter
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [SearchFilter]  # 排序search_fields = ['name']# http://127.0.0.1:7000/api/v1/books/?search=风

过滤之使用djagno-filter过滤

# 下载  pip3 install django-filter

# 导入  from django_filters.rest_framework import DjangoFilterBackend
# 3 使用

# 过滤之使用djagno-filter过滤
from django_filters.rest_framework import DjangoFilterBackend
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [DjangoFilterBackend]  # 排序filterset_fields = ['name','price']# http://127.0.0.1:7000/api/v1/books/?name=摆渡人&price=34# 查询书名为摆渡人且价格为34的

过滤之自定制过滤类

# 写个类,继承BaseFilterBackend重写filter_queryset,在内部完成过滤

# filter
from rest_framework.filters import BaseFilterBackend
class CommonFilter(BaseFilterBackend):def filter_queryset(self, request, queryset, view):# queryset 是之前所有数据 Book.object.all()# request 当次请求requestname = request.query_params.get('name')price = request.query_params.get('price')if name:queryset = queryset.filter(name__contains=name)if price:queryset = queryset.filter(price=price)return queryset
# views.py
# 过滤之自定制过滤类,重写了类里方法,再引用
from .filter import CommonFilter
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [CommonFilter]  # 排序# http://127.0.0.1:7000/api/v1/books/?name=追&price=31.2# 书名用了模糊查法,价格是精准查法

自定义过滤+排序

# 自定义过滤+排序
from .filter import CommonFilter
from rest_framework.filters import OrderingFilter
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [CommonFilter,OrderingFilter]  # 过滤,排序ordering_fields = ['price']# http://127.0.0.1:7000/api/v1/books/?name=渡&ordering=-price# 查询书名含渡的且按照价格降序

分页之基础分页

# 查询所有接口,分页

# 使用drf内置了三种分页方式:

        PageNumberPagination, LimitOffsetPagination, CursorPagination

1、写个类,继承基础分页类,重写类属性       

# pagination.py  基本分页PageNumberPagination
from rest_framework.pagination import PageNumberPagination
class CommonPageNumberPagination(PageNumberPagination):page_size = 1      # 默认显示,每页大小,一页显示多少条page_query_param = 'page'    # 分页查询条件  ?page=1page_size_query_param = 'size'  #每页最多显示多少条的查询条件  &size=2max_page_size = 3   # 每页最多显示多少条# http://127.0.0.1:7000/api/v1/books/?search=34&size=2# 过滤查询价格为34且一页显示2条数据的(不写size默认显示1条)

2、在继承自 GenericAPIView及其子类, 在视图类配置分页类即可

# 分页之基础分页
# 在内置过滤器的条件下分页
from rest_framework.filters import SearchFilter
from .pagination import CommonPageNumberPagination
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [SearchFilter]  # 过滤,排序search_fields = ['price']pagination_class = CommonPageNumberPagination

分页之偏移分页

 # 查询所有接口,分页

# 使用drf内置了三种分页方式:

        PageNumberPagination, LimitOffsetPagination, CursorPagination

1、写个类,继承基础分页类,重写类属性       

# pagination.py  基本分页LimitOffsetPagination
from rest_framework.pagination import LimitOffsetPagination
class CommonLimitOffsetPagination(LimitOffsetPagination):default_limit = 1   # 默认显示,每页显示的条数limit_query_param = 'limit'  # 分页查询条件  ?limit=1offset_query_param = 'offset'   # # 偏移量 从第2条开始,拿2条 offset=2&limit=2max_limit = 3   # # 每页最多显示多少条# http://127.0.0.1:7000/api/v1/books/?limit=1&page=3  显示第三页的一条数据# http://127.0.0.1:7000/api/v1/books/?offset=1&limit=2  从第一条数据开始显示2条数据

2、在继承自 GenericAPIView及其子类, 在视图类配置分页类即可

# 分页之基础分页
# 在内置过滤器的条件下分页
from rest_framework.filters import SearchFilter
from .pagination import CommonPageNumberPagination
from .pagination import CommonLimitOffsetPagination
class BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [SearchFilter]  # 过滤,排序search_fields = ['price']pagination_class = CommonPageNumberPaginationpagination_class = CommonLimitOffsetPagination

分页之游标分页

# 特点:只能从第一页开始,只能上一页和下一页,不能自定义哪页,但是效率高很多

1、写个类,继承基础分页类,重写类属性       

# pagination.py 游标分页  CursorPagination
from rest_framework.pagination import CursorPagination
class CommonCursorPagination(CursorPagination):cursor_query_param = 'cursor'   # 分页查询条件  ?cursor=1page_size = 2    # 每页显示的条数ordering = 'id'  # 排序规则,必须是表中字段# http://127.0.0.1:7000/api/v1/books/# 内部已经写死,从第一页查起,显示2条,只能上下翻页

2、在继承自 GenericAPIView及其子类, 在视图类配置分页类即可

# views.py
# 分页之基础分页
# 在内置过滤器的条件下分页
from rest_framework.filters import SearchFilter
from .pagination import CommonPageNumberPagination
from .pagination import CommonLimitOffsetPagination
from .pagination import CommonCursorPaginationclass BookView(ViewSetMixin,ListAPIView):     # 改路径和查询所有queryset = Book.objects.all()serializer_class = BookSerializer   # 序列类映射filter_backends = [SearchFilter]  # 过滤,排序search_fields = ['price']pagination_class = CommonPageNumberPaginationpagination_class = CommonLimitOffsetPaginationpagination_class = CommonCursorPagination

全局异常处理

# 三大认证和视图类的方法中出现了异常,都会被try捕获,做全局异常处理

# 捕获到统一处理,无论我是否出异常,返回的格式都是固定的

        {code:100,msg:成功}
# 新建py文件,写一个函数,在函数中处理异常

# exceptions.py
# drf的异常处理是exception_handler处理,没处理非drf的异常
# 自己写个函数,处理drf异常和自己的异常
from rest_framework.views import exception_handler
from rest_framework.response import Responsedef common_exception_handler(exc, context):res = exception_handler(exc, context)  # 处理drf异常处理if res:# data = {'detail': exc.detail},错误信息# return Response(data)# {code: 100, msg: 成功}detail = res.data.get('detil') or "drf异常,请联系系统管理员"return Response({'code': 101, 'msg': detail})else:return Response({'code': 102, 'msg': '系统异常,请联系系统管理员:%s'%str(exc)})

# 把函数配置在配置文件中,setting.py

REST_FRAMEWORK = {'EXCEPTION_HANDLER': 'app01.exceptions.common_exception_handler',}

#  只要三大认证或视图类的方法出了异常,就会走这个函数

# 全局异常处理
# 无论我是否出异常,返回的格式都是固定的
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.exceptions import AuthenticationFailed,ValidationError,APIExceptionclass UserView(ViewSetMixin, APIView):def create(self, request):  # post--->create# l = [1, 2, 3]# print(l[9])# raise Exception("你出错了")# drf  默认能处理自己的异常:继承自APIException的异常raise APIException('认证失败')return Response({'code': 100, 'msg': '成功'})

今日思维导图:

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://xiahunao.cn/news/2659934.html

如若内容造成侵权/违法违规/事实不符,请联系瞎胡闹网进行投诉反馈,一经查实,立即删除!

相关文章

第三课:寄存器与内存、中央处理器(CPU)、指令和程序及高级 CPU 设计

第三课&#xff1a;寄存器与内存、中央处理器&#xff08;CPU&#xff09;、指令和程序及高级 CPU 设计 第六章&#xff1a;寄存器与内存课程导入1、概念梳理2、锁存器3、门锁4、寄存器5、门锁矩阵5、内存 第七章&#xff1a;中央处理器&#xff08;CPU&#xff09;1、概念梳理…

Illustrator脚本 #015 自动角线

这是一个在画板上自动生成辅助线和角线的脚本,只要单击最右边按钮运行脚本即可。 绿色的为参考线及出血线。 #target "Illustrator" var settings = {addTrim : true,addBleedGuide : true,addCenterGuide : true,addCover : false,overlapAlert : false,trimma…

WEB 3D技术 three.js 设置环境贴图 高光贴图 场景设置 光照贴图

上文WEB 3D技术 three.js 基础网格材质演示几何体贴图 ao贴图效果我们简单构建了一个贴图和ao贴图的几何体材质 我们接下来 来看一下透明度贴图 我们还是官网搜索 MeshBasicMaterial 然后 是我们的 alphaMap 属性 这里 黑色为完全透明 白色 完全不透明 黑白之间还有灰色 这个灰…

【数据库系统概论】第6章-关系数据库理论

真别看吧&#xff0c;抄ppt而已啊 文章目录 6.1 引言6.2 规范化6.2.1 函数依赖6.2.2 码6.2.3 范式&#xff08;Normal Form&#xff09;6.2.4 BC范式6.2.5 规范化小结 6.1 引言 我们有这样一张表&#xff1a; but 为啥这样设计呢&#xff1f;由此引出怎样设计一个关系数据库…

Mac电脑如何长截图?

https://zhuanlan.zhihu.com/p/543012365 1、打开需要截图的网页&#xff08;小编随意输入的内容&#xff09;&#xff0c;如图 2、按下组合快捷键【commandoptioni】&#xff0c;出现“html”界面&#xff0c;如图 3、按下组合快捷键【commandshiftp】&#xff0c;出现搜索界…

使用激光干涉测量时克服振动问题

干涉仪的工作原理 干涉仪可以极其精确地测量物体。他们的工作原理是使用分束器将一束光分成相等的两半&#xff0c;分束器实际上是一块涂有薄银的玻璃。当光照射到分束器上时&#xff0c;一半的光通过&#xff0c;一半的光被反射回来。其中一束光束&#xff08;称为参考光束&a…

软件测试常见的面试题,这些题面试前看提高百分之60的通过率

01、您所熟悉的测试用例设计方法都有哪些&#xff1f;请分别以具体的例子来说明这些方法在测试用例设计工作中的应用。 答&#xff1a;有黑盒和白盒两种测试种类&#xff0c;黑盒有等价类划分法&#xff0c;边界分析法&#xff0c;因果图法和错误猜测法。白盒有逻辑覆盖法&…

Ubuntu18.04安装GTSAM库并验证GTSAM是否安装成功(亲测可用)

在SLAM&#xff08;Simultaneous Localization and Mapping&#xff09;和SFM&#xff08;Structure from Motion&#xff09;这些复杂的估计问题中&#xff0c;因子图算法以其高效和灵活性而脱颖而出&#xff0c;成为图模型领域的核心技术。GTSAM&#xff08;Georgia Tech Smo…

关于Redis面试题

前言 之前为了准备面试&#xff0c;收集整理了一些面试题。 本篇文章更新时间2023年12月27日。 最新的内容可以看我的原文&#xff1a;https://www.yuque.com/wfzx/ninzck/cbf0cxkrr6s1kniv Redis 是什么 全名&#xff1a;远程字典服务。这是一个开源的在内存中的数据结构存…

C#高级 01.Net多线程

一.基本概念 1.什么是线程&#xff1f; 线程是操作系统中能独立运行的最小单位&#xff0c;也是程序中能并发执行的一段指令序列线程是进程的一部分&#xff0c;一个进程可以包含多个线程&#xff0c;这些线程共享进程资源进程有线程入口&#xff0c;也可以创建更多的线程 2.…

C++ DAY2作业

1.课堂struct练习&#xff0c;用class&#xff1b; #include <iostream>using namespace std;class Stu { private:int age;char sex;int high; public:double score;void set_values(int a,char b,int c,double d);int get_age();char get_sex();int get_high(); }; vo…

FreeRTOS学习--59讲 Tickless低功耗

Tickless低功耗作用&#xff1a;降低功耗 配置方法&#xff1a; a.在FreeRTOSConfig.h中将configUSE_TICKLESS_IDLE置1(自动配置tickless函数)&#xff0c;2(手动配置)&#xff0c;0(关闭低功耗) b.在FreeRTOSConfig.h中将configEXPECTED_ID…

【数据结构】插入排序、选择排序、冒泡排序、希尔排序、堆排序

前言&#xff1a;生活中我们总是会碰到各种各样的排序&#xff0c;今天我们就对部分常用的排序进行总结和学习&#xff0c;今天的内容还是相对比较简单的一部分&#xff0c;各位一起加油哦&#xff01; &#x1f496; 博主CSDN主页:卫卫卫的个人主页 &#x1f49e; &#x1f44…

使用Rust发送邮件

SMTP协议与MIME协议 SMTP&#xff08;简单邮件传输协议,Simple Mail Transfer Protocol&#xff09;是一种用于发送和接收电子邮件的互联网标准通信协议。它定义了电子邮件服务器如何相互发送、接收和中继邮件。SMTP 通常用于发送邮件&#xff0c;而邮件的接收通常由 POP&#…

每日一题--------求数字的每⼀位之和

大家好今天的每日一题又来了&#xff0c;有啥不对的请在评论区留言哦 文章目录 目录 文章目录 求数字的每⼀位之和 题⽬描述&#xff1a; 输⼊⼀个整数m&#xff0c;求这个整数m的每⼀位之和&#xff0c;并打印。 一、解题思路 我们可以通过不断获取该整数的个位数&#xff0c…

算法导论复习(七) 动态规划

动态规划一般用来求解最优化问题 设计一个动态规划算法一般有以下四步&#xff1a; 描述一个最优解的结构特征。递归地定义最优解的值。计算最优解的值&#xff0c;通常采用自底向上的方法。利用计算出的信息构造出一个最优解。 钢条切割问题 体现了动态规划的一个重要性质&a…

磁盘管理 :逻辑卷、磁盘配额

一 LVM可操作的对象&#xff1a;①完成的磁盘 ②完整的分区 PV 物理卷 VG 卷组 LV 逻辑卷 二 LVM逻辑卷管理的命令 三 建立LVM逻辑卷管理 虚拟设置-->一致下一步就行-->确认 echo "- - -" > /sys/class/scsi_host/host0/scan;echo "- -…

什么是https证书?

HTTPS证书&#xff0c;也称为SSL&#xff08;Secure Sockets Layer&#xff09;证书或TLS&#xff08;Transport Layer Security&#xff09;证书&#xff0c;是一种数字证书&#xff0c;用于在网络上建立安全的加密连接。它的主要目的是确保在互联网上进行的数据传输的安全性和…

探索Apache Commons Imaging处理图像

第1章&#xff1a;引言 大家好&#xff0c;我是小黑&#xff0c;咱们今天来聊聊图像处理。在这个数字化日益增长的时代&#xff0c;图像处理已经成为了一个不可或缺的技能。不论是社交媒体上的照片编辑&#xff0c;还是专业领域的图像分析&#xff0c;图像处理无处不在。而作为…

HTML网页设计 科幻风格引入页

成品如下 html <!DOCTYPE html> <html><head><meta charset"utf-8"><title>引入页</title><link href"css/引入页.css" type"text/css" rel"stylesheet" /><style>body{background…