drf 安装_年薪百万之路--第八十二天 DRF框架(1)

最新推荐文章于 2021-10-19 14:08:51 发布

weixin_39940714

最新推荐文章于 2021-10-19 14:08:51 发布

阅读量136

点赞数

文章标签： drf 安装

本文链接：https://blog.csdn.net/weixin_39940714/article/details/111678548

版权

一 DRF框架介绍

      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框架

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

1.前后端不分离

2.前后端分离

在团队开发中,一般都是采用后者前后端分离,需要一种接口实现规范,这种规范能够让后端写的接口,用途一目了然,目前主流的接口服务架构主要有:resful,rpc,soap.

rpc(远程过程调用)
服务端提供单一的请求数据的api地址
优点:不需要管当前操作是什么http请求,也不需要操作url地址的编写,对接简单
缺点:接口多了,对接函数名和参数就多了,前端在请求api接口时,就会比较难找,容易出现重复的接口

restful(资源状态转换)
把后端所有的数据/文件都看成资源. 
对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
那么接口请求数据,本质上来说就是对资源的操作了.
优点:维护开发简单,可以保证后期的开发不会出现太多的重复接口
缺点:1.有部分接口不会有明确的增删改查区分,所以会出现一些不伦不类的接口,会因为这些语义不明,不伦不类的接口导致后期的维护成本上升
     2.因为restful把对于资源的操作都理解成了增删改查,建议使用http.所以restful接口天生局限于web开发

ps:接口实施过程中，会存在幂等性。所谓幂等性是指代客户端发起多次请求是否对于服务端里面的资源产生不同结果。如果多次请求，
服务端结果还是一样，则属于幂等接口，如果多次请求，服务端产生结果是不一样的，则属于非幂等接口。
在http请求，get/put/patch/delete都属于幂等性接口，post属于非幂等接口。为什么要考虑幂等性？主要就是接口操作的安全性问题。

大多web开发还是使用restful规范的API接口,而在api接口开发中,最核心最常见的一个过程就是序列化,所谓序列化就是数据转换格式，序列化可以分两个阶段：

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

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



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

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

而DRF就能快速的开发REST API接口应用,提供了序列化器,所以基于Django开发web项目必须要学习到DRF

三 DRF安装与环境配置

DRF需要以下依赖:

Python(2.7,3.2以上)
Django(1.10,1.11,2.0以上)

DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需重新创建

# mkvirtualenv drfdemo -p python3
# pip install django==2.2.0  -i https://pypi.douban.com/simple
提前创建好django环境

pip install djangorestframework -i https://pypi.douban.com/simple

# 因为我们需要接下来，需要开发api接口肯定要操作数据，所以安装pymysql
pip install pymysql -i https://pypi.douban.com/simple

四 DRF的使用

在创建好的django项目中打开setting.py,在INSTALLED APPS中添加'rest_framework'.

ps:因为drf本质就是django的一个子应用

接下来就可以使用DRF进行api接口开发了,主要步骤有三步:

将请求的数据(如:JSON格式)转换成为模型对象
通过模型类对象进行数据库操作,完成客户端请求的增删改查
将模型类对象转换为响应的数据

具体过程:

1.创建一个子应用

python manage.py startapp students

2.创建模型类对象

在子应用的models.py文件

from django.db import models

# Create your models here.
class Student(models.Model):
    # 表字段声明
    # 字段名=models.数据类型(字段约束)
    name = models.CharField(null=False, max_length=32, verbose_name="姓名")   #verbose_name:中文注释,在django自带后台admin中可显示
    sex  = models.BooleanField(default=True, verbose_name="性别")
    age  = models.IntegerField(verbose_name="年龄")
    class_num = models.CharField(max_length=5, verbose_name="班级编号")
    description = models.TextField(max_length=1000, verbose_name="个性签名")

    # 表信息
    class Meta:
        # 设置表名
        db_table="tb_students"    在数据库中显示的表名
        verbose_name="学生"
        verbose_name_plural=verbose_name

    # 模型的操作方法
    def __str__(self):
        return self.name

3.进行数据迁移

安装pymysql

pip install pymysql

连接mysql数据库,在主应用中settings.py配置文件中设置mysql的账号密码

DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    },
}

在主应用中__init__.py,设置使用pymysql作为数据库驱动

import pymysql
pymysql.install_as_MySQLdb()

执行数据迁移

python manage.py makemigrations
python manage.py migrate

在执行数据迁移会报两个错误如下

是因为djngo2.2版本对mysqlclient的版本的限制

解决方法:

注释掉最后一条报错链接中的第35和36行代码

第二个:

django2.2版本出现的字符编码问题

解决方法:把decode改成encode

4.创建序列化器

在子应用中新建serializers.py用于保存该应用的序列化器

在其中创建StudenModelSerializer用于序列化与反序列化

from rest_framework import serializers
from .models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
         model = Student
         fields = "__all__"

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

5.编写视图

在students应用的views.py中创建视图StudentViewSet,这是一个视图集合

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer

class StudentViewSet(ModelViewSet):
    querset = Student.objects.all()
    serializer_class = StudentModelSerializer

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

6.定义路由

在student应用的urls.py中定义路由信息

from . import views
from rest_framework.routers import DefaultRouter

urlpatterns = []

rotuer = DefaulRouter()  #可以处理视图的路由器对象
rotuer.register('students',views.StudentViewSet)  #向路由器中注册视图集

urlpatterns += router.urls   #将路由器中的所有路由信息追加到django的路由列表中

最后把students子应用中的路由文件加载到总路由文件中

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('student/',include("students.urls")),
]

7.运行测试

运行当前django项目

点击链接127.0.0.1:8000/stu/students 可以访问获取所有数据的接口

五序列化器Serializer详解

作用:1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
     2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
     3. 反序列化,完成数据校验功能

举例还是Student这个模型类对象

from django.db import models

# Create your models here.
class Student(models.Model):
    # 模型字段
    name = models.CharField(max_length=100,verbose_name="姓名",help_text="提示文本:账号不能为空！")
    sex = models.BooleanField(default=True,verbose_name="性别")
    age = models.IntegerField(verbose_name="年龄")
    class_null = models.CharField(max_length=5,verbose_name="班级编号")
    description = models.TextField(verbose_name="个性签名")

    class Meta:
        db_table="tb_student"
        verbose_name = "学生"
        verbose_name_plural = verbose_name

想为这个模型类定制一个序列化器,如下:

from rest_framework import serializers

# 声明序列化器，所有的序列化器都要直接或者间接继承于 Serializer
# 其中，ModelSerializer是Serializer的子类，ModelSerializer在Serializer的基础上进行了代码简化
class StudentSerializer(serializers.Serializer):
    """学生信息序列化器"""
    # 1. 需要进行数据转换的字段
    id = serializers.IntegerField()
    name = serializers.CharField()
    age = serializers.IntegerField()
    sex = serializers.BooleanField()
    description = serializers.CharField()

    # 2. 如果序列化器集成的是ModelSerializer，则需要声明调用的模型信息

    # 3. 验证代码

    # 4. 编写添加和更新模型的代码

PS: serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。
serializer是独立于数据库之外的存在。

在序列化器的字段中可以添加参数作为验证数据使用

选项参数
max_length      最大长度
min_lenght      最小长度
allow_blank     是否允许为空
trim_whitespace 是否截断空白字符
max_value       最小值
min_value       最大值

通用参数
read_only        表明该字段仅用于序列化输出,默认False
write_only       表名该字段仅用于反序列化输出,默认False
required         表名该字段在反序列化时必须输入,默认True
default          反序列化时使用的默认值
allow_null       表明该字段是否允许传入None,默认False
allow_blank      允许提交过来的数据为空字符串,默认False
vaildators       该字段使用的验证器
error_messages   包含错误编号与错误信息的字典
label            用于HTML展示API页面时,显示的字段名称
help_text        用于HTML展示API页面时,显示的字段帮助提示信息

定义好Serializer类后,就可以创建Serializer对象了

Serializer的构造方法为:

Serializer(instance=None,data=empty,**kwarg).

说明:
1.用于序列化时,将模型类对象传入instance参数
2.用于反序列化时,将要被反序列化的数据传入data参数
3.除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据.如:
    serializer = AccountSerializer(account, context={'request': request})
  通过context参数附加的数据，可以通过Serializer对象的context属性获取

序列化器的基本使用

单条数据序列化

from django.views import View
from students.models import Student
from .serializers import StudentSerializer
from django.http.response import JsonResponse
class StudentView(View):
    """使用序列化器序列化转换单个模型数据"""
    def get(self,request,pk):
        # 获取数据
        student = Student.objects.get(pk=pk)
        # 数据转换[序列化过程]
        serializer = StudentSerializer(instance=student)
        print(serializer.data)
        # 响应数据
        return JsonResponse(serializer.data)

包含多条数据的queryset

"""使用序列化器序列化转换多个模型数据"""
    def get(self,request):
        # 获取数据
        student_list = Student.objects.all()

        # 转换数据[序列化过程]
        # 如果转换多个模型对象数据，则需要加上many=True
        serializer = StudentSerializer(instance=student_list,many=True)
        print( serializer.data ) # 序列化器转换后的数据

        # 响应数据给客户端
        # 返回的json数据，如果是列表，则需要声明safe=False
        return JsonResponse(serializer.data,safe=False)

六反序列化

使用序列化器进行反序列化时,需要对数据进行验证后才能获取验证成功的数据或保存成模型类对象

在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False

验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

验证成功，可以通过序列化器对象的validated_data属性获取数据。

在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。

<views.py>

from django.http import import JsonResponse
from django.views import View
from .serializers import StudentSerializer
form students.models import Student

class StudentsView(APIView):
    def post(self.request):
        serializer_obj = StudentSerializer(data=request.data)
        serializer .errors   #查看错误信息
        # 当验证失败时,可以直接通过声明 raise_exception=True 让django直接跑出异常,那么验证出错之后
         ，EST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。
        result = serializer.is_valid(raise_exception=True) 
        print('验证结果:%s' %result)
        
        # 获取通过验证后的数据
        print( serializer.validated_data )

        # 返回响应结果给客户端
        # alt + enter，可以实现快速导包
        return JsonResponse({"message": "ok"})