Django(44)drf序列化源码分析[通俗易懂]

Django(44)drf序列化源码分析[通俗易懂]序列化与反序列化一般后端数据返回给前端的数据格式都是json格式,简单易懂,但是我们使用的语言本身并不是json格式,像我们使用的Python如果直接返回给前端,前端用的javascript语言是识

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

序列化与反序列化

  一般后端数据返回给前端的数据格式都是json格式,简单易懂,但是我们使用的语言本身并不是json格式,像我们使用的Python如果直接返回给前端,前端用的javascript语言是识别不出的,所以我们需要把python语言转换为通用的json格式的数据,在django中就是将orm模型或者queryset对象转换成字典,再由字典转换成json,整个过程就是序列化。

  当用户通过在form表单中填写的数据,发送请求给后端,将数据提交给后端数据库,这个过程就是反序列化。反序列化的时候,我们需要去验证前端提交的数据是否符合后端制定的规范,符合才进行入库。
 

drf的序列化类

drf的序列化类有3个

  • Serializer
  • ModelSerializer(使用最多的)
  • ListSerializer

我们使用最多的就是ModelSerializer,这三个序列化类都继承自BaseSerializer,虽然我们项目中99%都是使用的ModelSerializer,但是光知道怎么使用,是没有灵魂的,我们还需要去了解源码,多看源码能迅速提高代码能力。
 

BaseSerializer源码分析

源码如下:

class BaseSerializer(Field):
    def __init__(self, instance=None, data=empty, **kwargs):
     
    def __new__(cls, *args, **kwargs)

    def __class_getitem__(cls, *args, **kwargs)

    @classmethod
    def many_init(cls, *args, **kwargs):

    def to_internal_value(self, data):

    def to_representation(self, instance):

    def update(self, instance, validated_data):

    def create(self, validated_data):

    def save(self, **kwargs):

    def is_valid(self, raise_exception=False):

    @property
    def data(self):

    @property
    def errors(self)

    @property
    def validated_data(self)

我们分析几个重要的方法,没必要每个方法都了解,分析的都是后面要用到的
 

__init__方法

def __init__(self, instance=None, data=empty, **kwargs):
    self.instance = instance 
    if data is not empty:
        self.initial_data = data
    self.partial = kwargs.pop('partial', False)
    self._context = kwargs.pop('context', {})
    kwargs.pop('many', None)
    super().__init__(**kwargs)

初始化方法,有4个参数

  • self:本身自己
  • instance:实例,默认为None
  • data:数据,默认为empty
  • **kwargs:不定长字典
     

create

def create(self, validated_data):
    raise NotImplementedError('`create()` must be implemented.')

定义了一个create方法,参数为validated_data,方法抛出了一个异常,意思是create方法没有定义,如果要继承BaseSerializer,那就必须定义create方法,否则就会抛出异常
 

update

def update(self, instance, validated_data):
    raise NotImplementedError('`update()` must be implemented.')

定义了一个update方法,有2个参数

  • instance:实例,更新数据的时候,需要知道更新的是哪个实例化对象
  • validated_data:已验证的数据,前端传入的字段需要进行验证

此方法抛出了一个异常,意思是update方法没有定义,如果要继承BaseSerializer,那就必须定义update方法,否则就会抛出异常
 

is_valid

def is_valid(self, raise_exception=False):
    # 如果self对象没有initial_data属性,那么将无法调用该方法,如果需要有initial_data,那么实例化对象必须传入data参数
    assert hasattr(self, 'initial_data'), (
        'Cannot call `.is_valid()` as no `data=` keyword argument was '
        'passed when instantiating the serializer instance.'
    )

    if not hasattr(self, '_validated_data'):
        try:
            self._validated_data = self.run_validation(self.initial_data)
        except ValidationError as exc:
            self._validated_data = {}
            self._errors = exc.detail
        else:
            self._errors = {}

    if self._errors and raise_exception:
        raise ValidationError(self.errors)

    return not bool(self._errors)

这个方法是验证从前端传输过来的字段是否验证成功,如果我们的实例化对象没有传入data参数,将会无法调用is_valid,这个方法大多数用在反序列化的时候
 

save

def save(self, **kwargs):
    # 调用save()方法前必须先调用is_valid()
    assert hasattr(self, '_errors'), (
        'You must call `.is_valid()` before calling `.save()`.'
    )
    # 不能对无效的数据调用save()方法
    assert not self.errors, (
        'You cannot call `.save()` on a serializer with invalid data.'
    )
    # 防止没有正确使用save方法
    # Guard against incorrect use of `serializer.save(commit=False)`
    assert 'commit' not in kwargs, (
        "'commit' is not a valid keyword argument to the 'save()' method. "
        "If you need to access data before committing to the database then "
        "inspect 'serializer.validated_data' instead. "
        "You can also pass additional keyword arguments to 'save()' if you "
        "need to set extra attributes on the saved model instance. "
        "For example: 'serializer.save(owner=request.user)'.'"
    )
    # 访问serializer.data后就不能调用save方法了,如果你需要在提交到数据库之前访问数据,那么请使用serializer.validated_data
    assert not hasattr(self, '_data'), (
        "You cannot call `.save()` after accessing `serializer.data`."
        "If you need to access data before committing to the database then "
        "inspect 'serializer.validated_data' instead. "
    )
    # 创建已验证的数据对象
    validated_data = {**self.validated_data, **kwargs}
    
    # 如果instance不为空
    if self.instance is not None:
        # instance对象将更新为validated_data里的内容
        self.instance = self.update(self.instance, validated_data)
        assert self.instance is not None, (
            '`update()` did not return an object instance.'
        )
    else:
        # 如果instance为空,那么则创建对象,对象的内容为validated_data
        self.instance = self.create(validated_data)
        assert self.instance is not None, (
            '`create()` did not return an object instance.'
        )

    return self.instance
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/165779.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • Atitit.列表页and查询条件的最佳实践(1)——设定搜索条件and提交查询and返回json数据

    Atitit.列表页and查询条件的最佳实践(1)——设定搜索条件and提交查询and返回json数据

  • mysql fsync_mysql fsync

    mysql fsync_mysql fsync标签:1介绍数据库系统从诞生那天开始,就面对一个很棘手的问题,fsync的性能问题。组提交(groupcommit)就是为了解决fsync的问题。最近,遇到一个业务反映MySQL创建分区表很慢,仔细分析了一下,发现InnoDB在创建表的时候有很多fsync——每个文件会有4个fsync的调用。当然,并不每个fsync的开销都很大。这里引出几个问题:(1)问题1:为什么fsync开销相对都比较大…

  • vue父组件操作子组件的方法_vue父组件获取子组件数据

    vue父组件操作子组件的方法_vue父组件获取子组件数据父组件和子组件我们经常分不清什么是父组件,什么是子组件。现在来简单总结下:我们将某段代码封装成一个组件,而这个组件又在另一个组件中引入,而引入该封装的组件的文件叫做父组件,被引入的组件叫做子组件。具

  • selenium之PO模式

    selenium之PO模式selenium之PO模式PO模式的精髓:测试对象和测试用例的分离PageObject的设计思想上是把元素定位和元素操作进行分层,这样带来的最直接的好处是当元素发生变化时,只需维护page层的定位,而不需要关心在那些测试用例当中使用了这些元素。在编写测试用例时,也不需要关心元素是如何定位的。下边以百度搜索为例来通过代码来说明PO模式1.封装常用的元素操作base.pyimporttimefromseleniumimportwebdriverclassBasePage(object

  • 免费PDF翻译,不限页数,不限字数,保留排版

    免费PDF翻译,不限页数,不限字数,保留排版可以试试这个网站https://superdoctranslator.com/,使用百度的引擎,排版全部保留,不仅支持word和pptx,还支持图片PDF和扫描件,一个月白嫖少说也得600页PDF,用标准版appid连页数都不限制了,主要是排版效果几乎100%还原。…

  • win10家庭版打开管理员账户_win10用户账户控制阻止程序运行

    win10家庭版打开管理员账户_win10用户账户控制阻止程序运行win10版本家庭中文版:运行应用程序报错:解决办法(亲试):1.进入”控制面板“–”用户账户“–”用户账户“,选择”更改用户账户控制设置“,选择最后一项,点击”确定“按钮,如下图:2.按

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号