如何定义模型复合主键

[huangdijia]

• student_scores 成绩表

student_id	class_id	score
1001	1	90
1002	1	100
1001	2	91
1002	2	92

假设有这样一张表，设计的时候使用的不是自增主键 id，而是用联合主键 student_id+class_id。

现有需求，为 1001 每一科加 5 分（不要问为什么，产品的需求就是这么任性，哈哈），可是现有模型只支持单一主键，怎么办呢？

别慌，很简单，我们先定义一个 trait

<?php

namespace App\Traits\Model;

trait HasCompositePrimaryKey
{
    /**
     * Get the value indicating whether the IDs are incrementing.
     *
     * @return bool
     */
    public function getIncrementing()
    {
        return false;
    }

    /**
     * @return array
     */
    public function getKey()
    {
        $attributes = [];
        foreach ($this->getKeyName() as $key) {
            $attributes[$key] = $this->getAttribute($key);
        }

        return $attributes;
    }

    /**
     * Set the keys for a save update query.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    protected function setKeysForSaveQuery($query)
    {
        foreach ($this->getKeyName() as $key) {
            if ($this->$key) {
                $query->where($key, '=', $this->$key);
            } else {
                throw new \Exception(__METHOD__ . 'Missing part of the primary key: ' . $key);
            }
        }

        return $query;
    }
}

使用也很简单：

namespace App\Model;

use App\Traits\Model\HasCompositePrimaryKey;

class StudentScore extends Model
{
    use HasCompositePrimaryKey;
    // 其他代码省略
    protected $primaryKey = ['student_id', 'class_id'];
}

那么好，现在就来实现需求吧：

use App\Model\StudentScore;

StudentScore::query()->where('student_id', 1001)->get()->each(function($item) {
    $item->increment('score', 5); // sql: update student_scores set score=score+5 where student_id=1001 and class_id=1;
});

事情还没完，需求虽然实现了，但是看控制台输出，有很多 notice

Notice: Array to string conversion in /Users/xxx/test/vendor/hyperf/model-cache/src/Manager.php on line 238
PHP Notice: Array to string conversion in /Users/xxx/test/vendor/hyperf/model-cache/src/Manager.php on line 238

很显然，model-cache 不支持符合主键。

这里我给出我的解决方案，也是最简单的解决方案：针对这个 Model 移除 model-cache 功能。因为 project 在创建的时候自动生成的 app/Model/Model.php 里是默认 use Cacheable 了，那么只要 StudentScore 不要继承 app\Model\Model，直接继承 \Hyperf\DbConnection\Model\Model 就好了。

namespace App\Model;

use App\Traits\Model\HasCompositePrimaryKey;

class StudentScore extends \Hyperf\DbConnection\Model\Model
{
    use HasCompositePrimaryKey;
    // 其他代码省略
    protected $primaryKey = ['student_id', 'class_id'];
}

[Linij]

很实用啊

[huangdijia]

跟model-cache有冲突，大家慎用。