Craft CMS 5.x 版本中自定义字段查询的现代化改造

背景介绍

在Craft CMS 5.x版本中，系统对内容存储机制进行了重大重构，这直接影响了开发者处理自定义字段查询的方式。本文将从技术角度深入分析这一变化，并提供详细的迁移方案。

存储架构的重大变更

Craft CMS 5.x版本对元素内容存储机制进行了根本性的改变：

1. 废弃了分列存储模式：不再为每个自定义字段创建单独的数据库列
2. 采用JSON存储：所有自定义字段内容现在统一存储在elements_sites表的content列中，采用JSON格式
3. 移除了columnSuffix属性：这个在4.x版本中用于标识字段列名的属性已被弃用

查询方式的演进

旧版查询方式（4.x及之前）

在4.x版本中，开发者可以通过以下方式获取字段列名：

$releaseDateColumnName = ElementHelper::fieldColumnFromField(
    Craft::$app->getFields()->getFieldByHandle('releaseDate')
);

这种方式会返回类似field_releaseDate_jwzcxmze的列名，可直接用于SQL查询。

新版查询方式（5.x）

5.x版本引入了全新的查询机制：

1. getValueSql()方法：每个字段对象现在提供这个方法，它会生成访问该字段值的SQL片段
2. JSON路径查询：生成的SQL会使用PostgreSQL的JSON操作符来提取特定字段的值

例如，对于日期字段，getValueSql()可能生成如下SQL：

COALESCE(("elements_sites"."content"#>>'{"590ad414-264f-452a-82f1-f2d4d1eb8991","date"}'), 
("elements_sites"."content"#>>'{"590ad414-264f-452a-82f1-f2d4d1eb8991"}'))

实际迁移示例

以下是一个完整的产品查询示例，展示了如何从4.x迁移到5.x：

// 获取字段布局和字段对象
$fieldLayout = Commerce::getInstance()->getProductTypes()
    ->getProductTypeByHandle('products')
    ->getFieldLayout();

$isDeactivatedField = $fieldLayout->getFieldByHandle('isDeactivated');
$releaseDateField = $fieldLayout->getFieldByHandle('releaseDate');
$bookTypeField = $fieldLayout->getFieldByHandle('bookType');

// 构建查询
$command = Craft::$app->db->createCommand(sprintf(<<<EOD
WITH products AS (
    SELECT DISTINCT p.id, MAX(elements_sites.title) as title, %s
    FROM commerce_products as p
    INNER JOIN commerce_variants v on p.id = v."productId"
    INNER JOIN elements e on p."id" = e."id"
    INNER JOIN elements_sites on elements_sites."elementId" = e."id"
    INNER JOIN relations r on v."id" = r."sourceId"
    WHERE %s = false
      AND e."dateDeleted" IS NULL
      AND r."targetId" = :programArea
      AND %s <= now()
      %s
    ORDER BY %s, title
)
SELECT *, COUNT(*) OVER() as total FROM products OFFSET :offset LIMIT :limit;
EOD,
    $selectColumns,
    $isDeactivatedField->getValueSql(),
    $releaseDateField->getValueSql(),
    $bookTypes ? sprintf('AND %s IN (%s)',
        $bookTypeField->getValueSql(),
        implode(',', array_map(fn($t) => "'$t'", $bookTypes))
    ) : '',
    $orderBy
), [
    ':programArea' => $programArea,
    ':offset' => $offset,
    ':limit' => $limit,
]);

关键注意事项

1. 表结构变化：

   • 移除了content表
   • 标题字段现在存储在elements_sites表中

2. 查询优化：

   • 确保使用正确的表关联
   • 注意elements_sites表不应使用别名，或只能使用elements_sites作为别名

3. 性能考量：

   • JSON查询可能比直接列访问稍慢
   • 考虑为常用查询字段添加GIN索引

总结

Craft CMS 5.x的内容存储机制变革代表了向更现代化、更灵活的架构演进。虽然这种变化需要开发者调整现有的查询方式，但它为系统带来了更好的扩展性和维护性。通过使用新的getValueSql()方法，开发者可以构建出既符合新架构又能保持高效执行的查询语句。