Eloquent：入门指南

简介
生成模型类
Eloquent 模型约定
检索模型
检索单个模型 / 聚合
- 检索或创建模型
- 检索聚合
插入和更新模型
- 插入
- 更新
- 批量赋值
- Upserts
删除模型
- 软删除
- 查询软删除模型
剪枝模型
复制模型
查询作用域
比较模型
事件

简介

Laravel 包括 Eloquent，一个对象关系映射器 (ORM)，使与数据库交互变得愉快。当使用 Eloquent 时，每个数据库表都有一个对应的“模型”，用于与该表交互。除了从数据库表中检索记录外，Eloquent 模型还允许您从表中插入、更新和删除记录。

在开始之前，请确保在应用程序的 config/database.php 配置文件中配置数据库连接。有关配置数据库的更多信息，请查看数据库配置文档。

生成模型类

要开始使用，让我们创建一个 Eloquent 模型。模型通常位于 app\Models 目录中，并扩展 Illuminate\Database\Eloquent\Model 类。您可以使用 make:model Artisan 命令来生成新模型

1php artisan make:model Flight

php artisan make:model Flight

如果您想在生成模型时生成数据库迁移，您可以使用 --migration 或 -m 选项

1php artisan make:model Flight --migration

php artisan make:model Flight --migration

您可以在生成模型时生成各种其他类型的类，例如工厂、种子器、策略、控制器和表单请求。此外，这些选项可以组合使用以一次创建多个类

 1# Generate a model and a FlightFactory class...
 2php artisan make:model Flight --factory
 3php artisan make:model Flight -f
 4 
 5# Generate a model and a FlightSeeder class...
 6php artisan make:model Flight --seed
 7php artisan make:model Flight -s
 8 
 9# Generate a model and a FlightController class...
10php artisan make:model Flight --controller
11php artisan make:model Flight -c
12 
13# Generate a model, FlightController resource class, and form request classes...
14php artisan make:model Flight --controller --resource --requests
15php artisan make:model Flight -crR
16 
17# Generate a model and a FlightPolicy class...
18php artisan make:model Flight --policy
19 
20# Generate a model and a migration, factory, seeder, and controller...
21php artisan make:model Flight -mfsc
22 
23# Shortcut to generate a model, migration, factory, seeder, policy, controller, and form requests...
24php artisan make:model Flight --all
25php artisan make:model Flight -a
26 
27# Generate a pivot model...
28php artisan make:model Member --pivot
29php artisan make:model Member -p

# Generate a model and a FlightFactory class...
php artisan make:model Flight --factory
php artisan make:model Flight -f

# Generate a model and a FlightSeeder class...
php artisan make:model Flight --seed
php artisan make:model Flight -s

# Generate a model and a FlightController class...
php artisan make:model Flight --controller
php artisan make:model Flight -c

# Generate a model, FlightController resource class, and form request classes...
php artisan make:model Flight --controller --resource --requests
php artisan make:model Flight -crR

# Generate a model and a FlightPolicy class...
php artisan make:model Flight --policy

# Generate a model and a migration, factory, seeder, and controller...
php artisan make:model Flight -mfsc

# Shortcut to generate a model, migration, factory, seeder, policy, controller, and form requests...
php artisan make:model Flight --all
php artisan make:model Flight -a

# Generate a pivot model...
php artisan make:model Member --pivot
php artisan make:model Member -p

检查模型

有时，仅通过浏览模型的代码来确定模型的所有可用属性和关系可能很困难。相反，请尝试 model:show Artisan 命令，该命令提供了模型的所有属性和关系的便捷概述

1php artisan model:show Flight

php artisan model:show Flight

Eloquent 模型约定

由 make:model 命令生成的模型将放置在 app/Models 目录中。让我们检查一个基本模型类，并讨论 Eloquent 的一些关键约定

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    // ...
10}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    // ...
}

浏览上面的示例后，您可能已经注意到我们没有告诉 Eloquent 哪个数据库表对应于我们的 Flight 模型。按照约定，类的“蛇形命名法”、复数名称将用作表名，除非显式指定了另一个名称。因此，在本例中，Eloquent 将假定 Flight 模型将记录存储在 flights 表中，而 AirTrafficController 模型会将记录存储在 air_traffic_controllers 表中。

如果您的模型对应的数据库表不符合此约定，您可以手动指定模型的表名，方法是在模型上定义 table 属性

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The table associated with the model.
11     *
12     * @var string
13     */
14    protected $table = 'my_flights';
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'my_flights';
}

主键

Eloquent 还会假定每个模型对应的数据库表都有一个名为 id 的主键列。如有必要，您可以在模型上定义一个受保护的 $primaryKey 属性，以指定用作模型主键的不同列

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The primary key associated with the table.
11     *
12     * @var string
13     */
14    protected $primaryKey = 'flight_id';
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The primary key associated with the table.
     *
     * @var string
     */
    protected $primaryKey = 'flight_id';
}

此外，Eloquent 假定主键是一个递增的整数值，这意味着 Eloquent 将自动将主键强制转换为整数。如果您希望使用非递增或非数字主键，则必须在模型上定义一个公共 $incrementing 属性，并将其设置为 false

 1<?php
 2 
 3class Flight extends Model
 4{
 5    /**
 6     * Indicates if the model's ID is auto-incrementing.
 7     *
 8     * @var bool
 9     */
10    public $incrementing = false;
11}

<?php

class Flight extends Model
{
    /**
     * Indicates if the model's ID is auto-incrementing.
     *
     * @var bool
     */
    public $incrementing = false;
}

如果模型的主键不是整数，则应在模型上定义一个受保护的 $keyType 属性。此属性的值应为 string

 1<?php
 2 
 3class Flight extends Model
 4{
 5    /**
 6     * The data type of the primary key ID.
 7     *
 8     * @var string
 9     */
10    protected $keyType = 'string';
11}

<?php

class Flight extends Model
{
    /**
     * The data type of the primary key ID.
     *
     * @var string
     */
    protected $keyType = 'string';
}

“复合”主键

Eloquent 要求每个模型至少有一个唯一标识的“ID”，可以用作其主键。“复合”主键不受 Eloquent 模型支持。但是，除了表的唯一标识主键之外，您可以自由地向数据库表添加额外的多列唯一索引。

UUID 和 ULID 键

您可以选择使用 UUID 而不是使用自动递增整数作为 Eloquent 模型的主键。UUID 是通用唯一字母数字标识符，长度为 36 个字符。

如果您希望模型使用 UUID 键而不是自动递增的整数键，您可以在模型上使用 Illuminate\Database\Eloquent\Concerns\HasUuids trait。当然，您应该确保该模型具有UUID 等效的主键列

 1use Illuminate\Database\Eloquent\Concerns\HasUuids;
 2use Illuminate\Database\Eloquent\Model;
 3 
 4class Article extends Model
 5{
 6    use HasUuids;
 7 
 8    // ...
 9}
10 
11$article = Article::create(['title' => 'Traveling to Europe']);
12 
13$article->id; // "8f8e8478-9035-4d23-b9a7-62f4d2612ce5"

use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
    use HasUuids;

    // ...
}

$article = Article::create(['title' => 'Traveling to Europe']);

$article->id; // "8f8e8478-9035-4d23-b9a7-62f4d2612ce5"

默认情况下，HasUuids trait 将为您的模型生成“有序” UUID。这些 UUID 对于索引数据库存储更有效，因为它们可以按字典顺序排序。

您可以通过在模型上定义 newUniqueId 方法来覆盖给定模型的 UUID 生成过程。此外，您可以通过在模型上定义 uniqueIds 方法来指定哪些列应接收 UUID。

 1use Ramsey\Uuid\Uuid;
 2 
 3/**
 4 * Generate a new UUID for the model.
 5 */
 6public function newUniqueId(): string
 7{
 8    return (string) Uuid::uuid4();
 9}
10 
11/**
12 * Get the columns that should receive a unique identifier.
13 *
14 * @return array<int, string>
15 */
16public function uniqueIds(): array
17{
18    return ['id', 'discount_code'];
19}

use Ramsey\Uuid\Uuid;

/**
 * Generate a new UUID for the model.
 */
public function newUniqueId(): string
{
    return (string) Uuid::uuid4();
}

/**
 * Get the columns that should receive a unique identifier.
 *
 * @return array<int, string>
 */
public function uniqueIds(): array
{
    return ['id', 'discount_code'];
}

如果需要，您可以选择使用“ULID”而不是 UUID。ULID 类似于 UUID；但是，它们的长度仅为 26 个字符。与有序 UUID 一样，ULID 可以按字典顺序排序，以实现高效的数据库索引。要使用 ULID，您应该在模型上使用 Illuminate\Database\Eloquent\Concerns\HasUlids trait。您还应该确保模型具有ULID 等效的主键列

 1use Illuminate\Database\Eloquent\Concerns\HasUlids;
 2use Illuminate\Database\Eloquent\Model;
 3 
 4class Article extends Model
 5{
 6    use HasUlids;
 7 
 8    // ...
 9}
10 
11$article = Article::create(['title' => 'Traveling to Asia']);
12 
13$article->id; // "01gd4d3tgrrfqeda94gdbtdk5c"

use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
    use HasUlids;

    // ...
}

$article = Article::create(['title' => 'Traveling to Asia']);

$article->id; // "01gd4d3tgrrfqeda94gdbtdk5c"

时间戳

默认情况下，Eloquent 期望您的模型对应的数据库表上存在 created_at 和 updated_at 列。当创建或更新模型时，Eloquent 将自动设置这些列的值。如果您不希望这些列由 Eloquent 自动管理，则应在模型上定义一个 $timestamps 属性，其值为 false

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * Indicates if the model should be timestamped.
11     *
12     * @var bool
13     */
14    public $timestamps = false;
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * Indicates if the model should be timestamped.
     *
     * @var bool
     */
    public $timestamps = false;
}

如果您需要自定义模型时间戳的格式，请在模型上设置 $dateFormat 属性。此属性确定日期属性在数据库中的存储方式以及模型序列化为数组或 JSON 时的格式

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The storage format of the model's date columns.
11     *
12     * @var string
13     */
14    protected $dateFormat = 'U';
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The storage format of the model's date columns.
     *
     * @var string
     */
    protected $dateFormat = 'U';
}

如果您需要自定义用于存储时间戳的列的名称，您可以在模型上定义 CREATED_AT 和 UPDATED_AT 常量

1<?php
2 
3class Flight extends Model
4{
5    const CREATED_AT = 'creation_date';
6    const UPDATED_AT = 'updated_date';
7}

<?php

class Flight extends Model
{
    const CREATED_AT = 'creation_date';
    const UPDATED_AT = 'updated_date';
}

如果您想在不修改模型的 updated_at 时间戳的情况下执行模型操作，您可以在提供给 withoutTimestamps 方法的闭包中操作模型

1Model::withoutTimestamps(fn () => $post->increment('reads'));

Model::withoutTimestamps(fn () => $post->increment('reads'));

数据库连接

默认情况下，所有 Eloquent 模型都将使用为您的应用程序配置的默认数据库连接。如果您想指定在与特定模型交互时应使用的不同连接，则应在模型上定义 $connection 属性

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The database connection that should be used by the model.
11     *
12     * @var string
13     */
14    protected $connection = 'mysql';
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The database connection that should be used by the model.
     *
     * @var string
     */
    protected $connection = 'mysql';
}

默认属性值

默认情况下，新实例化的模型实例将不包含任何属性值。如果您想为模型的某些属性定义默认值，您可以在模型上定义 $attributes 属性。放入 $attributes 数组中的属性值应采用其原始的“可存储”格式，就像刚从数据库中读取一样

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The model's default values for attributes.
11     *
12     * @var array
13     */
14    protected $attributes = [
15        'options' => '[]',
16        'delayed' => false,
17    ];
18}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The model's default values for attributes.
     *
     * @var array
     */
    protected $attributes = [
        'options' => '[]',
        'delayed' => false,
    ];
}

配置 Eloquent 严格模式

Laravel 提供了几种方法，允许您在各种情况下配置 Eloquent 的行为和“严格性”。

首先，preventLazyLoading 方法接受一个可选的布尔参数，指示是否应阻止延迟加载。例如，您可能希望仅在非生产环境中禁用延迟加载，以便即使生产代码中意外存在延迟加载关系，您的生产环境也能继续正常运行。通常，此方法应在应用程序的 AppServiceProvider 的 boot 方法中调用

1use Illuminate\Database\Eloquent\Model;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Model::preventLazyLoading(! $this->app->isProduction());
9}

use Illuminate\Database\Eloquent\Model;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Model::preventLazyLoading(! $this->app->isProduction());
}

此外，您可以指示 Laravel 在尝试填充不可填充的属性时抛出异常，方法是调用 preventSilentlyDiscardingAttributes 方法。这可以帮助防止在本地开发期间尝试设置尚未添加到模型的 fillable 数组中的属性时发生意外错误。

1Model::preventSilentlyDiscardingAttributes(! $this->app->isProduction());

Model::preventSilentlyDiscardingAttributes(! $this->app->isProduction());

检索模型

一旦您创建了一个模型和其关联的数据库表，您就可以开始从数据库中检索数据了。您可以将每个 Eloquent 模型看作是一个强大的查询构建器，允许您流畅地查询与该模型关联的数据库表。模型的 all 方法将检索与该模型关联的数据库表中的所有记录。

1use App\Models\Flight;
2 
3foreach (Flight::all() as $flight) {
4    echo $flight->name;
5}

use App\Models\Flight;

foreach (Flight::all() as $flight) {
    echo $flight->name;
}

构建查询

Eloquent 的 all 方法将返回模型表中的所有结果。但是，由于每个 Eloquent 模型都充当一个查询构建器，您可以向查询添加额外的约束，然后调用 get 方法来检索结果。

1$flights = Flight::where('active', 1)
2    ->orderBy('name')
3    ->take(10)
4    ->get();

$flights = Flight::where('active', 1)
    ->orderBy('name')
    ->take(10)
    ->get();

由于 Eloquent 模型是查询构建器，您应该查看 Laravel 的查询构建器提供的所有方法。在编写 Eloquent 查询时，您可以使用这些方法中的任何一种。

刷新模型

如果您已经有一个从数据库中检索的 Eloquent 模型实例，您可以使用 fresh 和 refresh 方法“刷新”模型。 fresh 方法将从数据库中重新检索模型。现有的模型实例将不会受到影响。

1$flight = Flight::where('number', 'FR 900')->first();
2 
3$freshFlight = $flight->fresh();

$flight = Flight::where('number', 'FR 900')->first();

$freshFlight = $flight->fresh();

refresh 方法将使用来自数据库的最新数据重新水合现有的模型。此外，其所有已加载的关系也将被刷新。

1$flight = Flight::where('number', 'FR 900')->first();
2 
3$flight->number = 'FR 456';
4 
5$flight->refresh();
6 
7$flight->number; // "FR 900"

$flight = Flight::where('number', 'FR 900')->first();

$flight->number = 'FR 456';

$flight->refresh();

$flight->number; // "FR 900"

集合

正如我们所见，Eloquent 方法（如 all 和 get）从数据库中检索多个记录。但是，这些方法不会返回纯 PHP 数组。相反，返回的是 Illuminate\Database\Eloquent\Collection 的一个实例。

Eloquent 的 Collection 类扩展了 Laravel 的基础 Illuminate\Support\Collection 类，后者提供了各种有用的方法来与数据集合进行交互。例如，reject 方法可用于根据调用的闭包的结果从集合中移除模型。

1$flights = Flight::where('destination', 'Paris')->get();
2 
3$flights = $flights->reject(function (Flight $flight) {
4    return $flight->cancelled;
5});

$flights = Flight::where('destination', 'Paris')->get();

$flights = $flights->reject(function (Flight $flight) {
    return $flight->cancelled;
});

除了 Laravel 的基础集合类提供的方法之外，Eloquent 集合类还提供了一些额外的方法，这些方法专门用于与 Eloquent 模型集合进行交互。

由于 Laravel 的所有集合都实现了 PHP 的可迭代接口，您可以像遍历数组一样遍历集合。

1foreach ($flights as $flight) {
2    echo $flight->name;
3}

foreach ($flights as $flight) {
    echo $flight->name;
}

分块结果

如果您尝试通过 all 或 get 方法加载数万条 Eloquent 记录，您的应用程序可能会耗尽内存。与其使用这些方法，不如使用 chunk 方法来更有效地处理大量模型。

chunk 方法将检索 Eloquent 模型的一个子集，并将它们传递给一个闭包进行处理。由于一次只检索当前块的 Eloquent 模型，因此在使用大量模型时，chunk 方法将显著减少内存使用量。

1use App\Models\Flight;
2use Illuminate\Database\Eloquent\Collection;
3 
4Flight::chunk(200, function (Collection $flights) {
5    foreach ($flights as $flight) {
6        // ...
7    }
8});

use App\Models\Flight;
use Illuminate\Database\Eloquent\Collection;

Flight::chunk(200, function (Collection $flights) {
    foreach ($flights as $flight) {
        // ...
    }
});

传递给 chunk 方法的第一个参数是您希望每个“块”接收的记录数。作为第二个参数传递的闭包将为从数据库检索的每个块调用。将执行数据库查询以检索传递给闭包的每个记录块。

如果您正在根据一个列过滤 chunk 方法的结果，并且您还将在迭代结果时更新该列，则应使用 chunkById 方法。在这些情况下使用 chunk 方法可能会导致意外和不一致的结果。在内部，chunkById 方法将始终检索 id 列大于前一个块中最后一个模型的模型。

1Flight::where('departed', true)
2    ->chunkById(200, function (Collection $flights) {
3        $flights->each->update(['departed' => false]);
4    }, column: 'id');

Flight::where('departed', true)
    ->chunkById(200, function (Collection $flights) {
        $flights->each->update(['departed' => false]);
    }, column: 'id');

由于 chunkById 和 lazyById 方法会将它们自己的 “where” 条件添加到正在执行的查询中，因此您通常应该在闭包中逻辑分组您自己的条件。

1Flight::where(function ($query) {
2    $query->where('delayed', true)->orWhere('cancelled', true);
3})->chunkById(200, function (Collection $flights) {
4    $flights->each->update([
5        'departed' => false,
6        'cancelled' => true
7    ]);
8}, column: 'id');

Flight::where(function ($query) {
    $query->where('delayed', true)->orWhere('cancelled', true);
})->chunkById(200, function (Collection $flights) {
    $flights->each->update([
        'departed' => false,
        'cancelled' => true
    ]);
}, column: 'id');

使用惰性集合分块

lazy 方法的工作方式与 chunk 方法类似，因为在幕后，它以块的形式执行查询。但是，lazy 方法不是像 chunk 方法那样将每个块直接传递到回调中，而是返回一个扁平化的 Eloquent 模型 LazyCollection，这使您可以将结果作为单个流进行交互。

1use App\Models\Flight;
2 
3foreach (Flight::lazy() as $flight) {
4    // ...
5}

use App\Models\Flight;

foreach (Flight::lazy() as $flight) {
    // ...
}

如果您正在根据一个列过滤 lazy 方法的结果，并且您还将在迭代结果时更新该列，则应使用 lazyById 方法。在内部，lazyById 方法将始终检索 id 列大于前一个块中最后一个模型的模型。

1Flight::where('departed', true)
2    ->lazyById(200, column: 'id')
3    ->each->update(['departed' => false]);

Flight::where('departed', true)
    ->lazyById(200, column: 'id')
    ->each->update(['departed' => false]);

您可以使用 lazyByIdDesc 方法根据 id 的降序对结果进行过滤。

游标

与 lazy 方法类似，当迭代数万条 Eloquent 模型记录时，可以使用 cursor 方法来显著减少应用程序的内存消耗。

cursor 方法只会执行一个数据库查询；但是，只有在实际迭代时才会水合单个 Eloquent 模型。因此，在迭代游标时，任何给定时间都只在内存中保留一个 Eloquent 模型。

由于 cursor 方法一次只在内存中保存一个 Eloquent 模型，因此它无法预加载关系。如果您需要预加载关系，请考虑改用 lazy 方法。

在内部，cursor 方法使用 PHP 生成器来实现此功能。

1use App\Models\Flight;
2 
3foreach (Flight::where('destination', 'Zurich')->cursor() as $flight) {
4    // ...
5}

use App\Models\Flight;

foreach (Flight::where('destination', 'Zurich')->cursor() as $flight) {
    // ...
}

cursor 返回一个 Illuminate\Support\LazyCollection 实例。惰性集合允许您使用典型 Laravel 集合上可用的许多集合方法，同时一次只将单个模型加载到内存中。

1use App\Models\User;
2 
3$users = User::cursor()->filter(function (User $user) {
4    return $user->id > 500;
5});
6 
7foreach ($users as $user) {
8    echo $user->id;
9}

use App\Models\User;

$users = User::cursor()->filter(function (User $user) {
    return $user->id > 500;
});

foreach ($users as $user) {
    echo $user->id;
}

虽然 cursor 方法比常规查询使用的内存少得多（一次只在内存中保留一个 Eloquent 模型），但它最终仍会耗尽内存。这是由于 PHP 的 PDO 驱动程序在内部将其缓冲区中缓存所有原始查询结果。如果您正在处理大量 Eloquent 记录，请考虑改用 lazy 方法。

高级子查询

子查询选择

Eloquent 还提供了高级子查询支持，允许您在单个查询中从相关表中提取信息。例如，假设我们有一个航班 destinations 表和一个飞往目的地的 flights 表。flights 表包含一个 arrived_at 列，指示航班何时到达目的地。

使用查询构建器的 select 和 addSelect 方法提供的子查询功能，我们可以使用单个查询选择所有 destinations 以及最近到达该目的地的航班名称。

1use App\Models\Destination;
2use App\Models\Flight;
3 
4return Destination::addSelect(['last_flight' => Flight::select('name')
5    ->whereColumn('destination_id', 'destinations.id')
6    ->orderByDesc('arrived_at')
7    ->limit(1)
8])->get();

use App\Models\Destination;
use App\Models\Flight;

return Destination::addSelect(['last_flight' => Flight::select('name')
    ->whereColumn('destination_id', 'destinations.id')
    ->orderByDesc('arrived_at')
    ->limit(1)
])->get();

子查询排序

此外，查询构建器的 orderBy 函数支持子查询。继续使用我们的航班示例，我们可以使用此功能根据上次航班到达目的地的时间对所有目的地进行排序。同样，这可以在执行单个数据库查询时完成。

1return Destination::orderByDesc(
2    Flight::select('arrived_at')
3        ->whereColumn('destination_id', 'destinations.id')
4        ->orderByDesc('arrived_at')
5        ->limit(1)
6)->get();

return Destination::orderByDesc(
    Flight::select('arrived_at')
        ->whereColumn('destination_id', 'destinations.id')
        ->orderByDesc('arrived_at')
        ->limit(1)
)->get();

检索单个模型 / 聚合

除了检索与给定查询匹配的所有记录外，您还可以使用 find、first 或 firstWhere 方法检索单个记录。这些方法不是返回模型集合，而是返回单个模型实例。

 1use App\Models\Flight;
 2 
 3// Retrieve a model by its primary key...
 4$flight = Flight::find(1);
 5 
 6// Retrieve the first model matching the query constraints...
 7$flight = Flight::where('active', 1)->first();
 8 
 9// Alternative to retrieving the first model matching the query constraints...
10$flight = Flight::firstWhere('active', 1);

use App\Models\Flight;

// Retrieve a model by its primary key...
$flight = Flight::find(1);

// Retrieve the first model matching the query constraints...
$flight = Flight::where('active', 1)->first();

// Alternative to retrieving the first model matching the query constraints...
$flight = Flight::firstWhere('active', 1);

有时，您可能希望在未找到结果时执行其他操作。findOr 和 firstOr 方法将返回单个模型实例，或者，如果未找到结果，则执行给定的闭包。闭包返回的值将被视为该方法的结果。

1$flight = Flight::findOr(1, function () {
2    // ...
3});
4 
5$flight = Flight::where('legs', '>', 3)->firstOr(function () {
6    // ...
7});

$flight = Flight::findOr(1, function () {
    // ...
});

$flight = Flight::where('legs', '>', 3)->firstOr(function () {
    // ...
});

未找到异常

有时，您可能希望在未找到模型时抛出异常。这在路由或控制器中特别有用。findOrFail 和 firstOrFail 方法将检索查询的第一个结果；但是，如果未找到结果，将抛出 Illuminate\Database\Eloquent\ModelNotFoundException 异常。

1$flight = Flight::findOrFail(1);
2 
3$flight = Flight::where('legs', '>', 3)->firstOrFail();

$flight = Flight::findOrFail(1);

$flight = Flight::where('legs', '>', 3)->firstOrFail();

如果 ModelNotFoundException 未被捕获，则会自动向客户端发送 404 HTTP 响应。

1use App\Models\Flight;
2 
3Route::get('/api/flights/{id}', function (string $id) {
4    return Flight::findOrFail($id);
5});

use App\Models\Flight;

Route::get('/api/flights/{id}', function (string $id) {
    return Flight::findOrFail($id);
});

检索或创建模型

firstOrCreate 方法将尝试使用给定的列/值对查找数据库记录。如果在数据库中找不到该模型，则将插入一条记录，其属性是通过将第一个数组参数与可选的第二个数组参数合并而产生的。

firstOrNew 方法与 firstOrCreate 类似，将尝试在数据库中查找与给定属性匹配的记录。但是，如果未找到模型，则将返回一个新的模型实例。请注意，firstOrNew 返回的模型尚未持久化到数据库中。您需要手动调用 save 方法来持久化它。

 1use App\Models\Flight;
 2 
 3// Retrieve flight by name or create it if it doesn't exist...
 4$flight = Flight::firstOrCreate([
 5    'name' => 'London to Paris'
 6]);
 7 
 8// Retrieve flight by name or create it with the name, delayed, and arrival_time attributes...
 9$flight = Flight::firstOrCreate(
10    ['name' => 'London to Paris'],
11    ['delayed' => 1, 'arrival_time' => '11:30']
12);
13 
14// Retrieve flight by name or instantiate a new Flight instance...
15$flight = Flight::firstOrNew([
16    'name' => 'London to Paris'
17]);
18 
19// Retrieve flight by name or instantiate with the name, delayed, and arrival_time attributes...
20$flight = Flight::firstOrNew(
21    ['name' => 'Tokyo to Sydney'],
22    ['delayed' => 1, 'arrival_time' => '11:30']
23);

use App\Models\Flight;

// Retrieve flight by name or create it if it doesn't exist...
$flight = Flight::firstOrCreate([
    'name' => 'London to Paris'
]);

// Retrieve flight by name or create it with the name, delayed, and arrival_time attributes...
$flight = Flight::firstOrCreate(
    ['name' => 'London to Paris'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

// Retrieve flight by name or instantiate a new Flight instance...
$flight = Flight::firstOrNew([
    'name' => 'London to Paris'
]);

// Retrieve flight by name or instantiate with the name, delayed, and arrival_time attributes...
$flight = Flight::firstOrNew(
    ['name' => 'Tokyo to Sydney'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

检索聚合

在与 Eloquent 模型交互时，您还可以使用 Laravel 查询构建器提供的 count、sum、max 和其他聚合方法。正如您可能预期的那样，这些方法返回标量值，而不是 Eloquent 模型实例。

1$count = Flight::where('active', 1)->count();
2 
3$max = Flight::where('active', 1)->max('price');

$count = Flight::where('active', 1)->count();

$max = Flight::where('active', 1)->max('price');

插入和更新模型

插入

当然，在使用 Eloquent 时，我们不仅需要从数据库中检索模型。我们还需要插入新记录。幸运的是，Eloquent 使其变得简单。要将新记录插入数据库，您应该实例化一个新的模型实例并在模型上设置属性。然后，在模型实例上调用 save 方法。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use App\Models\Flight;
 7use Illuminate\Http\RedirectResponse;
 8use Illuminate\Http\Request;
 9 
10class FlightController extends Controller
11{
12    /**
13     * Store a new flight in the database.
14     */
15    public function store(Request $request): RedirectResponse
16    {
17        // Validate the request...
18 
19        $flight = new Flight;
20 
21        $flight->name = $request->name;
22 
23        $flight->save();
24 
25        return redirect('/flights');
26    }
27}

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Flight;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class FlightController extends Controller
{
    /**
     * Store a new flight in the database.
     */
    public function store(Request $request): RedirectResponse
    {
        // Validate the request...

        $flight = new Flight;

        $flight->name = $request->name;

        $flight->save();

        return redirect('/flights');
    }
}

在此示例中，我们将来自传入 HTTP 请求的 name 字段分配给 App\Models\Flight 模型实例的 name 属性。当我们调用 save 方法时，将在数据库中插入一条记录。模型的 created_at 和 updated_at 时间戳将在调用 save 方法时自动设置，因此无需手动设置它们。

或者，您可以使用 create 方法使用单个 PHP 语句“保存”新模型。插入的模型实例将由 create 方法返回给您。

1use App\Models\Flight;
2 
3$flight = Flight::create([
4    'name' => 'London to Paris',
5]);

use App\Models\Flight;

$flight = Flight::create([
    'name' => 'London to Paris',
]);

但是，在使用 create 方法之前，您需要在模型类上指定 fillable 或 guarded 属性。之所以需要这些属性，是因为默认情况下，所有 Eloquent 模型都受到保护，免受批量赋值漏洞的攻击。要了解有关批量赋值的更多信息，请查阅批量赋值文档。

更新

save 方法也可用于更新数据库中已存在的模型。要更新模型，您应该检索它并设置您希望更新的任何属性。然后，您应该调用模型的 save 方法。同样，updated_at 时间戳将自动更新，因此无需手动设置其值。

1use App\Models\Flight;
2 
3$flight = Flight::find(1);
4 
5$flight->name = 'Paris to London';
6 
7$flight->save();

use App\Models\Flight;

$flight = Flight::find(1);

$flight->name = 'Paris to London';

$flight->save();

有时，您可能需要更新现有模型，或者在不存在匹配模型的情况下创建新模型。与 firstOrCreate 方法一样，updateOrCreate 方法会持久化模型，因此无需手动调用 save 方法。

在下面的示例中，如果存在出发地为 Oakland 且目的地为 San Diego 的航班，则其 price 和 discounted 列将被更新。如果不存在这样的航班，则将创建一个新航班，该航班具有通过将第一个参数数组与第二个参数数组合并而产生的属性。

1$flight = Flight::updateOrCreate(
2    ['departure' => 'Oakland', 'destination' => 'San Diego'],
3    ['price' => 99, 'discounted' => 1]
4);

$flight = Flight::updateOrCreate(
    ['departure' => 'Oakland', 'destination' => 'San Diego'],
    ['price' => 99, 'discounted' => 1]
);

批量更新

也可以对与给定查询匹配的模型执行更新。在此示例中，所有 active 且 destination 为 San Diego 的航班都将被标记为延误。

1Flight::where('active', 1)
2    ->where('destination', 'San Diego')
3    ->update(['delayed' => 1]);

Flight::where('active', 1)
    ->where('destination', 'San Diego')
    ->update(['delayed' => 1]);

update 方法需要一个列和值对的数组，表示应更新的列。update 方法返回受影响的行数。

当通过 Eloquent 发出批量更新时，不会为更新的模型触发 saving、saved、updating 和 updated 模型事件。这是因为在发出批量更新时，永远不会实际检索模型。

检查属性更改

Eloquent 提供了 isDirty、isClean 和 wasChanged 方法，用于检查模型的内部状态，并确定模型的属性自最初检索以来发生了哪些更改。

isDirty 方法确定模型的任何属性自模型检索以来是否已更改。您可以将特定属性名称或属性数组传递给 isDirty 方法，以确定任何属性是否为“dirty”。isClean 方法将确定属性自模型检索以来是否保持不变。此方法也接受可选的属性参数。

 1use App\Models\User;
 2 
 3$user = User::create([
 4    'first_name' => 'Taylor',
 5    'last_name' => 'Otwell',
 6    'title' => 'Developer',
 7]);
 8 
 9$user->title = 'Painter';
10 
11$user->isDirty(); // true
12$user->isDirty('title'); // true
13$user->isDirty('first_name'); // false
14$user->isDirty(['first_name', 'title']); // true
15 
16$user->isClean(); // false
17$user->isClean('title'); // false
18$user->isClean('first_name'); // true
19$user->isClean(['first_name', 'title']); // false
20 
21$user->save();
22 
23$user->isDirty(); // false
24$user->isClean(); // true

use App\Models\User;

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';

$user->isDirty(); // true
$user->isDirty('title'); // true
$user->isDirty('first_name'); // false
$user->isDirty(['first_name', 'title']); // true

$user->isClean(); // false
$user->isClean('title'); // false
$user->isClean('first_name'); // true
$user->isClean(['first_name', 'title']); // false

$user->save();

$user->isDirty(); // false
$user->isClean(); // true

wasChanged 方法确定在当前请求周期内上次保存模型时是否更改了任何属性。如果需要，您可以传递属性名称以查看特定属性是否已更改。

 1$user = User::create([
 2    'first_name' => 'Taylor',
 3    'last_name' => 'Otwell',
 4    'title' => 'Developer',
 5]);
 6 
 7$user->title = 'Painter';
 8 
 9$user->save();
10 
11$user->wasChanged(); // true
12$user->wasChanged('title'); // true
13$user->wasChanged(['title', 'slug']); // true
14$user->wasChanged('first_name'); // false
15$user->wasChanged(['first_name', 'title']); // true

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';

$user->save();

$user->wasChanged(); // true
$user->wasChanged('title'); // true
$user->wasChanged(['title', 'slug']); // true
$user->wasChanged('first_name'); // false
$user->wasChanged(['first_name', 'title']); // true

getOriginal 方法返回一个数组，其中包含模型的原始属性，无论自检索模型以来对模型进行了任何更改。如果需要，您可以传递特定的属性名称以获取特定属性的原始值。

 1$user = User::find(1);
 2 
 3$user->name; // John
 4$user->email; // [email protected]
 5 
 6$user->name = "Jack";
 7$user->name; // Jack
 8 
 9$user->getOriginal('name'); // John
10$user->getOriginal(); // Array of original attributes...

$user = User::find(1);

$user->name; // John
$user->email; // [email protected]

$user->name = "Jack";
$user->name; // Jack

$user->getOriginal('name'); // John
$user->getOriginal(); // Array of original attributes...

批量赋值

您可以使用 create 方法使用单个 PHP 语句“保存”新模型。插入的模型实例将由该方法返回给您。

1use App\Models\Flight;
2 
3$flight = Flight::create([
4    'name' => 'London to Paris',
5]);

use App\Models\Flight;

$flight = Flight::create([
    'name' => 'London to Paris',
]);

但是，在使用 create 方法之前，您需要在模型类上指定 fillable 或 guarded 属性。之所以需要这些属性，是因为默认情况下，所有 Eloquent 模型都受到保护，免受批量赋值漏洞的攻击。

当用户传递一个意外的 HTTP 请求字段，并且该字段更改了数据库中您未预期的列时，就会发生批量赋值漏洞。例如，恶意用户可能会通过 HTTP 请求发送一个 is_admin 参数，然后该参数被传递到您模型的 create 方法，从而允许用户将自己提升为管理员。

因此，首先，您应该定义您想要进行批量赋值的模型属性。您可以使用模型上的 $fillable 属性来完成此操作。例如，让我们使我们的 Flight 模型的 name 属性可批量赋值。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class Flight extends Model
 8{
 9    /**
10     * The attributes that are mass assignable.
11     *
12     * @var array<int, string>
13     */
14    protected $fillable = ['name'];
15}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = ['name'];
}

一旦您指定了哪些属性是可批量赋值的，您就可以使用 create 方法在数据库中插入一条新记录。 create 方法返回新创建的模型实例。

1$flight = Flight::create(['name' => 'London to Paris']);

$flight = Flight::create(['name' => 'London to Paris']);

如果您已经有一个模型实例，则可以使用 fill 方法使用属性数组来填充它。

1$flight->fill(['name' => 'Amsterdam to Frankfurt']);

$flight->fill(['name' => 'Amsterdam to Frankfurt']);

批量赋值和 JSON 列

当赋值 JSON 列时，每个列的可批量赋值的键都必须在您模型的 $fillable 数组中指定。为了安全起见，当使用 guarded 属性时，Laravel 不支持更新嵌套的 JSON 属性。

1/**
2 * The attributes that are mass assignable.
3 *
4 * @var array<int, string>
5 */
6protected $fillable = [
7    'options->enabled',
8];

/**
 * The attributes that are mass assignable.
 *
 * @var array<int, string>
 */
protected $fillable = [
    'options->enabled',
];

允许批量赋值

如果您想使所有属性都可批量赋值，可以将模型的 $guarded 属性定义为空数组。如果您选择解除模型的保护，则应特别注意始终手工创建传递给 Eloquent 的 fill、create 和 update 方法的数组。

1/**
2 * The attributes that aren't mass assignable.
3 *
4 * @var array<string>|bool
5 */
6protected $guarded = [];

/**
 * The attributes that aren't mass assignable.
 *
 * @var array<string>|bool
 */
protected $guarded = [];

批量赋值异常

默认情况下，当执行批量赋值操作时，未包含在 $fillable 数组中的属性将被静默丢弃。在生产环境中，这是预期的行为；但是，在本地开发期间，这可能会导致对模型更改为何未生效感到困惑。

如果您希望 Laravel 在尝试填充不可填充的属性时抛出异常，您可以调用 preventSilentlyDiscardingAttributes 方法来指示 Laravel 这样做。通常，此方法应在应用程序的 AppServiceProvider 类的 boot 方法中调用。

1use Illuminate\Database\Eloquent\Model;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Model::preventSilentlyDiscardingAttributes($this->app->isLocal());
9}

use Illuminate\Database\Eloquent\Model;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Model::preventSilentlyDiscardingAttributes($this->app->isLocal());
}

Upserts

Eloquent 的 upsert 方法可用于在单个原子操作中更新或创建记录。该方法的第一个参数包含要插入或更新的值，而第二个参数列出了唯一标识关联表中记录的列。该方法的第三个也是最后一个参数是一个数组，其中包含如果数据库中已存在匹配记录则应更新的列。如果模型上启用了时间戳，则 upsert 方法将自动设置 created_at 和 updated_at 时间戳。

1Flight::upsert([
2    ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
3    ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
4], uniqueBy: ['departure', 'destination'], update: ['price']);

Flight::upsert([
    ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
    ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
], uniqueBy: ['departure', 'destination'], update: ['price']);

除 SQL Server 之外的所有数据库都要求 upsert 方法的第二个参数中的列具有“primary”或“unique”索引。此外，MariaDB 和 MySQL 数据库驱动程序会忽略 upsert 方法的第二个参数，并始终使用表的“primary”和“unique”索引来检测现有记录。

删除模型

要删除模型，您可以调用模型实例上的 delete 方法。

1use App\Models\Flight;
2 
3$flight = Flight::find(1);
4 
5$flight->delete();

use App\Models\Flight;

$flight = Flight::find(1);

$flight->delete();

通过主键删除现有模型

在上面的示例中，我们在调用 delete 方法之前从数据库中检索了模型。但是，如果您知道模型的主键，则可以调用 destroy 方法删除模型，而无需显式检索它。除了接受单个主键外，destroy 方法还将接受多个主键、主键数组或集合的主键。

1Flight::destroy(1);
2 
3Flight::destroy(1, 2, 3);
4 
5Flight::destroy([1, 2, 3]);
6 
7Flight::destroy(collect([1, 2, 3]));

Flight::destroy(1);

Flight::destroy(1, 2, 3);

Flight::destroy([1, 2, 3]);

Flight::destroy(collect([1, 2, 3]));

如果您正在使用软删除模型，则可以通过 forceDestroy 方法永久删除模型。

1Flight::forceDestroy(1);

Flight::forceDestroy(1);

destroy 方法会单独加载每个模型并调用 delete 方法，以便为每个模型正确触发 deleting 和 deleted 事件。

使用查询删除模型

当然，您可以构建 Eloquent 查询以删除与查询条件匹配的所有模型。在此示例中，我们将删除所有标记为非活动的航班。与批量更新类似，批量删除不会为已删除的模型触发模型事件。

1$deleted = Flight::where('active', 0)->delete();

$deleted = Flight::where('active', 0)->delete();

要删除表中的所有模型，您应该执行不添加任何条件的查询。

1$deleted = Flight::query()->delete();

$deleted = Flight::query()->delete();

当通过 Eloquent 执行批量删除语句时，不会为已删除的模型触发 deleting 和 deleted 模型事件。这是因为在执行删除语句时，模型实际上从未被检索。

软删除

除了实际从数据库中删除记录外，Eloquent 还可以“软删除”模型。当模型被软删除时，它们实际上并未从数据库中删除。相反，模型上会设置一个 deleted_at 属性，指示模型被“删除”的日期和时间。要为模型启用软删除，请将 Illuminate\Database\Eloquent\SoftDeletes trait 添加到模型中。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Illuminate\Database\Eloquent\SoftDeletes;
 7 
 8class Flight extends Model
 9{
10    use SoftDeletes;
11}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Flight extends Model
{
    use SoftDeletes;
}

SoftDeletes trait 将自动将 deleted_at 属性转换为 DateTime / Carbon 实例。

您还应该将 deleted_at 列添加到数据库表。Laravel schema 构建器包含一个辅助方法来创建此列。

 1use Illuminate\Database\Schema\Blueprint;
 2use Illuminate\Support\Facades\Schema;
 3 
 4Schema::table('flights', function (Blueprint $table) {
 5    $table->softDeletes();
 6});
 7 
 8Schema::table('flights', function (Blueprint $table) {
 9    $table->dropSoftDeletes();
10});

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::table('flights', function (Blueprint $table) {
    $table->softDeletes();
});

Schema::table('flights', function (Blueprint $table) {
    $table->dropSoftDeletes();
});

现在，当您在模型上调用 delete 方法时，deleted_at 列将被设置为当前日期和时间。但是，模型的数据库记录将保留在表中。当查询使用软删除的模型时，软删除的模型将自动从所有查询结果中排除。

要确定给定的模型实例是否已被软删除，您可以使用 trashed 方法。

1if ($flight->trashed()) {
2    // ...
3}

if ($flight->trashed()) {
    // ...
}

恢复软删除模型

有时您可能希望“取消删除”软删除的模型。要恢复软删除的模型，您可以在模型实例上调用 restore 方法。 restore 方法会将模型的 deleted_at 列设置为 null。

1$flight->restore();

$flight->restore();

您还可以在查询中使用 restore 方法来恢复多个模型。同样，与其他“批量”操作一样，这不会为已恢复的模型触发任何模型事件。

1Flight::withTrashed()
2        ->where('airline_id', 1)
3        ->restore();

Flight::withTrashed()
        ->where('airline_id', 1)
        ->restore();

在构建关系查询时，也可以使用 restore 方法。

1$flight->history()->restore();

$flight->history()->restore();

永久删除模型

有时您可能需要真正从数据库中删除模型。您可以使用 forceDelete 方法从数据库表中永久删除软删除的模型。

1$flight->forceDelete();

$flight->forceDelete();

在构建 Eloquent 关系查询时，也可以使用 forceDelete 方法。

1$flight->history()->forceDelete();

$flight->history()->forceDelete();

查询软删除模型

包含软删除模型

如上所述，软删除的模型将自动从查询结果中排除。但是，您可以通过在查询中调用 withTrashed 方法来强制将软删除的模型包含在查询结果中。

1use App\Models\Flight;
2 
3$flights = Flight::withTrashed()
4    ->where('account_id', 1)
5    ->get();

use App\Models\Flight;

$flights = Flight::withTrashed()
    ->where('account_id', 1)
    ->get();

在构建关系查询时，也可以调用 withTrashed 方法。

1$flight->history()->withTrashed()->get();

$flight->history()->withTrashed()->get();

仅检索软删除模型

onlyTrashed 方法将仅检索软删除的模型。

1$flights = Flight::onlyTrashed()
2    ->where('airline_id', 1)
3    ->get();

$flights = Flight::onlyTrashed()
    ->where('airline_id', 1)
    ->get();

剪枝模型

有时您可能想要定期删除不再需要的模型。为了实现这一点，您可以将 Illuminate\Database\Eloquent\Prunable 或 Illuminate\Database\Eloquent\MassPrunable trait 添加到您想要定期修剪的模型中。将其中一个 trait 添加到模型后，实现一个 prunable 方法，该方法返回一个 Eloquent 查询构造器，用于解析不再需要的模型。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7use Illuminate\Database\Eloquent\Prunable;
 8 
 9class Flight extends Model
10{
11    use Prunable;
12 
13    /**
14     * Get the prunable model query.
15     */
16    public function prunable(): Builder
17    {
18        return static::where('created_at', '<=', now()->subMonth());
19    }
20}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Prunable;

class Flight extends Model
{
    use Prunable;

    /**
     * Get the prunable model query.
     */
    public function prunable(): Builder
    {
        return static::where('created_at', '<=', now()->subMonth());
    }
}

在将模型标记为 Prunable 时，您还可以在模型上定义一个 pruning 方法。此方法将在模型删除之前调用。此方法可用于在模型从数据库中永久删除之前删除与模型关联的任何其他资源，例如存储的文件。

1/**
2 * Prepare the model for pruning.
3 */
4protected function pruning(): void
5{
6    // ...
7}

/**
 * Prepare the model for pruning.
 */
protected function pruning(): void
{
    // ...
}

配置可修剪的模型后，您应该在应用程序的 routes/console.php 文件中计划 model:prune Artisan 命令。您可以自由选择应运行此命令的适当间隔。

1use Illuminate\Support\Facades\Schedule;
2 
3Schedule::command('model:prune')->daily();

use Illuminate\Support\Facades\Schedule;

Schedule::command('model:prune')->daily();

在幕后，model:prune 命令将自动检测应用程序的 app/Models 目录中的“Prunable”模型。如果您的模型位于不同的位置，您可以使用 --model 选项来指定模型类名称。

1Schedule::command('model:prune', [
2    '--model' => [Address::class, Flight::class],
3])->daily();

Schedule::command('model:prune', [
    '--model' => [Address::class, Flight::class],
])->daily();

如果您希望在修剪所有其他检测到的模型时排除某些模型，则可以使用 --except 选项。

1Schedule::command('model:prune', [
2    '--except' => [Address::class, Flight::class],
3])->daily();

Schedule::command('model:prune', [
    '--except' => [Address::class, Flight::class],
])->daily();

您可以通过使用 --pretend 选项执行 model:prune 命令来测试您的 prunable 查询。当使用 pretend 选项时，model:prune 命令将仅报告如果实际运行该命令将修剪多少条记录。

1php artisan model:prune --pretend

php artisan model:prune --pretend

如果软删除的模型与可修剪的查询匹配，则将被永久删除 (forceDelete)。

批量修剪

当模型标记为 Illuminate\Database\Eloquent\MassPrunable trait 时，模型将使用批量删除查询从数据库中删除。因此，不会调用 pruning 方法，也不会触发 deleting 和 deleted 模型事件。这是因为模型在删除之前实际上从未被检索，因此使修剪过程更加高效。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7use Illuminate\Database\Eloquent\MassPrunable;
 8 
 9class Flight extends Model
10{
11    use MassPrunable;
12 
13    /**
14     * Get the prunable model query.
15     */
16    public function prunable(): Builder
17    {
18        return static::where('created_at', '<=', now()->subMonth());
19    }
20}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\MassPrunable;

class Flight extends Model
{
    use MassPrunable;

    /**
     * Get the prunable model query.
     */
    public function prunable(): Builder
    {
        return static::where('created_at', '<=', now()->subMonth());
    }
}

复制模型

您可以使用 replicate 方法创建现有模型实例的未保存副本。当您有许多属性相同的模型实例时，此方法特别有用。

 1use App\Models\Address;
 2 
 3$shipping = Address::create([
 4    'type' => 'shipping',
 5    'line_1' => '123 Example Street',
 6    'city' => 'Victorville',
 7    'state' => 'CA',
 8    'postcode' => '90001',
 9]);
10 
11$billing = $shipping->replicate()->fill([
12    'type' => 'billing'
13]);
14 
15$billing->save();

use App\Models\Address;

$shipping = Address::create([
    'type' => 'shipping',
    'line_1' => '123 Example Street',
    'city' => 'Victorville',
    'state' => 'CA',
    'postcode' => '90001',
]);

$billing = $shipping->replicate()->fill([
    'type' => 'billing'
]);

$billing->save();

要从复制到新模型的属性中排除一个或多个属性，您可以将数组传递给 replicate 方法。

 1$flight = Flight::create([
 2    'destination' => 'LAX',
 3    'origin' => 'LHR',
 4    'last_flown' => '2020-03-04 11:00:00',
 5    'last_pilot_id' => 747,
 6]);
 7 
 8$flight = $flight->replicate([
 9    'last_flown',
10    'last_pilot_id'
11]);

$flight = Flight::create([
    'destination' => 'LAX',
    'origin' => 'LHR',
    'last_flown' => '2020-03-04 11:00:00',
    'last_pilot_id' => 747,
]);

$flight = $flight->replicate([
    'last_flown',
    'last_pilot_id'
]);

查询作用域

全局作用域

全局作用域允许您为给定模型的所有查询添加约束。Laravel 自己的软删除功能利用全局作用域仅从数据库中检索“未删除”的模型。编写您自己的全局作用域可以提供一种方便、简单的方法来确保给定模型的每个查询都收到某些约束。

生成作用域

要生成新的全局作用域，您可以调用 make:scope Artisan 命令，该命令会将生成的作用域放置在应用程序的 app/Models/Scopes 目录中。

1php artisan make:scope AncientScope

php artisan make:scope AncientScope

编写全局作用域

编写全局作用域很简单。首先，使用 make:scope 命令生成一个实现 Illuminate\Database\Eloquent\Scope 接口的类。 Scope 接口要求您实现一个方法：apply。 apply 方法可以根据需要向查询添加 where 约束或其他类型的子句。

 1<?php
 2 
 3namespace App\Models\Scopes;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7use Illuminate\Database\Eloquent\Scope;
 8 
 9class AncientScope implements Scope
10{
11    /**
12     * Apply the scope to a given Eloquent query builder.
13     */
14    public function apply(Builder $builder, Model $model): void
15    {
16        $builder->where('created_at', '<', now()->subYears(2000));
17    }
18}

<?php

namespace App\Models\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class AncientScope implements Scope
{
    /**
     * Apply the scope to a given Eloquent query builder.
     */
    public function apply(Builder $builder, Model $model): void
    {
        $builder->where('created_at', '<', now()->subYears(2000));
    }
}

如果您的全局作用域正在向查询的 select 子句添加列，则应使用 addSelect 方法而不是 select。这将防止意外替换查询的现有 select 子句。

应用全局作用域

要将全局作用域分配给模型，您可以简单地将 ScopedBy 属性放置在模型上。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use App\Models\Scopes\AncientScope;
 6use Illuminate\Database\Eloquent\Attributes\ScopedBy;
 7 
 8#[ScopedBy([AncientScope::class])]
 9class User extends Model
10{
11    //
12}

<?php

namespace App\Models;

use App\Models\Scopes\AncientScope;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;

#[ScopedBy([AncientScope::class])]
class User extends Model
{
    //
}

或者，您可以通过覆盖模型的 booted 方法并调用模型的 addGlobalScope 方法来手动注册全局作用域。 addGlobalScope 方法接受您的作用域的实例作为其唯一参数。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use App\Models\Scopes\AncientScope;
 6use Illuminate\Database\Eloquent\Model;
 7 
 8class User extends Model
 9{
10    /**
11     * The "booted" method of the model.
12     */
13    protected static function booted(): void
14    {
15        static::addGlobalScope(new AncientScope);
16    }
17}

<?php

namespace App\Models;

use App\Models\Scopes\AncientScope;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     */
    protected static function booted(): void
    {
        static::addGlobalScope(new AncientScope);
    }
}

在上面的示例中将作用域添加到 App\Models\User 模型后，调用 User::all() 方法将执行以下 SQL 查询。

1select * from `users` where `created_at` < 0021-02-18 00:00:00

select * from `users` where `created_at` < 0021-02-18 00:00:00

匿名全局作用域

Eloquent 还允许您使用闭包定义全局作用域，这对于不需要单独类的简单作用域特别有用。当使用闭包定义全局作用域时，您应该提供您自己选择的作用域名称作为 addGlobalScope 方法的第一个参数。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7 
 8class User extends Model
 9{
10    /**
11     * The "booted" method of the model.
12     */
13    protected static function booted(): void
14    {
15        static::addGlobalScope('ancient', function (Builder $builder) {
16            $builder->where('created_at', '<', now()->subYears(2000));
17        });
18    }
19}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     */
    protected static function booted(): void
    {
        static::addGlobalScope('ancient', function (Builder $builder) {
            $builder->where('created_at', '<', now()->subYears(2000));
        });
    }
}

移除全局作用域

如果您想删除给定查询的全局作用域，可以使用 withoutGlobalScope 方法。此方法接受全局作用域的类名称作为其唯一参数。

1User::withoutGlobalScope(AncientScope::class)->get();

User::withoutGlobalScope(AncientScope::class)->get();

或者，如果您使用闭包定义了全局作用域，则应传递您分配给全局作用域的字符串名称。

1User::withoutGlobalScope('ancient')->get();

User::withoutGlobalScope('ancient')->get();

如果您想删除多个甚至所有查询的全局作用域，可以使用 withoutGlobalScopes 方法。

1// Remove all of the global scopes...
2User::withoutGlobalScopes()->get();
3 
4// Remove some of the global scopes...
5User::withoutGlobalScopes([
6    FirstScope::class, SecondScope::class
7])->get();

// Remove all of the global scopes...
User::withoutGlobalScopes()->get();

// Remove some of the global scopes...
User::withoutGlobalScopes([
    FirstScope::class, SecondScope::class
])->get();

本地作用域

局部作用域允许您定义常见的查询约束集，您可以在整个应用程序中轻松重用这些约束集。例如，您可能需要经常检索所有被认为是“受欢迎的”用户。要定义作用域，请在 Eloquent 模型方法前加上 scope 前缀。

作用域应始终返回相同的查询构造器实例或 void。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7 
 8class User extends Model
 9{
10    /**
11     * Scope a query to only include popular users.
12     */
13    public function scopePopular(Builder $query): void
14    {
15        $query->where('votes', '>', 100);
16    }
17 
18    /**
19     * Scope a query to only include active users.
20     */
21    public function scopeActive(Builder $query): void
22    {
23        $query->where('active', 1);
24    }
25}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Scope a query to only include popular users.
     */
    public function scopePopular(Builder $query): void
    {
        $query->where('votes', '>', 100);
    }

    /**
     * Scope a query to only include active users.
     */
    public function scopeActive(Builder $query): void
    {
        $query->where('active', 1);
    }
}

使用局部作用域

一旦定义了作用域，您就可以在查询模型时调用作用域方法。但是，在调用方法时，您不应包含 scope 前缀。您甚至可以链式调用各种作用域。

1use App\Models\User;
2 
3$users = User::popular()->active()->orderBy('created_at')->get();

use App\Models\User;

$users = User::popular()->active()->orderBy('created_at')->get();

通过 or 查询运算符组合多个 Eloquent 模型作用域可能需要使用闭包来实现正确的逻辑分组。

1$users = User::popular()->orWhere(function (Builder $query) {
2    $query->active();
3})->get();

$users = User::popular()->orWhere(function (Builder $query) {
    $query->active();
})->get();

但是，由于这可能很麻烦，Laravel 提供了一个“高阶” orWhere 方法，该方法允许您流畅地将作用域链接在一起，而无需使用闭包。

1$users = User::popular()->orWhere->active()->get();

$users = User::popular()->orWhere->active()->get();

动态作用域

有时您可能希望定义一个接受参数的作用域。要开始使用，只需将您的其他参数添加到您的作用域方法的签名中。作用域参数应在 $query 参数之后定义。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7 
 8class User extends Model
 9{
10    /**
11     * Scope a query to only include users of a given type.
12     */
13    public function scopeOfType(Builder $query, string $type): void
14    {
15        $query->where('type', $type);
16    }
17}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Scope a query to only include users of a given type.
     */
    public function scopeOfType(Builder $query, string $type): void
    {
        $query->where('type', $type);
    }
}

一旦将预期的参数添加到您的作用域方法的签名中，您就可以在调用作用域时传递参数。

1$users = User::ofType('admin')->get();

$users = User::ofType('admin')->get();

待定属性

如果您想使用作用域来创建与用于约束作用域的属性相同的属性的模型，则可以在构建作用域查询时使用 withAttributes 方法。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Builder;
 6use Illuminate\Database\Eloquent\Model;
 7 
 8class Post extends Model
 9{
10    /**
11     * Scope the query to only include drafts.
12     */
13    public function scopeDraft(Builder $query): void
14    {
15        $query->withAttributes([
16            'hidden' => true,
17        ]);
18    }
19}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    /**
     * Scope the query to only include drafts.
     */
    public function scopeDraft(Builder $query): void
    {
        $query->withAttributes([
            'hidden' => true,
        ]);
    }
}

withAttributes 方法将使用给定的属性向查询添加 where 子句约束，并且它还将给定的属性添加到通过作用域创建的任何模型。

1$draft = Post::draft()->create(['title' => 'In Progress']);
2 
3$draft->hidden; // true

$draft = Post::draft()->create(['title' => 'In Progress']);

$draft->hidden; // true

比较模型

有时您可能需要确定两个模型是否“相同”。 is 和 isNot 方法可用于快速验证两个模型是否具有相同的主键、表和数据库连接。

1if ($post->is($anotherPost)) {
2    // ...
3}
4 
5if ($post->isNot($anotherPost)) {
6    // ...
7}

if ($post->is($anotherPost)) {
    // ...
}

if ($post->isNot($anotherPost)) {
    // ...
}

当使用 belongsTo、hasOne、morphTo 和 morphOne 关系时，也可以使用 is 和 isNot 方法。当您想比较关联模型而无需发出查询来检索该模型时，此方法特别有用。

1if ($post->author()->is($user)) {
2    // ...
3}

if ($post->author()->is($user)) {
    // ...
}

事件

想要将您的 Eloquent 事件直接广播到您的客户端应用程序吗？请查看 Laravel 的模型事件广播。

Eloquent 模型会触发多个事件，允许您钩入模型生命周期中的以下时刻：retrieved、creating、created、updating、updated、saving、saved、deleting、deleted、trashed、forceDeleting、forceDeleted、restoring、restored 和 replicating。

当从数据库中检索现有模型时，将触发 retrieved 事件。当第一次保存新模型时，将触发 creating 和 created 事件。当现有模型被修改并调用 save 方法时，将触发 updating / updated 事件。当创建或更新模型时，即使模型的属性未更改，也会触发 saving / saved 事件。以 -ing 结尾的事件在对模型进行任何更改之前触发，而以 -ed 结尾的事件在对模型的更改持久化之后触发。

要开始监听模型事件，请在您的 Eloquent 模型上定义一个 $dispatchesEvents 属性。此属性将 Eloquent 模型生命周期的各个点映射到您自己的事件类。每个模型事件类都应期望通过其构造函数接收受影响模型的实例。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use App\Events\UserDeleted;
 6use App\Events\UserSaved;
 7use Illuminate\Foundation\Auth\User as Authenticatable;
 8use Illuminate\Notifications\Notifiable;
 9 
10class User extends Authenticatable
11{
12    use Notifiable;
13 
14    /**
15     * The event map for the model.
16     *
17     * @var array<string, string>
18     */
19    protected $dispatchesEvents = [
20        'saved' => UserSaved::class,
21        'deleted' => UserDeleted::class,
22    ];
23}

<?php

namespace App\Models;

use App\Events\UserDeleted;
use App\Events\UserSaved;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * The event map for the model.
     *
     * @var array<string, string>
     */
    protected $dispatchesEvents = [
        'saved' => UserSaved::class,
        'deleted' => UserDeleted::class,
    ];
}

在定义和映射您的 Eloquent 事件之后，您可以使用事件监听器来处理事件。

当通过 Eloquent 发出批量更新或删除查询时，不会为受影响的模型触发 saved、updated、deleting 和 deleted 模型事件。这是因为在执行批量更新或删除时，模型实际上从未被检索。

使用闭包

除了使用自定义事件类之外，您还可以注册闭包，这些闭包在触发各种模型事件时执行。通常，您应该在模型的 booted 方法中注册这些闭包。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6 
 7class User extends Model
 8{
 9    /**
10     * The "booted" method of the model.
11     */
12    protected static function booted(): void
13    {
14        static::created(function (User $user) {
15            // ...
16        });
17    }
18}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     */
    protected static function booted(): void
    {
        static::created(function (User $user) {
            // ...
        });
    }
}

如果需要，您可以在注册模型事件时使用可入队的匿名事件监听器。这将指示 Laravel 使用您的应用程序的队列在后台执行模型事件监听器。

1use function Illuminate\Events\queueable;
2 
3static::created(queueable(function (User $user) {
4    // ...
5}));

use function Illuminate\Events\queueable;

static::created(queueable(function (User $user) {
    // ...
}));

观察者

定义观察器

如果您正在监听给定模型的许多事件，您可以使用观察器将所有监听器分组到一个类中。观察器类的方法名反映了您希望监听的 Eloquent 事件。这些方法中的每一个都接收受影响的模型作为其唯一参数。 make:observer Artisan 命令是创建新观察器类的最简单方法。

1php artisan make:observer UserObserver --model=User

php artisan make:observer UserObserver --model=User

此命令会将新的观察器放置在您的 app/Observers 目录中。如果此目录不存在，Artisan 将为您创建它。您的新观察器将如下所示：

 1<?php
 2 
 3namespace App\Observers;
 4 
 5use App\Models\User;
 6 
 7class UserObserver
 8{
 9    /**
10     * Handle the User "created" event.
11     */
12    public function created(User $user): void
13    {
14        // ...
15    }
16 
17    /**
18     * Handle the User "updated" event.
19     */
20    public function updated(User $user): void
21    {
22        // ...
23    }
24 
25    /**
26     * Handle the User "deleted" event.
27     */
28    public function deleted(User $user): void
29    {
30        // ...
31    }
32 
33    /**
34     * Handle the User "restored" event.
35     */
36    public function restored(User $user): void
37    {
38        // ...
39    }
40 
41    /**
42     * Handle the User "forceDeleted" event.
43     */
44    public function forceDeleted(User $user): void
45    {
46        // ...
47    }
48}

<?php

namespace App\Observers;

use App\Models\User;

class UserObserver
{
    /**
     * Handle the User "created" event.
     */
    public function created(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "updated" event.
     */
    public function updated(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "deleted" event.
     */
    public function deleted(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "restored" event.
     */
    public function restored(User $user): void
    {
        // ...
    }

    /**
     * Handle the User "forceDeleted" event.
     */
    public function forceDeleted(User $user): void
    {
        // ...
    }
}

要注册观察器，您可以将 ObservedBy 属性放在相应的模型上。

1use App\Observers\UserObserver;
2use Illuminate\Database\Eloquent\Attributes\ObservedBy;
3 
4#[ObservedBy([UserObserver::class])]
5class User extends Authenticatable
6{
7    //
8}

use App\Observers\UserObserver;
use Illuminate\Database\Eloquent\Attributes\ObservedBy;

#[ObservedBy([UserObserver::class])]
class User extends Authenticatable
{
    //
}

或者，您可以通过调用您希望观察的模型上的 observe 方法来手动注册观察器。您可以在应用程序的 AppServiceProvider 类的 boot 方法中注册观察器。

 1use App\Models\User;
 2use App\Observers\UserObserver;
 3 
 4/**
 5 * Bootstrap any application services.
 6 */
 7public function boot(): void
 8{
 9    User::observe(UserObserver::class);
10}

use App\Models\User;
use App\Observers\UserObserver;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    User::observe(UserObserver::class);
}

观察器还可以监听其他事件，例如 saving 和 retrieved。这些事件在事件文档中进行了描述。

观察器和数据库事务

当在数据库事务中创建模型时，您可能希望指示观察器仅在数据库事务提交后才执行其事件处理程序。您可以通过在观察器上实现 ShouldHandleEventsAfterCommit 接口来实现此目的。如果数据库事务未进行中，事件处理程序将立即执行。

 1<?php
 2 
 3namespace App\Observers;
 4 
 5use App\Models\User;
 6use Illuminate\Contracts\Events\ShouldHandleEventsAfterCommit;
 7 
 8class UserObserver implements ShouldHandleEventsAfterCommit
 9{
10    /**
11     * Handle the User "created" event.
12     */
13    public function created(User $user): void
14    {
15        // ...
16    }
17}

<?php

namespace App\Observers;

use App\Models\User;
use Illuminate\Contracts\Events\ShouldHandleEventsAfterCommit;

class UserObserver implements ShouldHandleEventsAfterCommit
{
    /**
     * Handle the User "created" event.
     */
    public function created(User $user): void
    {
        // ...
    }
}

静默事件

您有时可能需要暂时“静音”模型触发的所有事件。您可以使用 withoutEvents 方法来实现此目的。 withoutEvents 方法接受一个闭包作为其唯一参数。在此闭包中执行的任何代码都不会分派模型事件，并且闭包返回的任何值都将由 withoutEvents 方法返回。

1use App\Models\User;
2 
3$user = User::withoutEvents(function () {
4    User::findOrFail(1)->delete();
5 
6    return User::find(2);
7});

use App\Models\User;

$user = User::withoutEvents(function () {
    User::findOrFail(1)->delete();

    return User::find(2);
});

在不触发事件的情况下保存单个模型

有时您可能希望“保存”给定的模型而不分派任何事件。您可以使用 saveQuietly 方法来实现此目的。

1$user = User::findOrFail(1);
2 
3$user->name = 'Victoria Faith';
4 
5$user->saveQuietly();

$user = User::findOrFail(1);

$user->name = 'Victoria Faith';

$user->saveQuietly();

您还可以“更新”、“删除”、“软删除”、“恢复”和“复制”给定的模型而不分派任何事件。

1$user->deleteQuietly();
2$user->forceDeleteQuietly();
3$user->restoreQuietly();

$user->deleteQuietly();
$user->forceDeleteQuietly();
$user->restoreQuietly();

序言

入门指南

架构概念

基础知识

深入了解

安全

数据库

Eloquent ORM

测试

软件包

Eloquent：入门指南

产品

软件包

资源