萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

web.py 實現類 Django ORM 查詢:元類自動注入 objects 管理器

Django ORM 的 Model.objects.all()、.get()、.filter() 極具表達力。本文展示如何在 web.py + web.database 基礎上,透過元類 ModelMetaClass 在模型類定義時自動注入 objects 管理器,實現零樣板碼的 Active Record 風格查詢。

核心架構

  1. Model 基類:定義 insert/delete/save 實例方法,操作對應表。
  2. ModelDefaultManager:實現 all()、get()、filter() 類級查詢。
  3. ModelMetaClass:類建立時自動建立 Manager 實例綁定為 cls.objects。

完整實現代碼


# -*- coding: utf-8 -*-
import web
import config

def _connect_to_db():
    return web.database(dbn="sqlite", db=config.dbname)

def init_db():
    db = _connect_to_db()
    for stmt in config.sql_statements:
        db.query(stmt)

class ModelError(Exception):
    def __init__(self, msg=""): self.msg = msg
    def __str__(self): return "ModelError: %s" % self.msg

class ModelDefaultManager(object):
    def __init__(self, cls):
        self.cls = cls
        self._table_name = cls.__name__.lower()

    def all(self):
        db = _connect_to_db()
        results = db.select(self._table_name)
        return [self.cls(x) for x in results]

    def get(self, query_vars, where):
        results = self.filter(query_vars, where, limit=1)
        return results[0] if results else None

    def filter(self, query_vars, where, limit=None):
        db = _connect_to_db()
        try:
            results = db.select(self._table_name, vars=query_vars, where=where, limit=limit)
        except Exception as e:
            raise ModelError(str(e))
        return [self.cls(x) for x in results]

class ModelMetaClass(type):
    def __new__(cls, classname, bases, attrs):
        new_class = super(ModelMetaClass, cls).__new__(cls, classname, bases, attrs)
        objects = ModelDefaultManager(new_class)
        setattr(new_class, "objects", objects)
        return new_class

class Model(object):
    __metaclass__ = ModelMetaClass

    def __init__(self): pass

    def _table_name(self):
        return self.__class__.__name__.lower()

    def insert(self, **kargs):
        db = _connect_to_db()
        try:
            with db.transaction():
                db.insert(self._table_name(), **kargs)
        except Exception as e:
            raise ModelError(str(e))

    def delete(self, where, using=None, vars=None):
        db = _connect_to_db()
        try:
            with db.transaction():
                db.delete(self._table_name(), where, vars=vars)
        except Exception as e:
            raise ModelError(str(e))

    def save(self, where, vars=None, **kargs):
        db = _connect_to_db()
        try:
            with db.transaction():
                db.update(self._table_name(), where, vars, **kargs)
        except Exception as e:
            raise ModelError(str(e))

使用範例


class Question(Model):
    pass  # 欄位由資料庫 schema 決定,或在 __init__ 宣告

# 類級查詢
questions = Question.objects.all()
q = Question.objects.get({}, "id=1")
recent = Question.objects.filter({}, "pub_date > '2023-01-01'", limit=10)

# 實例操作
q = Question()
q.insert(question_text="How?", pub_date="2023-06-01")
q.save("id=1", question_text="Updated?")
q.delete("id=1")

關鍵設計解析

組件職責關鍵點
ModelMetaClass.__new__類建立時注入 objects在 super().__new__ 之後、返回前操作 new_class
ModelDefaultManager封裝查詢邏輯持有 cls 參考,自動推導表名 cls.__name__.lower()
Model 實例方法增刪改用 web.database 事務 with db.transaction()

擴充方向

  • 欄位定義與驗證:class Question(Model): question_text = CharField(max_length=200)
  • 關聯:ForeignKey、ManyToManyField 描述關係,Manager 自動生成 select_related。
  • 查詢集 QuerySet:鏈式 filter().exclude().order_by() 惰性執行。
  • 遷移工具:根據模型定義生成 DDL。

何時自製 vs 用 SQLAlchemy

  • 自製:輕量專案、學習 ORM 原理、極簡依賴、特殊資料庫不支援 SQLAlchemy。
  • SQLAlchemy:成熟生態、關聯/遷移/查詢優化完備、團隊協作標準。

元類注入 Manager 是 Django ORM 的核心魔法之一,理解此機制能讓你在任何輕量框架中快速構建領域模型層,也能更深入地理解重型 ORM 內部運作。

copyright © 萬盛學電腦網 all rights reserved