Laravel Auditing 包处理 MySQL Point 类型字段的问题分析

在 Laravel 项目中，使用 owen-it/laravel-auditing 包进行模型审计时，遇到 MySQL 的 Point 类型字段会出现数据无法正确记录的问题。本文将深入分析这一问题的原因，并提供解决方案。

问题现象

当模型包含 MySQL 的 Point 类型字段时，使用 laravel-auditing 包会出现以下两种异常情况：

1. 当创建或编辑包含 Point 字段的模型时，审计记录中的 new_values 和 old_values 会变成空数组，导致空间数据变更无法被记录。

2. 当尝试删除包含 Point 字段的模型时，系统会抛出 JSON 编码异常："Unable to encode attribute [old_values] for model [OwenIt\Auditing\Models\Audit] to JSON: Malformed UTF-8 characters, possibly incorrectly encoded"。

问题根源

这个问题的本质在于 MySQL 的 Point 类型是一种空间数据类型，它存储的是二进制格式的几何数据。当 laravel-auditing 包尝试将这些二进制数据转换为 JSON 格式存储时，会遇到以下障碍：

1. 二进制数据包含非 UTF-8 字符，无法直接 JSON 编码
2. Eloquent 模型默认没有提供 Point 类型的原生转换支持
3. 审计包在记录变更时，没有对特殊数据类型做特殊处理

解决方案

方案一：使用自定义 Casts

最优雅的解决方案是为 Point 类型创建自定义的 Casts 类：

namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class PointCast implements CastsAttributes
{
    public function get($model, $key, $value, $attributes)
    {
        // 从数据库读取时转换为可用的格式
        return $value ? unpack('x/x/x/x/corder/Ltype/dlat/dlon', $value) : null;
    }

    public function set($model, $key, $value, $attributes)
    {
        // 存储到数据库时转换为二进制
        return $value ? pack('xxxxcLdd', 0, 0, 0, 0, 1, 1, $value['lat'], $value['lon']) : null;
    }
}

然后在模型中配置：

protected $casts = [
    'location' => PointCast::class,
];

方案二：使用访问器/修改器

如果不想创建单独的 Casts 类，可以使用模型中的访问器和修改器：

public function getLocationAttribute($value)
{
    return $value ? [
        'lat' => unpack('d', substr($value, 4, 8))[1],
        'lon' => unpack('d', substr($value, 12, 8))[1]
    ] : null;
}

public function setLocationAttribute($value)
{
    $this->attributes['location'] = $value ? pack('dd', $value['lat'], $value['lon']) : null;
}

方案三：转换为独立字段

如果空间数据处理需求不复杂，可以考虑将 Point 字段拆分为独立的纬度和经度字段：

// 迁移文件
$table->decimal('latitude', 10, 7);
$table->decimal('longitude', 10, 7);

这种方法虽然失去了空间索引的优势，但简化了数据存储和审计过程。

最佳实践建议

1. 对于复杂的空间数据操作，推荐使用自定义 Casts 方案，它提供了更好的封装性和复用性。

2. 如果项目中有多个模型使用 Point 字段，可以创建一个基础模型或 Trait 来统一处理空间数据的转换逻辑。

3. 考虑在审计事件中添加特殊处理，确保空间数据的变更能够被正确记录：

public static function boot()
{
    parent::boot();
    
    static::updated(function ($model) {
        if ($model->isDirty('location')) {
            // 特殊处理空间字段变更
        }
    });
}

通过以上解决方案，可以确保 laravel-auditing 包能够正确处理 MySQL 的 Point 类型字段，完整记录模型变更历史。