Laravel踩坑日记-消失的Pivot模型ID

前因

最近公司后端项目进行了改造升级,由之前的laravel5.6版本升级到了laravel5.8版本,升级后系统产生了不少SQL执行错误,但是在老版本系统运行的好好的,于是就产生了今日的扒坑之旅。

老系统(linux + laravel5.6 + php7.2 + mysql5.7)

升级后新系统(linux +laravel5.8 + php7.2 + mysql5.7)

只单纯升级了laravel框架版本,并无升级其他相关服务依赖.

但是却出现大量的SQL执行错误,异常监控如下:

导致这段服务出错的是这样的一段业务逻辑,下面通过一段demo来模拟.

$pivot = UserRole::firstOrCreate([
    'user_id' => 3,
    'role_id' => 3,
]);

$this->addRoleHistory($user,$pivot->id);

dd($pivot->id);

在laravel5.6版本中这段代码运行起来毫无问题,但升级到5.8版本中就会引发大量的SQL执行错误,就像下面这样.

laravel5.6:
    dd($pivot->id); //10002

laravel5.8:
    dd($pivot->id); //null

在5.6中保存中的数据还能正常获取到ID,在5.8中怎么就不行了呢,于是马上去查看了laravel5.8的发行说明,也没有发现对Pivot模型取消获取自增ID的改动,于是开始进行5.8源码查阅。。。

首先对5.6和5.8的firstOrCreate函数进行了对比,发现无改动,代码逻辑执行无误。

然后继续翻阅model->save()函数的代码
,发现不存在的数据是通过insertAndSetId该函数插入数据并设置主键ID

但insertAndSetId函数又是通过incrementing这样的一个成员属性来控制的,属性的默认值是true

当这个属性变更时就不会执行者一步骤,难道这个成员属性在被操作过了？

于是立马查看了5.8的pivot模型源码.

最终发现是5.8的在中间表Pivot Class默认将incrementing设置成了false,所以数据被成功插入,但是没有设置插入后的主键ID,造成剩余服务崩溃,没能正常运行...

在每个Pivot Class中重新覆盖掉incrementing属性值为true即可.

class UserRole extends Pivot
{
    public $incrementing = true;

    protected $fillable = [
        'user_id',
        'role_id',
    ];
}

修复后:

laravel5.8:
    dd($pivot->id); //10003

于是又去仔细看了一遍laravel5.7~laravel5.8发行说明,发现依然没有提到这个改动的原因,于是又去google了一遍,依然没有找到这个梗的原因所在.

最后还是成功修复掉了该处改动带来的问题,也提醒了我们在后续版本升级时还是需要多注重UT的覆盖及版本兼容改动测试,多个维度来保证项目质量。