视图

简介

当然,从路由和控制器直接返回整个 HTML 文档字符串并不实际。幸运的是,视图提供了一种便捷的方式,将所有 HTML 放在单独的文件中。

视图将控制器/应用程序逻辑与展示逻辑分开,并存储在 resources/views 目录中。在 Laravel 中,视图模板通常使用 【Blade 模板语言】编写。一个简单的视图可能如下所示:

<!-- View stored in 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']);
});

想要了解更多关于如何编写 Blade 模板的信息吗?可以查看完整的 【Blade 文档】来入门。

在 React / Vue 中编写视图

许多开发者开始倾向于使用 React 或 Vue 来编写前端模板,而不是通过 Blade 在 PHP 中编写模板。得益于 Inertia,一个使得将 React / Vue 前端与 Laravel 后端轻松结合的库,Laravel 使这一过程变得简单,避免了构建单页应用(SPA)时通常遇到的复杂性。

我们的 Breeze 和 Jetstream 【启动包】为你下一个基于 Inertia 的 Laravel 应用提供了一个很好的起点。此外,【Laravel Bootcamp】 提供了一个完整的示范,展示了如何构建一个由 Inertia 支持的 Laravel 应用,其中包括 Vue 和 React 示例。

创建和渲染视图

你可以通过在应用的 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 门面返回:

use Illuminate\Support\Facades\View;

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

如你所见,传递给 view 助手的第一个参数对应于 resources/views 目录中视图文件的名称。第二个参数是一个数据数组,这些数据会被传递给视图。在这个例子中,我们传递了 name 变量,该变量会通过 【Blade 语法】显示在视图中。

嵌套视图目录

视图也可以嵌套在 resources/views 目录的子目录中。可以使用 “点” 符号来引用嵌套视图。例如,如果你的视图存储在 resources/views/admin/profile.blade.php,你可以通过以下方式从应用的路由/控制器中返回它:

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

视图目录的名称不应包含 . 字符。

创建第一个可用的视图

使用 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']);

当以这种方式传递数据时,数据应该是一个包含键值对的数组。在视图中,你可以通过数据的键来访问每个值,例如:<?php echo $name; ?>

作为传递数据的替代方式,你也可以使用 with 方法将单个数据项添加到视图中。with 方法返回视图对象的实例,因此你可以继续链式调用方法,然后再返回视图:

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

向所有视图共享数据

有时你可能需要与应用程序渲染的所有视图共享数据。你可以使用 View facade 的 share 方法来实现。通常,你应该在服务提供者的 boot 方法中调用 share 方法。你可以将它们添加到 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 是在视图渲染时调用的回调或类方法。如果你有一些数据希望在每次渲染视图时绑定到该视图,视图 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
{
    /**
     * 创建新的 profile composer。
     */
    public function __construct(
        protected UserRepository $users,
    ) {}

    /**
     * 绑定数据到视图。
     */
    public function compose(View $view): void
    {
        $view->with('count', $this->users->count());
    }
}

如你所见,所有的视图 composer 都是通过【服务容器】解决的,因此你可以在 composer 的构造函数中类型提示你需要的任何依赖。

将 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) {
    // ...
});

视图创建器

视图 “创建器” 与视图 composer 非常相似;但是,它们在视图实例化后立即执行,而不是等到视图即将渲染时才执行。要注册一个视图创建器,可以使用 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