Laravel-Auditing 中使用 UUID 作为用户标识的解决方案

问题背景

在 Laravel 项目中，当使用 OwenIt/Laravel-Auditing 包进行审计日志记录时，如果项目采用了 UUID 作为用户表的主键类型，可能会遇到审计日志中 user_id 和 user_type 字段无法正确记录的问题。这是一个常见的使用场景，特别是在现代应用中，UUID 因其全局唯一性而被广泛采用。

问题分析

通过分析问题描述，我们可以发现几个关键点：

1. 用户使用了 Laravel 9 和 Sanctum 认证
2. 所有表都使用了 UUID 作为主键
3. 审计日志中的其他字段都能正常记录，唯独 user_id 和 user_type 有问题
4. 手动设置这些字段可以正常工作

核心问题在于 Laravel-Auditing 包默认使用 getAuthIdentifier() 和 getMorphClass() 方法来获取用户标识和类型，但这些方法在 UUID 场景下可能无法按预期工作。

解决方案

1. 检查模型是否正确定义

首先确保用户模型正确实现了 UUID 特性：

use Illuminate\Database\Eloquent\Concerns\HasUuids;

class User extends Authenticatable
{
    use HasUuids;
    // 其他代码...
}

2. 自定义用户解析器

如果默认的用户解析器不适用于 UUID 场景，可以创建一个自定义解析器：

namespace App\Resolvers;

use OwenIt\Auditing\Contracts\UserResolver;

class UuidUserResolver implements UserResolver
{
    public static function resolve()
    {
        $user = auth()->user();
        
        if ($user) {
            return [
                'user_id' => $user->id,  // 直接使用 id 而非 getAuthIdentifier()
                'user_type' => get_class($user)
            ];
        }
    }
}

然后在 config/audit.php 中配置使用这个解析器：

'user' => [
    'resolver' => App\Resolvers\UuidUserResolver::class,
],

3. 修改审计表迁移

确保审计表的迁移文件正确设置了 UUID 类型的用户 ID 字段：

Schema::create('audits', function (Blueprint $table) {
    // 其他字段...
    $table->uuid('user_id')->nullable();
    $table->string('user_type')->nullable();
    // 其他字段...
});

4. 检查认证守卫

确认使用的认证守卫能正确返回用户对象。对于 API 使用 Sanctum 的情况，确保中间件正确配置：

'api' => [
    \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
    'throttle:api',
    \Illuminate\Routing\Middleware\SubstituteBindings::class,
],

深入理解

Laravel-Auditing 包默认使用 Laravel 的认证系统来获取当前用户。在标准情况下，getAuthIdentifier() 方法会返回用户的主键值。然而，当使用 UUID 时，这个方法可能不会返回预期的字符串格式，而是可能返回其他形式。

UUID 在数据库中的存储和检索方式可能与传统的自增 ID 不同，这可能导致一些 ORM 方法的行为不一致。特别是在使用 morph 关系时，确保类型和 ID 的匹配至关重要。

最佳实践

1. 一致性：在整个项目中保持一致的 ID 类型使用，要么全部使用自增 ID，要么全部使用 UUID
2. 测试：在修改用户解析器后，进行充分的测试，确保在各种场景下审计日志都能正确记录
3. 文档：在项目文档中明确记录这种自定义行为，方便后续维护
4. 监控：部署后监控审计日志的完整性，确保没有遗漏记录

总结

在 Laravel-Auditing 中使用 UUID 作为用户标识需要特别注意用户解析器的实现和数据库字段类型的匹配。通过创建自定义用户解析器或调整现有实现，可以解决审计日志中 user_id 和 user_type 记录不正确的问题。理解 Laravel 的认证系统和 Eloquent 的 morph 关系工作原理对于解决这类问题非常有帮助。