在Laravel 8的下一個(gè)版本中,您可以完全禁用延遲加載,從而導(dǎo)致異常:
防止N+1問題? @themsaid最近對(duì)框架的貢獻(xiàn)允許您完全禁用延遲加載(將引發(fā)異常)…
只能在非生產(chǎn)環(huán)境下禁用它,這樣在一個(gè)進(jìn)程中出錯(cuò)時(shí)生產(chǎn)不會(huì)崩潰!
下周發(fā)布! pic.twitter.com/5Q9YpCLRze
— Taylor Otwell (@taylorotwell) May 19, 2021
防止開發(fā)中的延遲加載可以幫助您在開發(fā)過程的早期捕獲N+1錯(cuò)誤。Laravel生態(tài)系統(tǒng)有各種工具來識(shí)別N+1查詢。然而,這種方法通過拋出一個(gè)異常來將問題放在前面和中心。
推薦:《laravel教程》
演示
讓我們快速瀏覽一下這個(gè)特性,通過旋轉(zhuǎn)框架8.x
分支的開發(fā)版本,因?yàn)樵谧珜懕疚臅r(shí)這個(gè)特性還沒有推出。一旦發(fā)布,您將擁有此功能,而無需切換到最新的8.x
分支。
安裝
首先,創(chuàng)建一個(gè)新的應(yīng)用程序:
laravel new strict-lazy-demo
接下來,我們將更新composer.json
中的laravel/framework
版本,通過將版本調(diào)整為8.x-dev
,確保我們擁有此功能(如果您在下一版本之前嘗試此功能):
{ "require": { "laravel/framework": "8.x-dev" } }
接下來,運(yùn)行composer update
以確保獲得此分支的最新版本代碼:
composer update laravel/framework
此時(shí),您應(yīng)該設(shè)置首選數(shù)據(jù)庫(kù)。我喜歡使用Laravel的默認(rèn)值運(yùn)行本地MySQL實(shí)例,即使用root
用戶而不使用密碼。我發(fā)現(xiàn)在本地使用默認(rèn)的.env
值很方便,無需任何配置即可快速開始。
mysql -uroot -e"create database strict_lazy_demo"
配置所選數(shù)據(jù)庫(kù)后,請(qǐng)確??梢赃w移:
php artisan migrate:fresh
Demo Data
我們將創(chuàng)建一個(gè)Post
模型,并從User
模型中定義一對(duì)多
關(guān)系,以演示此功能。我們將首先創(chuàng)建Post
模型和附帶的文件:
# 使用遷移和工廠創(chuàng)建模型 php artisan make:model -mf Post
首先,讓我們定義Post
遷移和工廠配置:
// 您的文件名將根據(jù)創(chuàng)建文件的時(shí)間而有所不同。 // 2021_05_21_000013_create_posts_table.php Schema::create('posts', function (Blueprint $table) { $table->id(); $table->foreignIdFor(AppModelsUser::class); $table->string('title'); $table->longText('body'); $table->timestamps(); });
接下來,根據(jù)上述模式定義PostFactory
定義方法:
/** * Define the model's default state. * * @return array */ public function definition() { return [ 'user_id' => AppModelsUser::factory(), 'title' => $this->faker->sentence(), 'body' => implode("nn", $this->faker->paragraphs(rand(2,5))), ]; }
最后,打開DatabaseSeeder
文件,并在run()
方法中添加以下內(nèi)容:
/** * 數(shù)據(jù)庫(kù)填充程序。 * * @return void */ public function run() { AppModelsUser::factory() ->has(AppModelsPost::factory()->count(3)) ->create() ; }
關(guān)聯(lián)模型并防止延遲加載
現(xiàn)在我們已經(jīng)創(chuàng)建了遷移文件、填充文件和模型,我們已經(jīng)準(zhǔn)備好將User與Post模型關(guān)聯(lián)起來以演示該特性。向User
模型添加以下方法,以給用戶一個(gè)與Posts的關(guān)聯(lián):
// app/Models/User.php /** * @return IlluminateDatabaseEloquentRelationsHasMany */ public function posts() { return $this->hasMany(Post::class); }
有了這些,我們就可以遷移和填充數(shù)據(jù)庫(kù)了:
php artisan migrate:fresh --seed
如果一切順利,我們將在控制臺(tái)中看到如下內(nèi)容:
現(xiàn)在,我們可以使用tinker檢查我們的填充數(shù)據(jù)和關(guān)系:
php artisan tinker >>> $user = User::first() => AppModelsUser {#4091 id: 1, name: "Nedra Hayes", email: "bruen.marc@example.com", 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 => IlluminateDatabaseEloquentCollection {#3686 all: [ AppModelsPost {#3369 id: 1, ...
$user->posts
屬性實(shí)際上調(diào)用了數(shù)據(jù)庫(kù),因此是“惰性”的,但沒有進(jìn)行優(yōu)化。延遲加載的便利性很好,但從長(zhǎng)遠(yuǎn)來看,它可能帶來沉重的性能負(fù)擔(dān)。
禁用延遲加載
現(xiàn)在我們已經(jīng)設(shè)置了模型,我們可以在應(yīng)用程序中禁用延遲加載。您可能只希望在非生產(chǎn)環(huán)境中禁用,這很容易實(shí)現(xiàn)!打開“AppServiceProvider”類并將以下內(nèi)容添加到“boot()”方法:
// app/Providers/AppServiceProvider.php public function boot() { Model::preventLazyLoading(! app()->isProduction()); }
當(dāng)你再次運(yùn)行 php artisan tinker
, 此時(shí)您應(yīng)該會(huì)收到延遲加載違規(guī)的異常:
php artisan tinker >>> $user = AppModelsUser::first() => AppModelsUser {#3685 id: 1, name: "Nedra Hayes", email: "bruen.marc@example.com", 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 IlluminateDatabaseLazyLoadingViolationException with message 'Attempted to lazy load [posts] on model [AppModelsUser] but lazy loading is disabled.'
如果要觀察在視圖中使用延遲加載時(shí)發(fā)生的情況,請(qǐng)按照如下方式修改默認(rèn)路由:
Route::get('/', function () { return view('welcome', [ 'user' => AppModelsUser::first() ]); });
接下來,在 welcome.blade.php
文件中某處添加以下內(nèi)容:
<h2>Posts</h2> @foreach($user->posts as $post) <h3>{{ $post->title }}</h3> <p> {{ $post->body }} </p> @endforeach
如果您通過 Valet 或 artisan serve
加載您的應(yīng)用程序,您應(yīng)該會(huì)看到類似于以下錯(cuò)誤頁(yè)面的內(nèi)容:
盡管您在開發(fā)過程中會(huì)遇到異常,但只要您在服務(wù)提供者中正確設(shè)置了環(huán)境檢查,意外部署觸發(fā)延遲加載的代碼將繼續(xù)工作。