Django Rest_Framework（django是前端还是后端）

Django Rest_Framework（django是前端还是后端）

restful就是一个接口开发的约定俗成的开发规范。不局限于django或者drf，即便我们不使用drf，其实也能实现符合restful规范的api接口。

同时，drf框架不是restful作者开发出来的！！！

序列化器-Serializer

作用：

序列化,序列化器会把模型对象转换成字典,将来提供给视图经过response以后变成json字符串反序列化,把客户端发送过来的数据,经过视图调用request以后变成python字典,序列化器可以把字典转成模型反序列化,完成数据校验功能和操作数据库

1 定义序列化器

Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。

接下来，为了方便演示序列化器的使用，我们另外创建一个新的子应用sers

python manage.py startapp sers

先注册子应用到项目中，settings.py，代码：

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework', # 把drf框架注册到django项目中 'students', # 注册子应用 'sers',]

因为我们已有了一个数据库模型类students/Student，我们直接在接下来的演示中使用这个模型。

class Student(models.Model): # 模型字段 name = models.CharField(max_length=100,verbose_name="姓名") sex = models.BooleanField(default=1,verbose_name="性别") age = models.IntegerField(verbose_name="年龄") class_number = models.CharField(max_length=5,verbose_name="班级编号") description = models.TextField(max_length=1000,verbose_name="个性签名") class Meta: db_table="tb_student" verbose_name = "学生" verbose_name_plural = verbose_name

我们想为这个模型类提供一个序列化器，可以命名为​​StudentSerializer​​，

我们都会把序列化器代码保存到当前子应用下的serializers.py模块中，

可以定义如下：

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

常用字段类型：

选项参数：

通用参数：

2 创建Serializer对象

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

Serializer的构造方法为：

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

说明：

1）用于序列化时，将模型类对象传入instance参数

2）用于反序列化时，将要被反序列化的数据传入data参数

3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如

serializer = StudentSerializer(student, context={'request': request},many=False)

通过context参数附加的数据，可以通过Serializer对象的self.context属性获取。

3 序列化器的使用

序列化器的使用分两个阶段：

在客户端请求时，使用序列化器可以完成对数据的反序列化。在服务器响应时，使用序列化器可以完成对数据的序列化。

3.1 序列化

3.1.1 基本使用

1） 先查询出一个学生对象

视图中获取模型对象，代码：

from students.models import Studentstudent = Student.objects.get(pk=3)

2） 构造序列化器对象

from .serializers import StudentSerializerserializer = StudentSerializer(instance=student)

3）获取序列化数据

通过data属性可以获取序列化后的数据

serializer.data# {'id': 4, 'name': '小张', 'age': 18, 'sex': True, 'description': '猴赛雷'}

完整视图代码：

class Student2APIView(View): def get(self,request): """返回一个学生信息""" # 读取模型对象 student = Student.objects.get(pk=1) # 实例化序列化器 serializer = StudentSerializer(instance=student) print( serializer.data ) """打印效果： {'id': 1, 'name': '张三', 'sex': True, 'age': 18} """ return JsonResponse(serializer.data)

4）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明

7.3.2 反序列化

7.3.2.1 数据验证

开发中，用户的数据都是不可信任的。

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

在获取反序列化的客户端数据前，必须在视图中调用序列化对象的is_valid()方法，序列化器内部是在is_valid方法内部调用验证选项和验证方法进行验证，验证成功返回True，否则返回False。

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

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

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

为了方便演示，我们这里采用另一个图书模型来完成反序列化的学习。当然也创建一个新的子应用unsers。

python manage.py startapp unsers

注册子应用，setting.py注册子应用，代码：

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework', # 把drf框架注册到django项目中 'students', # 注册子应用 'sers', # 演示序列化 'unsers', # 演示反序列化]

注意：

接下来的内容涉及到postman post提交数据，所以在此时我们没有学习到drf视图方法时，我i们把settings.py中的中间件的csrf关闭.MIDDLEWARE = [ 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', # 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware',]

模型代码：

from django.db import models# Create your models here.class BookInfo(models.Model): """图书信息""" title = models.CharField(max_length=20, verbose_name='标题') pub_date = models.DateField(verbose_name='发布日期') image = models.ImageField(verbose_name='图书封面') price = models.DecimalField(max_digits=8, decimal_places=2, verbose_name="价格") read = models.IntegerField(verbose_name='阅读量') comment = models.IntegerField(verbose_name='评论量') class Meta: # db_table = "表名" db_table = "tb_book_info" verbose_name = "图书" verbose_name_plural = verbose_name

注意：因为当前模型中， 设置到图片上传处理，所以我们需要安装​​PIL​​库

pip install Pillow

数据迁移

python manage.py makemigrationspython manage.py migrate

经过上面的准备工作，我们接下来就可以给图书信息增加图书的功能，那么我们需要对来自客户端的数据进行处理，例如，验证和保存到数据库中，此时，我们就可以使用序列化器的反序列化器，接下来，我们就可以参考之前定义学生信息的序列化器那样，定义一个图书的序列化器，当然，不同的是，接下来的序列化器主要用于反序列化器阶段，在unsers子应用，创建serializers.py，代码如下：

通过构造序列化器对象，并将要反序列化的数据传递给data构造参数，进而进行验证

# Create your views here.from django.views import Viewfrom django.import HttpResponsefrom .serializers import BookInfoSerializerclass BookInfoView(View): def get(self,request): """模拟客户端发送过来的数据""" data = { "title":"西厢记", "pub_date":"1980-10-10", "price": 19.80, "read": 100, "comment": -1, } # 对上面的数据进行反序列化器处理 # 1. 初始化，填写data属性 serializer = BookInfoSerializer(data=data) # 2. 调用序列化器提供的is_valid方法进行验证 # raise_exception=True 表示终断程序，直接抛出错误 ret = serializer.is_valid(raise_exception=True) print(ret) # is_valid的方法值就是验证结果，只会是True/False if ret: # 3.1 验证通过后，可以通过validated_data得到数据 print("验证成功，ret=%s" % ret) print(serializer.validated_data) # 验证处理后的数据 """打印结果： OrderedDict([('title', '西厢记'), ('pub_date', datetime.date(1980, 10, 10)), ('price', Decimal('19.80')), ('read', 100), ('comment', 15)]) """ else: print("验证失败，ret=%s" % ret) # 3.1 验证没通过，可以通过 print( serializer.errors ) """打印结果： {'comment': [ErrorDetail(string='Ensure this value is greater than or equal to 0.', code='min_value')]} """ return HttpResponse("ok")

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

# Return a 400 response if the data was invalid.serializer.is_valid(raise_exception=True)

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

1) validate_字段名

对​​​​字段进行验证，如

class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... # 单个字段的验证，方法名必须： validate_<字段名>(self,data) # data 就是当前字段中客户端提交的数据 # validate_price 会被is_valid调用 def validate_price(self, data): """""" if data < 0: raise serializers.ValidationError("对不起，价格不能低于0元") # 验证通过以后，必须要返回验证的结果数据，否则序列化器的validated_data无法得到当前字段的结果 return data

把前面的例子的price改为-19.80，运行就可以测试了。

2) validate

在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如

class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... # 多个字段的验证，必须方法名叫 "validate" # data 表示客户端发送过来的所有数据，字典格式 def validate(self, data): # 判断图书的阅读量不能低于评论量 read = data.get("read") comment = data.get("comment") if read < comment: raise serializers.ValidationError("对不起，阅读量不能低于评论量") return data

运行之前的例子，把read改为1，comment改为100，访问测试。

3) validators验证器

验证器类似于验证方法，但是验证方法只属于当前序列化器，如果有多个序列化器共用同样的验证功能，则可以把验证代码分离到序列化器外部，作为一个普通函数，由validators加载到序列化器中使用。

在字段中添加validators选项参数，也可以补充验证行为，如

把前面的例子修改成title=“西厢记django版本”，然后运行测试

视图代码：

# Create your views here.from django.views import Viewfrom django.import HttpResponsefrom .serializers import BookInfoSerializerclass BookInfoView(View): def get(self,request): """模拟客户端发送过来的数据""" data = { "title":"西厢记django版本", "pub_date":"1980-10-10", "price": 19.80, "read": 10000, "comment": 100, } # 对上面的数据进行反序列化器处理 # 1. 初始化，填写data属性 serializer = BookInfoSerializer(data=data) # 2. 调用序列化器提供的is_valid方法进行验证 # raise_exception=True 表示终断程序，直接抛出错误 ret = serializer.is_valid(raise_exception=True) print(ret) # is_valid的方法值就是验证结果，只会是True/False if ret: # 3.1 验证通过后，可以通过validated_data得到数据 print("验证成功，ret=%s" % ret) print(serializer.validated_data) # 验证处理后的数据 """打印结果： OrderedDict([('title', '西厢记'), ('pub_date', datetime.date(1980, 10, 10)), ('price', Decimal('19.80')), ('read', 100), ('comment', 15)]) """ else: print("验证失败，ret=%s" % ret) # 3.1 验证没通过，可以通过 print( serializer.errors ) """打印结果： {'comment': [ErrorDetail(string='Ensure this value is greater than or equal to 0.', code='min_value')]} """ return HttpResponse("ok")

每次验证都是先验证单个字段，最后才是多个字段的yan'zeh

3.2.2 数据保存

通过序列化器来完成数据的更新或者添加，把视图中对于模型中的操作代码移出视图中，放入到序列化器。

前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.

可以通过实现create()和update()两个方法来实现。

视图代码：

在序列化器实现了create和update两个方法后，在反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了

book = serializer.save()

如果创建序列化器对象的时候，没有传递instance实例，则调用save()方法的时候，create()被调用，相反，如果传递了instance实例，则调用save()方法的时候，update()被调用。

BaseSerializer中定义的save方法源码：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ph20lPGM-1628869048005)(assets/1582086563954.png)]

3.2.3 附加参数说明

1） 在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到

# 可以传递任意参数到数据保存方法中# 例如：request.user 是django中记录当前登录用户的模型对象serializer.save(owner=request.user)

2）默认序列化器必须传递所有必填字段[required=True]，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

# Update `BookInfo` with partial data# partial=True 设置序列化器只是针对客户端提交的字段进行验证，没有提交的字段，即便有验证选项或方法也不进行验证。serializer = BookInfoSerializer(book, data=data, partial=True)

3.3 模型类序列化器

如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。

ModelSerializer与常规的Serializer相同，但提供了：

基于模型类自动生成一系列序列化器字段基于模型类自动为Serializer生成validators，比如unique_together包含默认的create()和update()的实现

3.3.1 定义

比如我们创建一个BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = '__all__'

model 指明参照哪个模型类fields 指明为模型类的哪些字段生成

我们可以在python manage.py shell中查看自动生成的BookInfoSerializer的具体实现

>>> from booktest.serializers import BookInfoSerializer>>> serializer = BookInfoSerializer()>>> serializerBookInfoSerializer(): id = IntegerField(label='ID', read_only=True) title = CharField(label='名称', max_length=20) pub_date = DateField(allow_null=True, label='发布日期', required=False) read = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False) comment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False) image = ImageField(allow_null=True, label='图片', max_length=100, required=False)

3.3.2 指定字段

使用fields来明确字段，​​__all__​​表名包含所有字段，也可以写明具体哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date')

使用exclude可以明确排除掉哪些字段

class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo exclude = ['image',]

显示指明字段，如：

class HeroInfoSerializer(serializers.ModelSerializer): book = BookInfoSerializer() class Meta: model = HeroInfo fields = ('id', 'name', 'sex', 'comment', 'book')

指明只读字段

可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段

class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'title', 'pub_date'， 'read', 'comment') read_only_fields = ('id', 'read', 'comment')

3.3.3 添加额外参数

我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'title', 'pub_date', 'read', 'comment') extra_kwargs = { 'read': {'min_value': 0, 'required': True}, 'comment': {'min_value': 0, 'required': True}, }# BookInfoSerializer():# id = IntegerField(label='ID', read_only=True)# title = CharField(label='名称', max_length=20)# pub_date = DateField(allow_null=True, label='发布日期', required=False)# read = IntegerField(label='阅读量', max_value=2147483647, min_value=0, required=True)# comment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。