深入解析Stancl/Tenancy中防止时间戳自动写入JSON列的技术方案

在基于Stancl/Tenancy构建多租户应用时，开发者可能会遇到一个常见问题：模型的时间戳字段（created_at和updated_at）被自动包含在tenants表的data JSON列中。本文将深入探讨这一现象的技术原理，并提供多种解决方案。

技术背景

Stancl/Tenancy采用了独特的"混合列存储"设计模式。其核心机制是：

• 将租户模型的属性分为两类：标准数据库列和JSON序列化数据
• 通过getCustomColumns()方法定义哪些属性应存储为独立列
• 其余属性默认会被序列化到data JSON列中

问题本质

时间戳字段被自动包含进data列的现象源于Eloquent的默认行为与Tenancy特性的交互：

1. 默认情况下，Eloquent模型会自动维护时间戳
2. 如果未在getCustomColumns()中显式声明时间戳字段
3. 这些字段会被视为"普通属性"而被序列化到data列

解决方案

方案一：扩展自定义列配置

在Tenant模型中重写getCustomColumns()方法，明确包含时间戳字段：

public static function getCustomColumns(): array
{
    return [
        'id',
        'created_at',
        'updated_at',
        // 其他需要独立存储的字段...
    ];
}

方案二：禁用自动时间戳

如果应用不需要时间戳功能，可直接在模型中禁用：

public $timestamps = false;

方案三：自定义时间戳处理

对于需要精细控制的场景，可以结合两种方式：

public $timestamps = true; // 保持Eloquent时间戳功能

public static function getCustomColumns(): array
{
    return [
        'id',
        'created_at', // 显式声明存储为独立列
        'updated_at',
    ];
}

最佳实践建议

1. 明确性优先：建议始终在getCustomColumns()中显式声明所有需要独立存储的字段
2. 性能考量：频繁查询的字段应设为独立列，避免JSON解析开销
3. 数据一致性：重要字段（如外键、时间戳）推荐使用独立列保证数据完整性
4. 文档化：在模型中添加注释说明字段存储策略

架构思考

这种设计实际上提供了灵活的存储策略选择：

• 将频繁查询/过滤的字段设为独立列优化性能
• 将不常使用的元数据放入JSON列简化表结构
• 开发者可以根据具体业务需求在存储效率和查询性能之间取得平衡

通过理解这一机制，开发者可以更有效地设计多租户应用的数据存储结构，满足不同场景下的业务需求。