Laravel ORM关联查询时binary(16)类型UUID匹配失败问题求解

直接修复当前问题 #

你只需要重写Account模型的关联查询主键取值逻辑，不需要修改原有关联定义：

1. 在Account模型中添加getKeyForRelation方法，该方法会在关联查询拼接条件时被调用，返回处理后的主键值：

// Account模型内添加
public function getKeyForRelation()
{
    return \DB::raw("UuidToBin('{$this->getKey()}')");
}

2. 原有关联定义保持不变即可，后续执行关联查询时就会自动在主键值外包裹UuidToBin函数，生成你期望的SQL语句。

如果需要同时处理单表查询的读写自动转换，可以在模型中补充访问器和修改器：

// 读取时自动转换binary为字符串UUID
public function getUuidAttribute($value)
{
    if (is_null($value)) return null;
    return \DB::selectOne("SELECT UuidFromBin(?) as uuid", [$value])->uuid;
}

// 写入时自动转换字符串UUID为binary
public function setUuidAttribute($value)
{
    $this->attributes['uuid'] = \DB::raw("UuidToBin('{$value}')");
}

更合理的UUID使用方案 #

依赖数据库自定义函数的方案兼容性较差，更推荐在PHP层完成所有格式转换：

1. 优先使用有序UUID生成，Laravel内置的Str::orderedUuid()方法生成的UUID是时间有序的，能避免普通UUID插入时的索引碎片化问题，大幅提升写入性能。
2. 编写通用的UUID转换Cast类，所有用到UUID的字段都可以复用：

// app/Casts/UuidBinary.php
namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class UuidBinary implements CastsAttributes
{
    public function get($model, string $key, $value, array $attributes): ?string
    {
        if (is_null($value)) return null;
        $hex = bin2hex($value);
        return vsprintf('%08s-%04s-%04s-%04s-%12s', str_split($hex, 4));
    }

    public function set($model, string $key, $value, array $attributes): ?string
    {
        if (is_null($value)) return null;
        return hex2bin(str_replace('-', '', $value));
    }
}

3. 在模型中注册Cast即可，不需要其他额外配置，关联查询、单表读写都会自动完成格式转换，不需要依赖数据库自定义函数：

// Account模型内配置
protected $primaryKey = 'uuid';
public $incrementing = false;
protected $keyType = 'string';

protected $casts = [
    'uuid' => \App\Casts\UuidBinary::class,
];

内容的提问来源于stack exchange，提问作者Phạm Tiến Hải