Sqlalchemy 数据模型序列化（转JSON）

Sqlalchemy 可以很方便地做ORMapping，把数据库记录映射为业务实体类的实例，例如下面这样：

class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(100))
    city = db.Column(db.String(50))
    addr = db.Column(db.String(200))
    pin = db.Column(db.String(10))


if __name__ == '__main__':
    student = Student.query.get(1)
    

但这种实例不方便序列化，比如要想在 Flask Web Service 接口中返回这个对象：

@app.route('/demo/db', methods=['GET'])
def demo_db():
    student = Student.query.get(1)
    return jsonify(student)

或者是直接转 JSON 字符串：

import json

json.dumps(student)

都会报错：Object of type Student is not JSON serializable。

在网上搜的话，会有五花八门的答案，大部分都是让你实现某个类似 to_json 的方法，有些根本不管用，有些很麻烦。
其实最简单的解决方案就是：

用 python 3.7 引入的 dataclass 装饰器，这个装饰器帮我们实现了对应的方法，可以直接把类变量声明当做实例变量的定义：

from dataclasses import dataclass


@dataclass
class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(100))
    city = db.Column(db.String(50))
    addr = db.Column(db.String(200))
    pin = db.Column(db.String(10))

这时候，再调用 jsonify(student)就不会报错了，但奇怪的是，结果是个空对象：{}。
原来 dataclass 装饰器“认可”的字段声明，必须有 type annotation，改成下面这样：

from dataclasses import dataclass


@dataclass
class Student(db.Model):
    id: int = db.Column(db.Integer, primary_key=True)
    name: str = db.Column(db.String(100))
    city: str = db.Column(db.String(50))
    addr: str = db.Column(db.String(200))
    pin: str = db.Column(db.String(10))

输出结果就完美了：

{
  addr: "xxx",
  city: "bj",
  id: 1,
  name: "hui",
  pin: "xyz"
}

不过jsonify虽然可用了，json.dumps依然会报错，最简单的办法，是先把对象转为 dict，再转 json：

import json
from dataclasses import dataclass

print(json.dumps(dataclasses.asdict(student)))