flask jsonify之序列化时的default函数、jsonify序列化自定义对象[通俗易懂]

全栈程序员站长

发布于 2022-08-25 12:37:28

9840

发布于 2022-08-25 12:37:28

文章被收录于专栏：全栈程序员必看

大家好，又见面了，我是你们的朋友全栈君。

1.看源码

2、重写默认的default函数，实现自己的序列化机制

3、把对象转化成字典

3.1 __dict__的方式

3.2、定义keys和__getitem__的方式

4、最终的代码实现

5、关于default函数的其他知识

1.看源码

打开site-package，flask，json，__init__.py

flask jsonify之序列化时的default函数、jsonify序列化自定义对象[通俗易懂]

jsonify回去调用default()函数，我们最关心的就是重写default方法

我们是不是调用jsonify就一定会调用default呢？答案：不是！

发现如上图所示，并没有进入jsonify的default方法里，而是直接把字典给序列化出来了。

那么什么时候会调用default呢？

结论：如果flask知道如何序列化你传入进来的数据结构的时候，是不会调用default，因为知道如何序列化就直接帮我们序列化了，但是如果我们要序列化一个对象，是我们的user模型，flask默认是不知道怎么去序列化这个模型的，那么就会去调用default函数，为什么会这样的，原因就在于flask不知道怎么序列化，但是它会给我们一个途径，让我们来指明这个数据结构应该怎么序列化，换句话说，default函数最主要的就是我们需要在内部把不能序列化的结构转化为可以序列化的结构，比如我们传入进来的是一个user，user是不能序列化的，但是如果我们可以把user转化成字典，字典是可以序列化的，那么这样就能完成user对象的序列化了，虽然user作为一个模型他不能序列化，但是我们可以把他的信息读取出来，转化为一个字典，从而保证我们整个序列化的成功执行。可以看到default里面的源码，传入的user对象既不是datetime也不是date、uuid.UUID、__html__，所以最后会抛出一个异常

所以我们要在default中把不能序列化的user转化成可以序列化的格式。

所以我们继承，然后重写default方法，在重写的函数中实现user的可序列化就OK了

2、重写默认的default函数，实现自己的序列化机制

我们不要直接修改源码，要在外部继承JSONEncoder，然后在用自己的方法覆盖原来的default方法。

from flask import Flask, jsonify
class hehe:
    name = 'zhangsan'
    age = 18

app = Flask(__name__)
ctx = app.app_context()
ctx.push()
# 上面是解决上下文对象的异常RuntimeError: Working outside of application context.

a = hehe()
print(a)
jsonify(a)  # TypeError: Object of type 'hehe' is not JSON serializable

可以看到上图代码报错不能序列化a对象，所以我们要在外部继承JSONEncoder，然后在用自己的方法覆盖原来的default方法。

可以看到即使按照上图所示写，flask还是没有调用我们自己定义的default，所以我们还要在flask里面替换一下

from flask import Flask as _Flask, jsonify
from flask.json import JSONEncoder as _JSONEncoder


class JSONEncoder(_JSONEncoder):

    def default(self, o):
        pass


class Flask(_Flask):
    json_encoder = JSONEncoder


class hehe():
    name = 'zhangsan'
    age = 18


app = Flask(__name__)
ctx = app.app_context()
ctx.push()
# 上面是解决上下文对象的异常RuntimeError: Working outside of application context.

a = hehe()
print(a)

jsonify(a)  # 不报错了

可以看到flask把我们实例化的hehe类当做参数o传递了进来，有两个属性

3、把对象转化成字典

3.1 dict的方式

现在我们要把对象转化成字典，因为字典是可以被序列化的，但是对象不行。我们想到了对象的__dict__内置方法，但是发现没有得到任何的结果，输出的是一个空的json对象。

这是因为我们在hehe类里面定义的是类的变量而不是实例的变量。类的变量是不会被存放到对象的__dict__当中的。所以加入一个实例变量的时候就有值了（如下图）

所以我们看到这种方式是可以的，但是我们想把无论类变量还是实例变量都像把它直接序列化，我们就需要用下面的方法把所有的都转成字典

3.2、定义keys和getitem的方式

class D:
    name = 'zhangsan'
    age = 18
 
    def __init__(self):
        self.sex = '男'
 
    def keys(self):
        return ('name', 'sex')
 
    def __getitem__(self, item):
        return getattr(self, item)
 
 
d = D()
print(d.__dict__)  # {'sex': '男'}
print(dict(d))  # {'name': 'zhangsan', 'sex': '男'} 如果注销了getitem方法就会报错TypeError: 'D' object is not iterable

4、最终的代码实现

from flask import Flask as _Flask, jsonify
from flask.json import JSONEncoder as _JSONEncoder


class JSONEncoder(_JSONEncoder):
    def default(self, o):
        if hasattr(o, 'keys') and hasattr(o, '__getitem__'):
            print(dict(o))
        else:
            print("不能序列化对象")


class Flask(_Flask):
    json_encoder = JSONEncoder


class hehe:
    name = 'zhangsan'
    age = 18

    def __init__(self):
        self.sex = '男'

    def keys(self):
        return ('name', 'sex')

    def __getitem__(self, item):
        return getattr(self, item)


app = Flask(__name__)
ctx = app.app_context()
ctx.push()
# 上面是解决上下文对象的异常RuntimeError: Working outside of application context.
a = hehe()
print(a)  # <__main__.hehe object at 0x7f0aed3e1e10>
jsonify(a)  # {'name': 'zhangsan', 'sex': '男'}