SQLAlchemy - 用 Mixin / Custom Base Classes 撰寫好維護的 ORM

越是使用 SQLAlchemy 就會越是發現 SQLAlchemy 在 Python ORM 的用心，例如 Mixin and Custom Base Classes 讓我們能夠將常見的資料庫欄位或者功能放在一起，變成 Mixin 類別(class) ，只要繼承該 Mixin 就能夠獲得相同的欄位與功能，減少重複的程式並提高可維護性( Djano 的 view 也有類似的作法，詳見 Using mixins with class-based views )。

Mixin 類別的應用 #

資料表經常會有 created_at updated_at 等欄位，用以紀錄資料的新增、修改時間，與其每個 Model 都要複製貼上一次，不如將這些常見的欄位變成 Mixin 類別，如此一來只要繼承該類別就能夠獲得相同的欄位。

範例：

from sqlalchemy import create_engine
from sqlalchemy import Column, String, Integer, DateTime
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()


class TimestampMixin(object):
    created_at = Column(DateTime)
    updated_at = Column(DateTime)


class User(Base, TimestampMixin):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    username = Column(String)
    password = Column(String)
    

engine = create_engine('sqlite:///:memory:', echo=True)
Base.metadata.create_all(engine)
Session = sessionmaker(bind=engine)
session = Session()

上述範例 User Model 由於繼承了 TimestampMixin ，因此繼承 created_at 與 updated_at 欄位，可以從 SQLAlchemy 執行過程發現建立 user 資料表時多了 created_at 與 updated_at 欄位：

CREATE TABLE user (
	created_at DATETIME, 
	updated_at DATETIME, 
	id INTEGER NOT NULL, 
	name VARCHAR, 
	username VARCHAR, 
	password VARCHAR, 
	PRIMARY KEY (id)
)

ForeignKey 的 Mixin #

Foreigkey 在 SQLAlchemy 中也能夠被放進 Mixin 類別之中，不過必須使用 @declared_attr 裝飾子宣告：

from sqlalchemy import ForeignKey
from sqlalchemy.ext.declarative import declared_attr
from sqlalchemy.orm import relationship


class UserMixin(object):
    @declared_attr
    def user_id(self):
        return Column(
            String,
            ForeignKey('user.id'),
            nullable=False
        )

    @declared_attr
    def user(self):
        return relationship('User')

    
class Book(Base, UserMixin):
    __tablename__ = 'book'
    id = Column(Integer, primary_key=True)
    title = Column(String)

結語 #

除了本文所敘述的 Mixin 功能之外，Mixin and Custom Base Classes 一文中詳述更多關於 Mixin 的應用與解說，如果有興趣的話，可以花些時間細細閱讀，應該可以發現不少有趣的用法！

Happy Coding!

References #

https://docs.sqlalchemy.org/en/latest/orm/extensions/declarative/mixins.html#mixin-and-custom-base-classes