展開文件目錄

視圖

簡介

當然,直接從路由與控制器回傳完整的 HTML 文件字串並不實際。幸運的是,視圖提供了一種方便的方法,可以將所有的 HTML 放在獨立檔案中。

視圖將你的控制器 / 應用程式邏輯與呈現邏輯分開,並儲存在 resources/views 目錄中。使用 Laravel 時,視圖模板通常使用 Blade 模板語言 編寫。一個簡單的視圖可能看起來像這樣:

<!-- 視圖儲存在 resources/views/greeting.blade.php -->

<html>
    <body>
        <h1>Hello, {{ $name }}</h1>
    </body>
</html>

由於此視圖儲存在 resources/views/greeting.blade.php,我們可以使用全域的 view 輔助函式來回傳它,如下所示:

Route::get('/', function () {
    return view('greeting', ['name' => 'James']);
});

[!NOTE] 正在尋找更多關於如何編寫 Blade 模板的資訊?請查看完整的 Blade 說明文件 以開始使用。

在 React / Svelte / Vue 中編寫視圖

許多開發者開始傾向於使用 React、Svelte 或 Vue 來編寫模板,而不是透過 Blade 在 PHP 中編寫前端模板。感謝 Inertia,Laravel 讓這件事變得輕而易舉。Inertia 是一個函式庫,讓你能夠輕鬆地將 React / Svelte / Vue 前端與 Laravel 後端聯繫起來,而無需面對構建 SPA 時常見的複雜性。

我們的 React、Svelte 與 Vue 應用程式入門套件 為你下一個由 Inertia 驅動的 Laravel 應用程式提供了一個極佳的起點。

建立與渲染視圖

你可以在應用程式的 resources/views 目錄中放置一個副檔名為 .blade.php 的檔案,或使用 make:view Artisan 指令來建立視圖:

php artisan make:view greeting

.blade.php 副檔名會告知框架該檔案包含 Blade 模板。Blade 模板包含 HTML 以及 Blade 指令,讓你可以輕鬆地印出值、建立 "if" 語句、對資料進行迭代等等。

建立視圖後,你可以使用全域的 view 輔助函式從應用程式的路由或控制器回傳它:

Route::get('/', function () {
    return view('greeting', ['name' => 'James']);
});

也可以使用 View Facade 回傳視圖:

use Illuminate\Support\Facades\View;

return View::make('greeting', ['name' => 'James']);

如你所見,傳遞給 view 輔助函式的第一個參數對應於 resources/views 目錄中的視圖檔案名稱。第二個參數是一個陣列,其中的資料將提供給該視圖使用。在此範例中,我們傳遞了 name 變數,並在視圖中使用 Blade 語法 顯示。

巢狀視圖目錄

視圖也可以巢狀放置在 resources/views 目錄的子目錄中。可以使用「點 (dot)」標記法來引用巢狀視圖。例如,如果你的視圖儲存在 resources/views/admin/profile.blade.php,你可以從應用程式的路由 / 控制器中像這樣回傳它:

return view('admin.profile', $data);

[!WARNING] 視圖目錄名稱不應包含 . 字元。

建立第一個可用的視圖

使用 View Facade 的 first 方法,你可以建立給定視圖陣列中第一個存在的視圖。如果你的應用程式或套件允許自訂或覆寫視圖,這會非常有用:

use Illuminate\Support\Facades\View;

return View::first(['custom.admin', 'admin'], $data);

確認視圖是否存在

如果你需要確認視圖是否存在,可以使用 View Facade。如果視圖存在,exists 方法將回傳 true

use Illuminate\Support\Facades\View;

if (View::exists('admin.profile')) {
    // ...
}

傳遞資料至視圖

正如你在前面的範例中所看到的,你可以向視圖傳遞一個資料陣列,使該資料在視圖中可用:

return view('greetings', ['name' => 'Victoria']);

以這種方式傳遞資訊時,資料應為鍵值對 (key / value pairs) 的陣列。提供資料給視圖後,你就可以在視圖中使用資料的鍵來存取每個值,例如 <?php echo $name; ?>

除了向 view 輔助函式傳遞完整的資料陣列之外,你還可以使用 with 方法向視圖添加個別的資料片段。with 方法會回傳視圖物件的實例,因此你可以在回傳視圖之前繼續鏈結方法:

return view('greeting')
    ->with('name', 'Victoria')
    ->with('occupation', 'Astronaut');

與所有視圖共享資料

有時,你可能需要與應用程式渲染的所有視圖共享資料。你可以使用 View Facade 的 share 方法來做到這一點。通常,你應該將 share 方法的呼叫放在服務提供者的 boot 方法中。你可以自由地將它們添加到 App\Providers\AppServiceProvider 類別中,或者生成一個獨立的服務提供者來存放它們:

<?php

namespace App\Providers;

use Illuminate\Support\Facades\View;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 註冊任何應用程式服務。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 引導任何應用程式服務。
     */
    public function boot(): void
    {
        View::share('key', 'value');
    }
}

視圖 Composer

視圖 Composer (View Composers) 是在渲染視圖時被呼叫的回呼函式或類別方法。如果你有資料想在每次渲染某個視圖時都綁定到該視圖,視圖 Composer 可以幫助你將該邏輯組織到單一位置。如果你的應用程式中有多個路由或控制器回傳同一個視圖,且該視圖始終需要某個特定的資料片段,那麼視圖 Composer 就特別有用。

通常,視圖 Composer 會在應用程式的其中一個 服務提供者 中註冊。在本範例中,我們假設 App\Providers\AppServiceProvider 將存放此邏輯。

我們將使用 View Facade 的 composer 方法來註冊視圖 Composer。Laravel 不包含類別視圖 Composer 的預設目錄,因此你可以隨意組織它們。例如,你可以建立一個 app/View/Composers 目錄來存放應用程式所有的視圖 Composer:

<?php

namespace App\Providers;

use App\View\Composers\ProfileComposer;
use Illuminate\Support\Facades;
use Illuminate\Support\ServiceProvider;
use Illuminate\View\View;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 註冊任何應用程式服務。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 引導任何應用程式服務。
     */
    public function boot(): void
    {
        // 使用類別型的 Composer...
        Facades\View::composer('profile', ProfileComposer::class);

        // 使用閉包型的 Composer...
        Facades\View::composer('welcome', function (View $view) {
            // ...
        });

        Facades\View::composer('dashboard', function (View $view) {
            // ...
        });
    }
}

現在我們已經註冊了 Composer,每次渲染 profile 視圖時,都會執行 App\View\Composers\ProfileComposer 類別的 compose 方法。讓我們來看看一個 Composer 類別的範例:

<?php

namespace App\View\Composers;

use App\Repositories\UserRepository;
use Illuminate\View\View;

class ProfileComposer
{
    /**
     * 建立一個新的個人資料 Composer。
     */
    public function __construct(
        protected UserRepository $users,
    ) {}

    /**
     * 將資料綁定到視圖。
     */
    public function compose(View $view): void
    {
        $view->with('count', $this->users->count());
    }
}

如你所見,所有的視圖 Composer 都是透過 服務容器 解析的,因此你可以在 Composer 的建構函式中型別提示 (type-hint) 任何你需要的依賴。

將 Composer 附加到多個視圖

你可以透過向 composer 方法的第一個參數傳遞視圖陣列,一次將視圖 Composer 附加到多個視圖:

use App\Views\Composers\MultiComposer;
use Illuminate\Support\Facades\View;

View::composer(
    ['profile', 'dashboard'],
    MultiComposer::class
);

composer 方法也接受 * 字元作為萬用字元,讓你將 Composer 附加到所有視圖:

use Illuminate\Support\Facades;
use Illuminate\View\View;

Facades\View::composer('*', function (View $view) {
    // ...
});

視圖 Creator

視圖「Creator」(View Creators) 與視圖 Composer 非常相似;然而,它們是在視圖實例化後立即執行的,而不是等到視圖即將渲染時。要註冊視圖 Creator,請使用 creator 方法:

use App\View\Creators\ProfileCreator;
use Illuminate\Support\Facades\View;

View::creator('profile', ProfileCreator::class);

最佳化視圖

預設情況下,Blade 模板視圖是按需編譯的。當執行渲染視圖的請求時,Laravel 會判斷是否存在該視圖的編譯版本。如果檔案存在,Laravel 會接著判斷未編譯的視圖是否比編譯後的視圖更晚修改過。如果編譯後的視圖不存在,或者未編譯的視圖已被修改,Laravel 將重新編譯該視圖。

在請求期間編譯視圖可能會對效能產生微小的負面影響,因此 Laravel 提供了 view:cache Artisan 指令來預先編譯應用程式使用的所有視圖。為了提高效能,你可能希望將此指令作為部署過程的一部分執行:

php artisan view:cache

你可以使用 view:clear 指令來清除視圖快取:

php artisan view:clear