Laravel模型获取外键方法解析

在使用 Laravel Eloquent ORM 进行开发时，如何获取模型的外键信息？本文深入探讨了两种主要策略，助你轻松应对。第一种方法，无需修改模型，通过调用模型关系方法（如 `belongsTo`）返回的关系对象，利用 `getForeignKeyName()` 方法获取外键名称。第二种方法，则是在模型中定义受保护的 `$foreignKeys` 属性，集中管理外键信息，并提供 `getForeignKeys()` 辅助方法进行检索。理解 Laravel Eloquent 的设计哲学，选择最适合你的策略，提升代码可维护性和开发效率，让你的 Laravel 项目更上一层楼。

理解 Laravel Eloquent 与外键

Laravel 的 Eloquent ORM 以其简洁和“约定优于配置”的特性而闻名，它能以极少的配置将数据库表映射到 PHP 模型。然而，这种高度抽象的便利性也意味着 Eloquent 模型本身并不会自动“知道”或存储其所有关联的外键信息。当您定义一个 belongsTo 关系时，Eloquent 内部知道如何根据您提供的列名或约定来构建查询，但模型实例本身并不提供一个直接的方法来列出所有定义的外键。

尽管如此，我们仍然可以通过几种策略来获取模型的外键信息。

策略一：通过关系对象获取外键名称

当您在 Eloquent 模型中定义一个关系方法（例如 belongsTo 或 hasMany）时，调用该方法并不会立即返回关联模型实例，而是返回一个关系对象（如 Illuminate\Database\Eloquent\Relations\BelongsTo）。这些关系对象封装了关系的逻辑，并且包含获取其外键名称的方法。

对于 BelongsTo 关系，您可以利用其 getForeignKeyName() 方法来获取关联的外键列名。

示例代码：

假设我们有一个 Grades 模型，它与 Student 和 Subject 模型存在 belongsTo 关系，定义如下：

// app/Models/Grades.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Grades extends Model
{
    public function student()
    {
        return $this->belongsTo(Student::class, 'student_id', 'id');
    }

    public function subject()
    {
        return $this->belongsTo(Subject::class, 'subject_id', 'id');
    }
}

要获取这些关系的外键名称，您可以这样做：

use App\Models\Grades;

$grade = Grades::first(); // 获取一个 Grades 实例

if ($grade) {
    $foreignKeys = [];
    // 调用关系方法，获取关系对象，然后调用 getForeignKeyName()
    $foreignKeys[] = $grade->student()->getForeignKeyName();
    $foreignKeys[] = $grade->subject()->getForeignKeyName();

    print_r($foreignKeys);
    /* 预期输出:
    Array
    (
        [0] => student_id
        [1] => subject_id
    )
    */
}

优点：

• 无需修改模型： 这种方法不需要对现有模型结构进行任何更改。
• 直接从关系定义中提取： 它直接利用了您在关系方法中定义的信息。

缺点：

• 非自动化： 您需要手动调用每个关系方法来获取其对应的外键。如果模型有大量关系，这会比较繁琐。
• 需要模型实例： 必须先获取一个模型实例才能调用其关系方法。

策略二：在模型中集中管理外键

如果您能够修改模型文件，那么一个更系统和可维护的方法是在模型中定义一个受保护的属性来存储外键的映射关系，并创建一个辅助方法来检索这些外键。这使得外键信息成为模型自身的一部分，易于管理和访问。

示例代码：

修改 Grades 模型，添加一个 protected $foreignKeys 属性和 getForeignKeys() 方法：

// app/Models/Grades.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Grades extends Model
{
    /**
     * 定义模型的外键及其对应的关系名称。
     *
     * @var array
     */
    protected $foreignKeys = [
        'student' => 'student_id',
        'subject' => 'subject_id'
    ];

    public function student()
    {
        // 使用 $this->foreignKeys['student'] 来定义外键
        return $this->belongsTo(Student::class, $this->foreignKeys['student'], 'id');
    }

    public function subject()
    {
        // 使用 $this->foreignKeys['subject'] 来定义外键
        return $this->belongsTo(Subject::class, $this->foreignKeys['subject'], 'id');
    }

    /**
     * 获取模型定义的所有外键名称。
     *
     * @return array
     */
    public function getForeignKeys()
    {
        return array_values($this->foreignKeys);
    }
}

现在，您可以轻松地从模型实例中获取所有外键：

use App\Models\Grades;

$grades = new Grades();
$allForeignKeys = $grades->getForeignKeys();

print_r($allForeignKeys);
/* 预期输出:
Array
(
    [0] => student_id
    [1] => subject_id
)
*/

优点：

• 集中管理： 所有外键定义集中在一个地方，易于维护和查看。
• 易于检索： 通过一个简单的辅助方法即可获取所有外键。
• 单一事实来源： foreignKeys 属性可以作为关系定义的外键来源，减少重复和潜在错误。

缺点：

• 需要修改模型： 如果您无法修改模型文件，则此方法不适用。
• 手动维护： 每次添加或修改关系时，都需要手动更新 $foreignKeys 属性。

总结与注意事项

Laravel Eloquent ORM 的设计哲学决定了它不会自动提供一个方法来列出模型的所有外键。这是因为 Eloquent 主要关注对象关系映射，而不是完整的数据库模式内省。

• 如果您需要在不修改模型代码的情况下动态获取外键，策略一（通过关系对象）是唯一的选择，尽管它需要您遍历每个关系。
• 如果您可以修改模型并且希望有一个更清晰、更易于管理和检索外键的方式，策略二（在模型中定义 foreignKeys 属性）是一个更推荐的工程实践。它将外键信息作为模型自身的一部分，提高了代码的可读性和可维护性。

在实际开发中，根据项目需求和对模型修改的权限，选择最适合您的策略。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~