ORM全稱“Object Relational Mapping”，即物件-關係對映，就是把關係資料庫的一行對映為一個物件，也就是一個類對應一個表，這樣，寫程式碼更簡單，不用直接操作SQL語句。

要編寫一個ORM框架，所有的類都只能動態定義，因為只有使用者才能根據表的結構定義出對應的類來，使用 metaclass 。

編寫底層模組的第一步，就是先把呼叫介面寫出來。比如，使用者如果使用這個ORM框架，想定義一個User類來操作對應的資料庫表User，我們期待他寫出這樣的程式碼，用起來和litepal差不多：

class User(Model):
    id = IntegerField("id"
 
)
    username = StringField("username")
    password = StringField("password")
    email = StringField("email")


# 建立例項
u = User(id=1, username= "TaoYuan", password="123456", email="[email protected]")
u.save()  # 儲存到資料庫

其中，父類Model和屬性型別StringField、IntegerField是由ORM框架提供的，剩下的魔術方法比如save()全部由metaclass自動完成。雖然metaclass的編寫會比較複雜，但ORM的使用者用起來卻異常簡單。

實現

首先來定義Field類，它負責儲存資料庫表的欄位名和欄位型別：

class Field(object):
    def __init__(self, name, column_type):
        self.name = name
        self.column_type = column_type

    def __str__(self,):
        return "<%s:%s>" % (self.__class__.__name__, self.name)

在Field的基礎上，進一步定義各種型別的Field，比如StringField，IntegerField等等：

class IntegerField(Field):
    def __init__(self, name):
        super(IntegerField, self).__init__(name, "bigint")


class StringField(Field):
    def __init__(self, name):
        super(StringField, self).__init__(name, "varchar(20)")

就是編寫最複雜的ModelMetaclass以及Model了：

class ModelMetaclass(type):
    def __new__(mcs, name, bases, attrs):
        if name == "Model":
            return type.__new__(mcs, name, bases, attrs)
        print("Found Model:%s" % name)
        mappings = dict()
        for k, v in attrs.items():
            if isinstance(v, Field):
                print("Found mappings:%s --> %s" % (k, v))
                mappings[k] = v
        for k in mappings.keys():
            attrs.pop(k)
        attrs['__mappings__'] = mappings  # 儲存屬性和列的對映關係
        attrs['__table__'] = name  # 假設表名和類名一致
        return type.__new__(mcs, name, bases, attrs)


class Model(dict, metaclass=ModelMetaclass):
    def __init__(self, **kw):
        super(Model, self).__init__(**kw)

    def __getattr__(self, key):  # 屬性校驗
        try:
            return self[key]
        except KeyError:
            raise AttributeError(r"'Model' object has no attribute '%s'" % key)

    def __setattr__(self, key, value):  # set
        self[key] = value

    def save(self):  # 儲存
        fields = []
        params = []
        args = []
        for k, v in self.__mappings__.items():
            fields.append(v.name)
            params.append('?')
            args.append(getattr(self, k, None))

        # 連線資料庫驅動即可真正連線
        sql = "insert into %s (%s) values (%s)" % (self.__table__, ','.join(fields), ','.join(params))
        print('SQL: %s' % sql)
        print('ARGS: %s' % str(args))

    def delete(self):  # 刪
        # 連線資料庫驅動即可真正連線
        sql = "delete from %s" % self.__table__
        print('SQL: %s' % sql)

    def update(self):  # 改
        fields = []
        params = []
        args = []
        for k, v in self.__mappings__.items():
            fields.append(v.name)
            params.append('?')
            args.append(getattr(self, k, None))

        # 連線資料庫驅動即可真正連線
        sql = "update %s set %s=%s" % (self.__table__, ','.join(fields), ','.join(params))
        print('SQL: %s' % sql)
        print('ARGS: %s' % str(args))

    def find(self):  # 查
        # 連線資料庫驅動即可真正連線
        sql = "select * from %s" % self.__table__
        print('SQL: %s' % sql)

當用戶定義一個class User(Model)時，Python直譯器首先在當前類User的定義中查詢metaclass，如果沒有找到，就繼續在父類Model中查詢metaclass，找到了，就使用Model中定義的metaclass的ModelMetaclass來建立User類，也就是說，metaclass可以隱式地繼承到子類，但子類自己卻感覺不到。

在ModelMetaclass中，一共做了幾件事情：

1. 排除掉對Model類的修改；
2. 在當前類（比如User）中查詢定義的類的所有屬性，如果找到一個Field屬性，就把它儲存到一個__mappings__的dict中，同時從類屬性中刪除該Field屬性，否則，容易造成執行時錯誤（例項的屬性會遮蓋類的同名屬性）；
3. 把表名儲存到__table__中，這裡簡化為表名預設為類名。

在Model類中，就可以定義各種操作資料庫的方法，比如save()，delete()，find()，update等等。

我們實現了save()方法，把一個例項儲存到資料庫中。因為有表名，屬性到欄位的對映和屬性值的集合，就可以構造出INSERT語句。

得到輸出：

Found Model:User
Found mappings:id --> <IntegerField:id>
Found mappings:username --> <StringField:username>
Found mappings:password --> <StringField:password>
Found mappings:email --> <StringField:email>
SQL: insert into User (id,username,password,email) values (?,?,?,?)
ARGS: [1, 'TaoYuan', '123456', '[email protected]']
------------------------------
SQL: delete from User
------------------------------
SQL: update User set id,username,password,email=?,?,?,?
ARGS: [1, 'TaoYuan', '123456', '[email protected]']
------------------------------
SQL: select * from User

小結

metaclass是Python中非常具有魔術性的物件，它可以改變類建立時的行為。這種強大的功能使用起來務必小心。