在Filament-Shield中使用Ulid作为用户ID的注意事项

Filament-Shield是一个基于Laravel Permission包的角色权限管理插件。当开发者使用Ulid作为用户模型的主键类型时，可能会遇到一些数据库迁移和模型关联的问题。

问题现象

在安装Filament-Shield插件时，如果用户模型使用Ulid作为主键类型，可能会遇到以下错误：

SQLSTATE[01000]: Warning: 1265 Data truncated for column 'model_id' at row 1

这是因为Filament-Shield默认生成的model_has_roles表中的model_id字段是BIGINT类型，而Ulid生成的ID是字符串类型，导致数据类型不匹配。

解决方案

要解决这个问题，需要修改Laravel Permission包的配置，使其支持Ulid作为主键类型。以下是具体步骤：

1. 首先需要确保Laravel Permission包已正确配置为使用Ulid。这可以通过在AppServiceProvider的boot方法中添加以下代码实现：

use Illuminate\Support\ServiceProvider;
use Spatie\Permission\PermissionServiceProvider;

public function boot()
{
    $this->app->extend(PermissionServiceProvider::class, function ($service, $app) {
        return new class($app) extends PermissionServiceProvider {
            protected function registerModelBindings()
            {
                $this->app->bind(
                    \Spatie\Permission\Contracts\Permission::class,
                    \App\Models\Permission::class
                );
                
                $this->app->bind(
                    \Spatie\Permission\Contracts\Role::class,
                    \App\Models\Role::class
                );
            }
        };
    });
}

2. 创建自定义的Permission和Role模型，并设置$keyType和$incrementing属性：

namespace App\Models;

use Spatie\Permission\Models\Permission as SpatiePermission;

class Permission extends SpatiePermission
{
    protected $keyType = 'string';
    public $incrementing = false;
}

namespace App\Models;

use Spatie\Permission\Models\Role as SpatieRole;

class Role extends SpatieRole
{
    protected $keyType = 'string';
    public $incrementing = false;
}

3. 修改Filament-Shield生成的迁移文件，将model_has_roles表中的model_id字段类型改为字符串：

$table->string('model_id');

深入理解

Ulid是一种比UUID更适合作为数据库主键的标识符类型，它具有以下特点：

• 按时间排序
• 128位兼容性
• 48位时间戳+80位随机数
• 26个字符的字符串表示

当使用Ulid作为主键时，需要注意以下几点：

1. 所有关联表的外键字段类型必须与主键类型匹配
2. 模型需要明确声明$keyType和$incrementing属性
3. 迁移文件中相关字段类型需要调整为字符串类型

最佳实践

对于使用Filament-Shield的项目，如果决定使用Ulid作为用户ID，建议：

1. 在项目初期就进行相关配置
2. 创建自定义的Permission和Role模型
3. 修改所有相关的外键字段类型
4. 在模型工厂中正确处理Ulid生成

通过以上配置，Filament-Shield可以完美支持使用Ulid作为用户ID的场景，为应用提供更灵活的主键选择方案。