Eloquent: 入门指南

介绍
定义模型
- Eloquent 模型约定
检索多个模型
检索单个模型/聚合
- 检索聚合
插入和更新模型
删除模型
- 软删除
- 查询软删除的模型
查询作用域
- 全局作用域
- 本地作用域
事件

介绍

Laravel 附带的 Eloquent ORM 提供了一种美观、简单的 ActiveRecord 实现，用于与数据库交互。每个数据库表都有一个对应的“模型”，用于与该表交互。模型允许您查询表中的数据，以及向表中插入新记录。

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

定义模型

要开始，请创建一个 Eloquent 模型。模型通常位于 app 目录中，但您可以将它们放置在 composer.json 文件中可以自动加载的任何位置。所有 Eloquent 模型都扩展 Illuminate\Database\Eloquent\Model 类。

创建模型实例的最简单方法是使用 make:model Artisan 命令：

php

php artisan make:model User

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

php

php artisan make:model User --migration

php artisan make:model User -m

Eloquent 模型约定

现在，让我们看一个 Flight 模型类的示例，我们将使用它来从 flights 数据库表中检索和存储信息：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    //
}

表名

请注意，我们没有告诉 Eloquent 使用哪个表来存储 Flight 模型。类名的“蛇形命名法”复数形式将用作表名，除非显式指定了其他名称。因此，在这种情况下，Eloquent 将假定 Flight 模型存储在 flights 表中。您可以通过在模型上定义 table 属性来指定自定义表：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 与模型关联的表。
     *
     * @var string
     */
    protected $table = 'my_flights';
}

主键

Eloquent 还假定每个表都有一个名为 id 的主键列。您可以定义 $primaryKey 属性来覆盖此约定。

此外，Eloquent 假定主键是递增的整数值，这意味着默认情况下主键将自动转换为 int。如果您希望使用非递增或非数字的主键，必须将模型上的公共 $incrementing 属性设置为 false。

时间戳

默认情况下，Eloquent 期望表中存在 created_at 和 updated_at 列。如果您不希望 Eloquent 自动管理这些列，请将模型上的 $timestamps 属性设置为 false：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 指示模型是否应被时间戳。
     *
     * @var bool
     */
    public $timestamps = false;
}

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

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 模型日期列的存储格式。
     *
     * @var string
     */
    protected $dateFormat = 'U';
}

数据库连接

默认情况下，所有 Eloquent 模型将使用为应用程序配置的默认数据库连接。如果您希望为模型指定不同的连接，请使用 $connection 属性：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 模型的连接名称。
     *
     * @var string
     */
    protected $connection = 'connection-name';
}

检索多个模型

一旦创建了模型和其关联的数据库表，您就可以开始从数据库中检索数据。将每个 Eloquent 模型视为一个强大的查询构建器，允许您流畅地查询与模型关联的数据库表。例如：

php

<?php

namespace App\Http\Controllers;

use App\Flight;
use App\Http\Controllers\Controller;

class FlightController extends Controller
{
    /**
     * 显示所有可用航班的列表。
     *
     * @return Response
     */
    public function index()
    {
        $flights = Flight::all();

        return view('flight.index', ['flights' => $flights]);
    }
}

访问列值

如果您有一个 Eloquent 模型实例，可以通过访问相应的属性来访问模型的列值。例如，让我们遍历查询返回的每个 Flight 实例并输出 name 列的值：

php

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

添加额外的约束

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

php

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

由于 Eloquent 模型是查询构建器，您应该查看查询构建器上可用的所有方法。您可以在 Eloquent 查询中使用这些方法。

集合

对于像 all 和 get 这样检索多个结果的 Eloquent 方法，将返回 Illuminate\Database\Eloquent\Collection 的实例。Collection 类提供了多种有用的方法来处理 Eloquent 结果。当然，您可以像数组一样遍历此集合：

php

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

分块结果

如果您需要处理成千上万的 Eloquent 记录，请使用 chunk 命令。chunk 方法将检索一块 Eloquent 模型，并将其传递给给定的 Closure 进行处理。使用 chunk 方法在处理大型结果集时将节省内存：

php

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

传递给方法的第一个参数是您希望每个“块”接收的记录数。作为第二个参数传递的闭包将在从数据库中检索到的每个块上调用。

数据库查询将在每个块上重新执行。

使用游标

cursor 方法允许您使用游标遍历数据库记录。在处理大量数据时，cursor 方法可用于大大减少内存使用：

php

foreach (Flight::where('foo', 'bar')->cursor() as $flight) {
    //
}

检索单个模型/聚合

当然，除了检索给定表的所有记录外，您还可以使用 find 和 first 检索单个记录。这些方法返回单个模型实例，而不是返回模型集合：

php

// 通过主键检索模型...
$flight = App\Flight::find(1);

// 检索第一个匹配查询约束的模型...
$flight = App\Flight::where('active', 1)->first();

您还可以使用主键数组调用 find 方法，这将返回匹配记录的集合：

php

$flights = App\Flight::find([1, 2, 3]);

未找到异常

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

php

$model = App\Flight::findOrFail(1);

$model = App\Flight::where('legs', '>', 100)->firstOrFail();

如果未捕获异常，将自动向用户发送 404 HTTP 响应，因此在使用这些方法时无需编写显式检查以返回 404 响应：

php

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

检索聚合

当然，您还可以使用查询构建器提供的 count、sum、max 和其他聚合函数。这些方法返回适当的标量值，而不是完整的模型实例：

php

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

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

插入和更新模型

基本插入

要在数据库中创建新记录，只需创建一个新的模型实例，在模型上设置属性，然后调用 save 方法：

php

<?php

namespace App\Http\Controllers;

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

class FlightController extends Controller
{
    /**
     * 创建一个新的航班实例。
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        // 验证请求...

        $flight = new Flight;

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

        $flight->save();
    }
}

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

基本更新

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

php

$flight = App\Flight::find(1);

$flight->name = 'New Flight Name';

$flight->save();

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

php

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

update 方法期望一个表示应更新的列和值对的数组。

批量赋值

您还可以使用 create 方法在一行中保存新模型。插入的模型实例将从方法中返回给您。但是，在这样做之前，您需要在模型上指定 fillable 或 guarded 属性，因为所有 Eloquent 模型都防止批量赋值。

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

因此，要开始，您应该定义要批量赋值的模型属性。您可以使用模型上的 $fillable 属性来执行此操作。例如，让我们将 Flight 模型的 name 属性设为可批量赋值：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 可批量赋值的属性。
     *
     * @var array
     */
    protected $fillable = ['name'];
}

一旦我们将属性设为可批量赋值，就可以使用 create 方法在数据库中插入新记录。create 方法返回保存的模型实例：

php

$flight = App\Flight::create(['name' => 'Flight 10']);

虽然 $fillable 充当可批量赋值属性的“白名单”，但您也可以选择使用 $guarded。$guarded 属性应包含您不希望批量赋值的属性数组。数组中未包含的所有其他属性将可批量赋值。因此，$guarded 的功能类似于“黑名单”。当然，您应该使用 $fillable 或 $guarded - 而不是两者：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 不可批量赋值的属性。
     *
     * @var array
     */
    protected $guarded = ['price'];
}

在上面的示例中，除 price 外的所有属性都将可批量赋值。

其他创建方法

您可以使用其他两种方法通过批量赋值属性来创建模型：firstOrCreate 和 firstOrNew。firstOrCreate 方法将尝试使用给定的列/值对定位数据库记录。如果在数据库中找不到模型，将使用给定的属性插入一条记录。

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

php

// 通过属性检索航班，如果不存在则创建它...
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);

// 通过属性检索航班，或实例化一个新实例...
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);

删除模型

要删除模型，请在模型实例上调用 delete 方法：

php

$flight = App\Flight::find(1);

$flight->delete();

通过键删除现有模型

在上面的示例中，我们在调用 delete 方法之前从数据库中检索模型。但是，如果您知道模型的主键，可以在不检索模型的情况下删除模型。为此，请调用 destroy 方法：

php

App\Flight::destroy(1);

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

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

通过查询删除模型

当然，您还可以对一组模型运行删除查询。在此示例中，我们将删除所有标记为非活动的航班：

php

$deletedRows = App\Flight::where('active', 0)->delete();

软删除

除了实际从数据库中删除记录外，Eloquent 还可以“软删除”模型。当模型被软删除时，它们实际上并没有从数据库中删除。相反，deleted_at 属性将在模型上设置并插入到数据库中。如果模型具有非空的 deleted_at 值，则该模型已被软删除。要为模型启用软删除，请在模型上使用 Illuminate\Database\Eloquent\SoftDeletes trait，并将 deleted_at 列添加到 $dates 属性中：

php

<?php

namespace App;

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

class Flight extends Model
{
    use SoftDeletes;

    /**
     * 应转换为日期的属性。
     *
     * @var array
     */
    protected $dates = ['deleted_at'];
}

当然，您应该将 deleted_at 列添加到数据库表中。Laravel schema builder 包含一个帮助方法来创建此列：

php

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

现在，当您在模型上调用 delete 方法时，deleted_at 列将设置为当前日期和时间。而且，在查询使用软删除的模型时，软删除的模型将自动从所有查询结果中排除。

要确定给定的模型实例是否已被软删除，请使用 trashed 方法：

php

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

查询软删除的模型

包含软删除的模型

如上所述，软删除的模型将自动从查询结果中排除。但是，您可以使用查询上的 withTrashed 方法强制软删除的模型出现在结果集中：

php

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

withTrashed 方法也可以在关系查询上使用：

php

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

仅检索软删除的模型

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

php

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

恢复软删除的模型

有时您可能希望“取消删除”软删除的模型。要将软删除的模型恢复到活动状态，请在模型实例上使用 restore 方法：

php

$flight->restore();

您还可以在查询中使用 restore 方法快速恢复多个模型：

php

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

与 withTrashed 方法类似，restore 方法也可以在关系上使用：

php

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

永久删除模型

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

php

// 强制删除单个模型实例...
$flight->forceDelete();

// 强制删除所有相关模型...
$flight->history()->forceDelete();

查询作用域

全局作用域

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

编写全局作用域

编写全局作用域很简单。定义一个实现 Illuminate\Database\Eloquent\Scope 接口的类。此接口要求您实现一个方法：apply。apply 方法可以根据需要向查询添加 where 约束：

php

<?php

namespace App\Scopes;

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

class AgeScope implements Scope
{
    /**
     * 将作用域应用于给定的 Eloquent 查询构建器。
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public function apply(Builder $builder, Model $model)
    {
        return $builder->where('age', '>', 200);
    }
}

在默认的 Laravel 应用程序中没有为作用域预定义的文件夹，因此请随意在 Laravel 应用程序的 app 目录中创建自己的 Scopes 文件夹。

应用全局作用域

要将全局作用域分配给模型，您应该重写给定模型的 boot 方法并使用 addGlobalScope 方法：

php

<?php

namespace App;

use App\Scopes\AgeScope;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 模型的“启动”方法。
     *
     * @return void
     */
    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope(new AgeScope);
    }
}

添加作用域后，对 User::all() 的查询将生成以下 SQL：

php

select * from `users` where `age` > 200

匿名全局作用域

Eloquent 还允许您使用闭包定义全局作用域，这对于不需要单独类的简单作用域特别有用：

php

<?php

namespace App;

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

class User extends Model
{
    /**
     * 模型的“启动”方法。
     *
     * @return void
     */
    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope('age', function(Builder $builder) {
            $builder->where('age', '>', 200);
        });
    }
}

addGlobalScope() 的第一个参数用作删除作用域的标识符：

php

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

移除全局作用域

如果您希望为给定查询删除全局作用域，可以使用 withoutGlobalScope 方法：

php

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

如果您希望删除多个甚至所有全局作用域，可以使用 withoutGlobalScopes 方法：

php

User::withoutGlobalScopes()->get();

User::withoutGlobalScopes([FirstScope::class, SecondScope::class])->get();

本地作用域

本地作用域允许您定义可以在整个应用程序中轻松重用的常见约束集。例如，您可能需要频繁检索所有被视为“受欢迎”的用户。要定义作用域，只需在 Eloquent 模型方法前加上 scope 前缀。

作用域应始终返回查询构建器实例：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 将查询作用域限制为仅包含受欢迎的用户。
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePopular($query)
    {
        return $query->where('votes', '>', 100);
    }

    /**
     * 将查询作用域限制为仅包含活跃用户。
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeActive($query)
    {
        return $query->where('active', 1);
    }
}

使用查询作用域

定义作用域后，可以在查询模型时调用作用域方法。但是，调用方法时不需要包含 scope 前缀。您甚至可以将对各种作用域的调用链接在一起，例如：

php

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

动态作用域

有时您可能希望定义一个接受参数的作用域。要开始，只需将额外的参数添加到作用域中。作用域参数应在 $query 参数之后定义：

php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 将查询作用域限制为仅包含给定类型的用户。
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOfType($query, $type)
    {
        return $query->where('type', $type);
    }
}

现在，您可以在调用作用域时传递参数：

php

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

事件

Eloquent 模型触发多个事件，允许您在模型生命周期的各个点使用以下方法挂钩：creating、created、updating、updated、saving、saved、deleting、deleted、restoring、restored。事件允许您在每次特定模型类在数据库中保存或更新时轻松执行代码。

基本用法

每当首次保存新模型时，将触发 creating 和 created 事件。如果模型已存在于数据库中并调用 save 方法，将触发 updating / updated 事件。但是，在这两种情况下，都会触发 saving / saved 事件。

例如，让我们在服务提供者中定义一个 Eloquent 事件监听器。在我们的事件监听器中，我们将调用给定模型的 isValid 方法，如果模型无效，则返回 false。从 Eloquent 事件监听器返回 false 将取消 save / update 操作：

php

<?php

namespace App\Providers;

use App\User;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        User::creating(function ($user) {
            if ( ! $user->isValid()) {
                return false;
            }
        });
    }

    /**
     * 注册服务提供者。
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

Eloquent: 入门指南 ​

介绍 ​

定义模型 ​

Eloquent 模型约定 ​

表名 ​

主键 ​

时间戳 ​

数据库连接 ​

检索多个模型 ​

访问列值 ​

添加额外的约束 ​

集合 ​

分块结果 ​

使用游标 ​

检索单个模型/聚合 ​

未找到异常 ​

检索聚合 ​

插入和更新模型 ​

基本插入 ​

基本更新 ​

批量赋值 ​

其他创建方法 ​

删除模型 ​

通过键删除现有模型 ​

通过查询删除模型 ​

软删除 ​

查询软删除的模型 ​

包含软删除的模型 ​

仅检索软删除的模型 ​

恢复软删除的模型 ​

永久删除模型 ​

查询作用域 ​

全局作用域 ​

编写全局作用域 ​

应用全局作用域 ​

匿名全局作用域 ​

移除全局作用域 ​

本地作用域 ​

使用查询作用域 ​

动态作用域 ​

事件 ​

基本用法 ​

Eloquent: 入门指南

介绍

定义模型

Eloquent 模型约定

表名

主键

时间戳

数据库连接

检索多个模型

访问列值

添加额外的约束

集合

分块结果

使用游标

检索单个模型/聚合

未找到异常

检索聚合

插入和更新模型

基本插入

基本更新

批量赋值

其他创建方法

删除模型

通过键删除现有模型

通过查询删除模型

软删除

查询软删除的模型

包含软删除的模型

仅检索软删除的模型

恢复软删除的模型

永久删除模型

查询作用域

全局作用域

编写全局作用域

应用全局作用域

匿名全局作用域

移除全局作用域

本地作用域

使用查询作用域

动态作用域

事件

基本用法