| Flask | 您所在的位置：网站首页 › json格式数据如何转成对象 › Flask |
|
三种序列化方法为什么要进行序列化（将数据库取出的对象转化为JSON格式）第一种序列化方法:使用dict在模型内部构建一个规则方法，定义资源的模式第二种序列化方法：重写JSONEncoder实现自定义序列化1.为什么要重写JSONencoder？2.如何重写JSONEncoder？
三种序列化方法
在网络上找到的三种序列化方法如下： 在模型定义的时候给序列化的方法继承改写 flask 里面的 JSONEncoder类以及default方法使用Marshmallow 为什么要进行序列化（将数据库取出的对象转化为JSON格式）在Flask中，我们常常会选择采用RESTful设计风格，即在各个资源对应的GET、POST、PUT方法中，返回一个JSON格式的数据（资源）给前端使用。这就要求我们在（如get）方法中return一个dict，flask-restful会自动帮我们返回为一个JSON格式的数据。 而通过flask-SQLAlchemy这一ORM工具所构建的数据库表模型，通过其语句所取出的数据通常是object类型的，这一类型并不能直接在方法中return返回一个JSON格式，因此需要先对从数据库中取出的数据进行序列化，然后再return给前端。 第一种序列化方法:使用dict在模型内部构建一个规则方法，定义资源的模式该方法是由我们自己手动实现资源的序列化 下面就是一个完整的Model模型的构建，以及序列化实现： class Test(db.Model): # 表的字段构建 id = db.Column(db.BIGINT, primary_key=True, autoincrement=True) station_id = db.Column(db.String(20), nullable=False) datetime = db.Column(db.DateTime, nullable=False) m0 = db.Column(db.Float) # 模型的资源序列化函数（方法） # 在该函数中所返回的dict的keys，将是我们从test表里所序列化的字段 def test_schema(self): return { 'id': self.id, 'station_id': self.station_id, 'datetime': self.datetime, 'm0': self.m0 }上述代码便完成了准备工作，下面我们将展示如何应用，即在RESTful API中以JSON格式返回数据库表中取得的数据： class HelloWorld(Resource): def get(self): data = Test.query.first() # 取第一条数据 data_serialize = data.test_schema() # 通过我们之前在模型类里定义的序列化函数对取得数据进行序列化，此时 data_serialize 的类型是 dict return jsonify(data_serialize)以上就是第一种序列化方法的实现过程 给出完整代码： from flask import Flask as _Flask from flask import jsonify from flask_migrate import Migrate from flask_sqlalchemy import SQLAlchemy from flask_restful import Api, Resource from flask_marshmallow import Marshmallow app = _Flask(__name__) api = Api(app) ma = Marshmallow(app) # 配置数据库的地址 app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://XXX:XXX@localhost:3306/test' app.config['SQLALCHEMY_COMMIT_TEARDOWN'] = True app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True db = SQLAlchemy(app) migrate = Migrate(app, db) class Test(db.Model): # 表的字段构建 id = db.Column(db.BIGINT, primary_key=True, autoincrement=True) station_id = db.Column(db.String(20), nullable=False) datetime = db.Column(db.DateTime, nullable=False) m0 = db.Column(db.Float) # 模型的资源序列化函数（方法） # 在该函数中所返回的dict的keys，将是我们从test表里所序列化的字段 def test_schema(self): return { 'id': self.id, 'station_id': self.station_id, 'datetime': self.datetime, 'm0': self.m0 } class HelloWorld(Resource): def get(self): data = Test.query.first() # 取第一条数据 data_serialize = data.test_schema() # 通过我们之前在模型类里定义的序列化函数对取得数据进行序列化，此时 data_serialize 的类型是 dict return jsonify(data_serialize) api.add_resource(HelloWorld, '/') if __name__ == '__main__': app.run(debug=True)最终结果展示： ip地址：http://localhost:5000/ 返回JSON字符串： { "datetime": "Sun, 01 Jul 2018 00:00:00 GMT", "id": 1, "station_id": "54511" } 第二种序列化方法：重写JSONEncoder实现自定义序列化 1.为什么要重写JSONencoder？本方法中我们采用json.dumps()来将取出的数据序列化成json字符串 通过查看json包中的def dumps()源码我们可以得知，我们在调用json.dumps()方法时默认会使用JSONEncoder进行序列化，传入cls参数后可以使用自定义的序列化方法（即我们重写的JSONEncoder）。源码如下（json/_init_.py）： def dumps(obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw): # 以下是关于cls参数的使用介绍 """ To use a custom ``JSONEncoder`` subclass (e.g. one that overrides the ``.default()`` method to serialize additional types), specify it with the ``cls`` kwarg; otherwise ``JSONEncoder`` is used. 翻译： 如果要使用自定义的“JSONEncoder”子类 （例如，重写 default() 方法来序列化其他类型的数据）， 请使用使用“cls”关键字参数；否则默认使用“JSONEncoder”。 """ # 部分源码：可以看出如果传入了 cls ，就会按照你重写的方法执行 if cls is None: cls = JSONEncoder return cls( skipkeys=skipkeys, ensure_ascii=ensure_ascii, check_circular=check_circular, allow_nan=allow_nan, indent=indent, separators=separators, default=default, sort_keys=sort_keys, **kw).encode(obj)而原有JSONEncoder的default()方法是不能够对对象进行序列化的，因此需要我们自己重写default()方法，然后在调用json.dumps()时通过cls参数传进去。 2.如何重写JSONEncoder？先看完整代码： from flask import Flask as _Flask from flask_migrate import Migrate from flask_sqlalchemy import SQLAlchemy from flask_restful import Api, Resource from flask_marshmallow import Marshmallow from flask.json import JSONEncoder as _JSONEncoder from datetime import date import json app = _Flask(__name__) api = Api(app) ma = Marshmallow(app) # 配置数据库的地址 app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://xxx:xxxxxx@localhost:3306/test' app.config['SQLALCHEMY_COMMIT_TEARDOWN'] = True app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True db = SQLAlchemy(app) migrate = Migrate(app, db) 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 %H:%M:%S') return json.JSONEncoder.default(self, o) class Flask(_Flask): json_encoder = JSONEncoder class Test(db.Model): id = db.Column(db.BIGINT, primary_key=True, autoincrement=True) name = db.Column(db.String(20), nullable=False) def keys(self): return ['id', 'name'] def __getitem__(self, item): return getattr(self, item) class HelloWorld(Resource): def get(self): test_data = Test.query.all() data_json = json.loads(json.dumps(test_data, cls=JSONEncoder)) return data_json api.add_resource(HelloWorld, '/') if __name__ == '__main__': app.run(debug=True)代码分析 JSONEncoder类的default与原先default写法类似，继承原JSONEncoder类，添加一个针对对象的if处理即可： if hasattr(o, 'keys') and hasattr(o, '__getitem__'): return dict(o)判断：如果传入的对象o存在keys和__getitem__属性（即我们在模型Test类中定义的两个方法），则表明传入对象o是模型对象，把对象o传给dict()。 dict函数的特殊之处在于，当一个对象传入后，dict会去调用keys函数（模型Test类中定义的方法），keys方法的目的是拿到我们自定义的所有字典里的键。 dict会以中括号的形式来拿到对应键的值，如o[‘id’]，但是默认不能这样访问，这就是__getitem__方法的作用了。 用法： class HelloWorld(Resource): def get(self): test_data = Test.query.all() data_json = json.loads(json.dumps(test_data, cls=JSONEncoder)) return data_json在这里，我们对序列化后的数据又进行了一次json.loads，原因在于： 如果不loads，最终返回的JSON字符串是这样的： "[{\"id\": 1, \"name\": \"qq\"}, {\"id\": 2, \"name\": \"ww\"}, {\"id\": 3, \"name\": \"ee\"}]"我猜测可能是进行了2次序列化后的结果，因此再loads一次，就可以恢复正常了： 最终返回结果如下 [ { "id": 1, "name": "qq" }, { "id": 2, "name": "ww" }, { "id": 3, "name": "ee" } ]注意： 由于我们重写了JSONEncoder类的defualt方法，所以需要将自己的JSONEncoder类顶替掉Flask.JSON下的原有类。 相关代码： from flask import Flask as _Flask from flask.json import JSONEncoder as _JSONEncoder class Flask(_Flask): json_encoder = JSONEncoder参考文献: Flask Web开发实战 入门、进阶与原理解析 Grey Li:https://helloflask.com/book/ https://www.cnblogs.com/fiona-zhong/p/10245736.html https://www.jianshu.com/p/47f7ab413ed7 https://cloud.tencent.com/developer/article/1336197 |
| CopyRight 2018-2019 实验室设备网 版权所有 |