6. 模型对象的序列化
1. 理解序列化时的 default 函数
我们最想做的一件事情, 就是在视图函数中, 读取出模型之后, 还要把他的属性读出来, 转换成一个字典. 我们想直接 jsonfiy(user)
现在 jsonfiy 并不能直接序列化对象, 所以我们的目标就是必须想办法让 jsonfiy 直接序列化对象.
jsonfiy 在序列化对象的时候, 如果不知道如何序列化当前传进来的参数, 就会去调用 JSONEncoder 类的 default 函数.
def default(self, o):
"""Implement this method in a subclass such that it returns a
serializable object for ``o``, or calls the base implementation (to
raise a :exc:`TypeError`).
For example, to support arbitrary iterators, you could implement
default like this::
def default(self, o):
try:
iterable = iter(o)
except TypeError:
pass
else:
return list(iterable)
return JSONEncoder.default(self, o)
"""
- if isinstance(o, datetime):
- return http_date(o.utctimetuple())
- if isinstance(o, date):
- return http_date(o.timetuple())
- if isinstance(o, uuid.UUID):
- return str(o)
- if hasattr(o, '__html__'):
- return text_type(o.__html__())
- return _json.JSONEncoder.default(self, o)
目前的 default 是没有提供对对象的序列化的, 所以我们这里最关键的就是要重写 default 方法. 在重写的过程中实现对对象的序列化就可以了
2. 不完美的对象转字典
我们首先要做到的就是让 Flask 可以调用到我们自己定义的 default 函数. 要做到这一点, 我们需要继承 JSONEncoder, 然后重写 defualt 方法, 然后继承 Flask, 在子类里, 替换掉 Flask 原有的 json_encoder 对象. 然后, 是实例化 Flask 核心对象的时候, 使用我们的子类进行实例化
- class JSONEncoder(_JSONEncoder):
- def default(self, o):
- # 只能转换实例变量
- return o.__dect__
- class Flask(_Flask):
- json_encoder = JSONEncoder()
上面的写法 o.__dect__只能转换实例变量, 不能讲类变量也转换成字典.
3. 深入理解 dict 机制
在 Python 中创建一个 dict 有很多种方式:
直接定义一个字典
- r = {
- 'name': 'gwf'
- }
使用 dict 函数
r = dict(name='gwf')
将一个对象传入 dict 函数
值得研究的是这第三种方法, 当将一个对象传入 dict 函数的时候, 他会去调用 keys 函数
image.png
keys 方法的目的就是为了拿到字典里所有的键, 至于说这些键有那么, 完全有我们自己来定义. keys 返回的必须是一个元组或者列表来声明要序列化的键.
而 dict 会以中括号的形式来拿到对应的值, 如 o["name"], 但是默认是不能这么访问的, 我们需要编写__getitem__函数
- class Person:
- name = 'gwf'
- age = 18
- def __init__(self):
- self.gender = 'male'
- def keys(self):
- return ('name', 'age', 'gender')
- def __getitem__(self, item):
- return getattr(self, item)
- o = Person()
- print(dict(o))
- # {'name': 'gwf', 'age': 18, 'gender': 'male'}
这样我们就成功的讲一个对象转化成了字典的形式, 并且无论类变量和实例变量, 都可以转化, 更加灵活的是, 我们可以自己控制, 那些变量需要转化, 哪些变量不需要转化
注意:
如果我们只想序列化一个元素
- def keys(self):
- return ('name')
这样是不行的, 因为只有一个元素的元素不是这样定义的, 我们需要在后面加上一个逗号
- def keys(self):
- return ('name',)
4. 序列化 SQLALChemy 模型
有了之前的基础, 我们就知道怎么序列化 user 对象了, 我们只需要在 User 类中定义 keys 和 getitem 方法, 然后在 default 函数中使用 dict() 函数即可
- class JSONEncoder(_JSONEncoder):
- def default(self, o):
- return dict(o)
- class Flask(_Flask):
- json_encoder = JSONEncoder
- models/user.py
- class User(Base):
- id = Column(Integer, primary_key=True)
- email = Column(String(50), unique=True, nullable=False)
- auth = Column(SmallInteger, default=1)
- nickname = Column(String(24), nullable=False)
- _password = Column('password', String(128))
- # SQLALChemy 的实例化是不会调用__init__函数的, 要想让他调用就需要
- # @orm.reconstructor 这个装饰器
- @orm.reconstructor
- def __init__(self):
- self.fields = ['id', 'email', 'nickname']
- def keys(self):
- return self.fields
- # 支持隐藏字段
- def hide(self, *keys):
- [self.fields.remove(key) for key in keys]
- # 支持添加字段
- def append(self, *keys):
- [self.fields.append(key) for key in keys]
5. 完善序列化
优化 1: 每一个模型如果需要序列化, 都要有 getitem 方法, 可以放到基类里面去
优化 2:default 函数, 是递归调用的, 只要遇到不能序列化的对象, 就会调用 default 函数. 所以如果有其他类型, 我们需要修改完善我们的 default 函数
优化 3: 我们的 default 函数需要增加容错性
- class JSONEncoder(_JSONEncoder):
- def default(self, o):
- if hasattr(o, 'keys') and hasattr(o, '__getitem__'):
- return dict(o)
- # 兼容其他的序列化
- if isinstance(o, date):
- return o.strftime('%Y-%m-%d')
- raise ServerError()
优化 4: 之前编写的新的 Flask 类, JsonEncoder 类都是不会轻易改变的, 但是 app.py 中的一些其他方法, 却是 经常改变的, 应该把他们放在 init 文件中
6.ViewModel 对于 API 有意义吗?
viewmodel 对于 API 来说, 特别是内部开发来说非常有意义
viewmodel 是为了我们的视图层, 提供个性化的试图模型. SQLALChemy 返回的模型是原始模型 (格式和数据库中存储的一模一样).
而前端可能需要我们返回一个意义更加明确的字段.
原始模型是根据数据库来生成的, 他的格式是一定的, 但是我们在视图层中或者 API 的返回中, 要根据业务去具体的个性化一个个属性的
格式, 这就必然存在一个由原始模型向视图模型转换的过程, 这个过程最适合的是在 View_model 中进行一个转换.
我们在视图层写转换的代码, 一来会污染视图层的代码, 二来会难以复用
并且有的试图模型可能会比较复杂, 设计到多个原始模型, 这个代码必定会比较复杂, 写在视图函数中就会非常不合适
对于完全严格意义上的 RESTFul,viewmodel 的意义并不大, 因为完全资源意义的 RESTFul 是不考虑业务逻辑的
来源: http://www.jianshu.com/p/9421ba40221f