ADR-002 - データベース抽象化

ADR-002: データベース抽象化

XOOPSのオブジェクト指向データベースアクセスパターンのアーキテクチャ決定記録

ステータス

承認 - XOOPS 2.0以来のコアパターン

コンテクスト

XOOPSはデータベース操作戦略が必要でした:

データベース固有SQL構文の抽象化
すべてのモジュール全体で一貫したCRUD操作を提供
自動的なデータサニタイゼーションとエスケーピング
将来のデータベースエンジン変更をサポート
開発者の共通操作を簡素化

代替案:

コード全体を通じたSQL
フル ORM(Doctrine、Eloquent)
カスタム軽量抽象化

決定図

graph TB
    subgraph "アプリケーション レイヤー"
        A[モジュール コード]
        B[ハンドラー メソッド]
    end

    subgraph "抽象化 レイヤー"
        C[XoopsObjectHandler]
        D[XoopsPersistableObjectHandler]
        E[条件 システム]
    end

    subgraph "データベース レイヤー"
        F[XoopsDatabase]
        G[MySQLDatabase]
        H[PDOラッパー]
    end

    subgraph "ストレージ"
        I[(MySQL/MariaDB)]
    end

    A --> B
    B --> C
    B --> D
    C --> E
    D --> E
    E --> F
    F --> G
    F --> H
    G --> I
    H --> I

決定

ハンドラーパターンを実装します。以下を含む:

1. XoopsObject - データコンテナ

各データエンティティはXoopsObjectを拡張:

class Item extends XoopsObject
{
    public function __construct()
    {
        $this->initVar('id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true, 255);
        $this->initVar('content', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('status', XOBJ_DTYPE_INT, 0, false);
    }
}

2. ハンドラー - 操作マネージャー

各オブジェクトは対応するハンドラーを持つ:

class ItemHandler extends XoopsPersistableObjectHandler
{
    public function __construct($db)
    {
        parent::__construct($db, 'mymodule_items', Item::class, 'id', 'title');
    }

    // 継承されたCRUDメソッド:
    // - create(), get(), insert(), delete()
    // - getObjects(), getCount(), getAll()
}

3. 条件 - クエリビルダー

オブジェクト指向クエリ条件:

$criteria = new CriteriaCompo();
$criteria->add(new Criteria('status', 1));
$criteria->add(new Criteria('created', time() - 86400, '>='));
$criteria->setSort('created');
$criteria->setOrder('DESC');
$criteria->setLimit(10);

$items = $handler->getObjects($criteria);

データ型定数

// 自動サニタイゼーション付きの変数タイプ
XOBJ_DTYPE_INT       // 整数
XOBJ_DTYPE_TXTBOX    // 単一行テキスト(エスケープ)
XOBJ_DTYPE_TXTAREA   // 複数行テキスト(エスケープ)
XOBJ_DTYPE_EMAIL     // メール検証
XOBJ_DTYPE_URL       // URL検証
XOBJ_DTYPE_ARRAY     // シリアライズ配列
XOBJ_DTYPE_OTHER     // 処理なし
XOBJ_DTYPE_FLOAT     // 浮動小数点

ハンドラー継承

classDiagram
    class XoopsObjectHandler {
        <<abstract>>
        #db: XoopsDatabase
        +create(): XoopsObject
        +get(id): XoopsObject
        +insert(object): bool
        +delete(object): bool
    }

    class XoopsPersistableObjectHandler {
        +getObjects(criteria): array
        +getCount(criteria): int
        +getAll(criteria): array
        +deleteAll(criteria): bool
        +updateAll(field, value, criteria): bool
    }

    class ItemHandler {
        +getPublishedItems(): array
        +getByCategory(catId): array
    }

    XoopsObjectHandler <|-- XoopsPersistableObjectHandler
    XoopsPersistableObjectHandler <|-- ItemHandler

結果

ポジティブ

一貫性: すべてのモジュールが同じパターンを使用
セキュリティ: 自動エスケーピングはSQL注入を防止
シンプルさ: 共通操作は最小限のコードを必要
保守性: データベースレイヤーへの変更はモジュールに影響しない
テスト可能性: ハンドラーはテスト用にモック可能

ネガティブ

パフォーマンス: 追加の抽象化オーバーヘッド
複雑さ: 新しい開発者の学習曲線
制限: 複雑なクエリは生SQLが必要
N+1問題: ビルトイン即時ロードなし

軽減策

パフォーマンス: よくアクセスされるオブジェクトをキャッシュ
複雑なクエリ: 必要に応じて生SQLを許可
N+1: 適切な条件でgetAll()を使用

XOOPS 4.0への進化

flowchart LR
    subgraph "現在 (2.5.x)"
        A[XoopsDatabase]
        B[ハンドラー]
        C[条件]
    end

    subgraph "将来 (4.0.x)"
        D[PDO/DBAL]
        E[リポジトリ パターン]
        F[クエリ ビルダー]
        G[DIコンテナ]
    end

    A --> D
    B --> E
    C --> F
    D --> G
    E --> G

XOOPS 4.0計画:

データベース抽象化用Doctrine DBAL
ハンドラーを置き換えるリポジトリパターン
複雑なクエリ用のクエリビルダー
フル PSR-11コンテナ統合

参照

Martin Fowler - エンタープライズアプリケーションアーキテクチャパターン
ドメイン駆動設計コンセプト
Active RecordおよびData Mapperパターン

#xoops #architecture #adr #database #handler #design-decision