立即禁用延迟加载来查找 N+1 个问题

在 Laravel 8 的下一个版本中，您可以完全禁用延迟加载，这将导致异常

严格防止 N+1 查询问题？@themsaid最近对框架的贡献允许您完全禁用延迟加载（将抛出异常）...

可以仅在非生产环境中禁用它，这样如果出现错误，生产环境就不会崩溃！💅

下周发布！pic.twitter.com/5Q9YpCLRze

— Taylor Otwell 🪐 (@taylorotwell) 2021 年 5 月 19 日

在开发过程中阻止延迟加载可以帮助您尽早发现开发过程中的 N+1 错误。Laravel 生态系统有各种工具可以识别 N+1 查询。但是，这种方法通过抛出异常将问题直接呈现在您面前。

#演示

让我们通过快速启动框架 8.x 分支的开发版本来快速浏览一下此功能，因为撰写本文时该功能尚未发布。发布后，您将拥有此功能，无需切换到最新的 8.x 分支。

#安装

首先，创建一个新应用程序

laravel new strict-lazy-demo

接下来，我们将更新 composer.json 中的 laravel/framework 版本，以确保我们拥有此功能（如果您在下一个版本发布之前尝试它），方法是将版本调整为 8.x-dev

{
    "require": {
        "laravel/framework": "8.x-dev"
    }
}

接下来，运行 composer update 以确保您获得了此分支的最新代码版本

composer update laravel/framework

此时，您应该设置首选数据库。我喜欢使用 Laravel 的默认值运行本地 MySQL 实例，该实例使用 root 用户，没有密码。我发现使用默认的 .env 值在本地快速开始而无需任何配置非常方便。

mysql -uroot -e"create database strict_lazy_demo"

配置好所选数据库后，请确保可以迁移

php artisan migrate:fresh

#演示数据

我们将创建一个 Post 模型并从 User 模型定义一个 一对多 关系来演示此功能。我们将从创建 Post 模型以及相关文件开始

# Create a model with migration and factory
php artisan make:model -mf Post

首先，让我们定义 Post 迁移和工厂配置

// Your filename will differ based on when you create the file.
// 2021_05_21_000013_create_posts_table.php
 
Schema::create('posts', function (Blueprint $table) {
    $table->id();
    $table->foreignIdFor(\App\Models\User::class);
    $table->string('title');
    $table->longText('body');
    $table->timestamps();
});

接下来，根据上面的模式定义 PostFactory 的定义方法

/**
 * Define the model's default state.
 *
 * @return array
 */
public function definition()
{
    return [
        'user_id' => \App\Models\User::factory(),
        'title' => $this->faker->sentence(),
        'body' => implode("\n\n", $this->faker->paragraphs(rand(2,5))),
    ];
}

最后，打开 DatabaseSeeder 文件，并在 run() 方法中添加以下内容

/**
 * Seed the application's database.
 *
 * @return void
 */
public function run()
{
    \App\Models\User::factory()
        ->has(\App\Models\Post::factory()->count(3))
        ->create()
    ;
}

#关联模型并阻止延迟加载

现在我们已经创建了迁移、种子和模型，我们已准备好将用户与 Post 模型关联以演示此功能。

向 User 模型添加以下方法，让用户与 Posts 关联

// app/Models/User.php
/**
 * @return \Illuminate\Database\Eloquent\Relations\HasMany
 */
public function posts()
{
    return $this->hasMany(Post::class);
}

有了它，我们就可以迁移并播种数据库

php artisan migrate:fresh --seed

如果一切顺利，我们应该在控制台中看到以下内容

现在我们可以使用 tinker 检查我们播种的数据和关系

php artisan tinker
 
>>> $user = User::first()
=> App\Models\User {#4091
     id: 1,
     name: "Nedra Hayes",
     email: "[email protected]",
     email_verified_at: "2021-05-21 00:35:59",
     created_at: "2021-05-21 00:35:59",
     updated_at: "2021-05-21 00:35:59",
   }
>>> $user->posts
=> Illuminate\Database\Eloquent\Collection {#3686
     all: [
       App\Models\Post {#3369
         id: 1,
...

$user->posts 属性实际上调用了数据库，因此是“延迟的”，但没有优化。延迟加载的便利性很好，但从长远来看，它可能会带来沉重的性能负担。

#禁用延迟加载

现在我们已经设置了模型，我们可以禁用整个应用程序的延迟加载。您可能只想在非生产环境中禁用它，这很容易实现！打开 AppServiceProvider 类，并在 boot() 方法中添加以下内容

// app/Providers/AppServiceProvider.php
 
public function boot()
{
    Model::preventLazyLoading(! app()->isProduction());
}

如果您再次运行 php artisan tinker 会话，这次您应该会收到延迟加载违规的异常

php artisan tinker
 
>>> $user = \App\Models\User::first()
=> App\Models\User {#3685
     id: 1,
     name: "Nedra Hayes",
     email: "[email protected]",
     email_verified_at: "2021-05-21 00:35:59",
     #password: "$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi",
     #remember_token: "jHSxFGKOdw",
     created_at: "2021-05-21 00:35:59",
     updated_at: "2021-05-21 00:35:59",
   }
>>> $user->posts
Illuminate\Database\LazyLoadingViolationException with message
'Attempted to lazy load [posts] on model [App\Models\User] but lazy loading is disabled.'

如果您想可视化在视图文件中使用延迟加载时会发生什么，请修改默认路由，如下所示

Route::get('/', function () {
    return view('welcome', [
        'user' => \App\Models\User::first()
    ]);
});

接下来，在 welcome.blade.php 文件中的某个位置添加以下内容

<h2>Posts</h2>
@foreach($user->posts as $post)
    <h3>{{ $post->title }}</h3>
    <p>
        {{ $post->body }}
    </p>
@endforeach

如果您通过 Valet 或 artisan serve 加载应用程序，您应该会看到类似以下的错误页面

虽然您会在开发过程中收到异常，但只要在服务提供者中正确设置环境检查，意外部署触发延迟加载的代码将继续工作。

#了解更多

您可以了解此功能是如何实现的：8.x 添加 eloquent 严格加载模式 - 拉取请求 #37363。非常感谢 Mohamed Said、贡献者，当然还有 Taylor Otwell，他们添加了抛光来有条件地禁用延迟加载。