laravel
10. 软件包
Laravel Folio

介绍

Laravel Folio (opens in a new tab) 是一个强大的基于页面的路由器，旨在简化 Laravel 应用程序中的路由。使用 Laravel Folio，生成路由就像在应用程序的 resources/views/pages 目录中创建一个 Blade 模板一样轻松。

例如，要创建一个可在 /greeting URL 访问的页面，只需在应用程序的 resources/views/pages 目录中创建一个 greeting.blade.php 文件：

<div>
    Hello World
</div>

安装

首先，使用 Composer 包管理器将 Folio 安装到您的项目中：

composer require laravel/folio

安装 Folio 后，您可以执行 folio:install Artisan 命令，该命令将把 Folio 的服务提供器安装到您的应用程序中。此服务提供器会注册 Folio 搜索路由/页面的目录：

php artisan folio:install

页面路径/URI

默认情况下，Folio 从您的应用程序的 resources/views/pages 目录提供页面，但您可以在 Folio 服务提供器的 boot 方法中自定义这些目录。

例如，有时在同一个 Laravel 应用程序中指定多个 Folio 路径可能会很方便。您可能希望为应用程序的“管理员”区域使用一个单独的 Folio 页面目录，同时为应用程序的其余页面使用另一个目录。

您可以使用 Folio::path 和 Folio::uri 方法来实现此目的。path 方法注册一个目录，当路由传入的 HTTP 请求时，Folio 将扫描该目录以查找页面，而 uri 方法指定该页面目录的“基础 URI”：

use Laravel\Folio\Folio;
 
Folio::path(resource_path('views/pages/guest'))->uri('/');
 
Folio::path(resource_path('views/pages/admin'))
    ->uri('/admin')
    ->middleware([
        '*' => [
            'auth',
            'verified',
 
            //...
        ],
    ]);

子域名路由

您还可以根据传入请求的子域名来路由到页面。例如，您可能希望将来自 admin.example.com 的请求路由到与其他 Folio 页面不同的页面目录。您可以通过在调用 Folio::path 方法后调用 domain 方法来实现此目的：

use Laravel\Folio\Folio;
 
Folio::domain('admin.example.com')
    ->path(resource_path('views/pages/admin'));

domain 方法还允许您将域名或子域名的部分作为参数捕获。这些参数将被注入到您的页面模板中：

use Laravel\Folio\Folio;
 
Folio::domain('{account}.example.com')
    ->path(resource_path('views/pages/admin'));

创建路由

您可以通过在任何已挂载的 Folio 目录中放置一个 Blade 模板来创建一个 Folio 路由。默认情况下，Folio 会挂载 resources/views/pages 目录，但您可以在 Folio 服务提供者的 boot 方法中自定义这些目录。

一旦将 Blade 模板放置在 Folio 挂载的目录中，您就可以立即通过浏览器访问它。例如，放置在 pages/schedule.blade.php 中的页面可以在您的浏览器中通过 http://example.com/schedule 进行访问。

要快速查看您的所有 Folio 页面/路由的列表，您可以调用 folio:list Artisan 命令：

php artisan folio:list

嵌套路由

您可以通过在 Folio 的目录中创建一个或多个子目录来创建嵌套路由。例如，要创建一个可通过 /user/profile 访问的页面，在 pages/user 目录中创建一个 profile.blade.php 模板：

php artisan folio:page user/profile
 
# pages/user/profile.blade.php → /user/profile

索引路由

有时，您可能希望将给定的页面作为目录的“索引”。通过在 Folio 目录中放置一个 index.blade.php 模板，对该目录根的任何请求都将路由到该页面：

php artisan folio:page index
# pages/index.blade.php → /
 
php artisan folio:page users/index
# pages/users/index.blade.php → /users

路由参数

通常，您需要将传入请求的 URL 的某些部分注入到您的页面中，以便您可以与之交互。例如，您可能需要访问正在显示其个人资料的用户的“ID”。要实现此目的，您可以将页面文件名的一部分括在方括号中：

php artisan folio:page "users/[id]"
 
# pages/users/[id].blade.php → /users/1

捕获的段可以在您的 Blade 模板中作为变量进行访问：

<div>
    用户 {{ $id }}
</div>

要捕获多个段，您可以在封装的段前加上三个点 ...：

php artisan folio:page "users/[...ids]"
 
# pages/users/[...ids].blade.php → /users/1/2/3

当捕获多个段时，捕获的段将作为数组注入到页面中：

<ul>
    @foreach ($ids as $id)
        <li>用户 {{ $id }}</li>
    @endforeach
</ul>

路由模型绑定

如果您的页面模板文件名的通配符段与您的应用程序的 Eloquent 模型之一相对应，Folio 将自动利用 Laravel 的路由模型绑定功能，并尝试将解析的模型实例注入到您的页面中：

php artisan folio:page "users/[User]"
 
# pages/users/[User].blade.php → /users/1

捕获的模型可以在您的 Blade 模板中作为变量进行访问。模型的变量名将转换为“驼峰式”：

<div>
    用户 {{ $user->id }}
</div>

自定义键

有时您可能希望使用除 id 之外的列来解析绑定的 Eloquent 模型。为此，您可以在页面的文件名中指定该列。例如，文件名 [Post:slug].blade.php 的页面将尝试通过 slug 列而不是 id 列来解析绑定的模型。

在 Windows 上，您应该使用 - 来分隔模型名称和键：[Post-slug].blade.php。

模型位置

默认情况下，Folio 将在您的应用程序的 app/Models 目录中搜索您的模型。但是，如果需要，您可以在模板的文件名中指定完全限定的模型类名：

php artisan folio:page "users/[.App.Models.User]"
 
# pages/users/[.App.Models.User].blade.php → /users/1

软删除的模型

默认情况下，在解析隐式模型绑定时，不会检索已软删除的模型。但是，如果您希望，可以在页面模板中调用 withTrashed 函数来指示 Folio 检索软删除的模型：

<?php
 
use function Laravel\Folio\{withTrashed};
 
withTrashed();
 
?>
 
<div>
    用户 {{ $user->id }}
</div>

渲染钩子

默认情况下，Folio 会将页面的 Blade 模板内容作为对传入请求的响应返回。但是，您可以通过在页面模板中调用 render 函数来自定义响应。

render 函数接受一个闭包，该闭包将接收 Folio 正在渲染的 View 实例，允许您向视图添加额外的数据或自定义整个响应。除了接收 View 实例外，任何其他路由参数或模型绑定也将提供给 render 闭包：

<?php
 
use App\Models\Post;
use Illuminate\Support\Facades\Auth;
use Illuminate\View\View;
 
use function Laravel\Folio\render;
 
render(function (View $view, Post $post) {
    if (! Auth::user()->can('view', $post)) {
        return response('未经授权', 403);
    }
 
    return $view->with('photos', $post->author->photos);
});?>
 
<div>
    {{ $post->content }}
</div>
 
<div>
    这位作者还拍摄了 {{ count($photos) }} 张照片。
</div>

命名路由

您可以使用 name 函数为给定页面的路由指定一个名称：

<?php
 
use function Laravel\Folio\name;
 
name('users.index');

就像 Laravel 的命名路由一样，您可以使用 route 函数生成已分配名称的 Folio 页面的 URL：

<a href="{{ route('users.index') }}">
    所有用户
</a>

如果页面有参数，您可以简单地将它们的值传递给 route 函数：

route('users.show', ['user' => $user]);

中间件

您可以通过在页面模板中调用 middleware 函数将中间件应用于特定页面：

<?php
 
use function Laravel\Folio\{middleware};
 
middleware(['auth', 'verified']);
 
?>
 
<div>
    仪表板
</div>

或者，要将中间件分配给一组页面，您可以在调用 Folio::path 方法后链接 middleware 方法。

为了指定中间件应应用于哪些页面，可以使用中间件数组，其中以相应页面的 URL 模式作为键。可以使用 * 字符作为通配符：

use Laravel\Folio\Folio;
 
Folio::path(resource_path('views/pages'))->middleware([
    'admin/*' => [
        'auth',
        'verified',
 
        //...
    ],
]);

您可以在中间件数组中包含闭包来定义内联的匿名中间件：

use Closure;
use Illuminate\Http\Request;
use Laravel\Folio\Folio;
 
Folio::path(resource_path('views/pages'))->middleware([
    'admin/*' => [
        'auth',
        'verified',
 
        function (Request $request, Closure $next) {
            //...
 
            return $next($request);
        },
    ],
]);

路由缓存

在使用 Folio 时，您应该始终利用 Laravel 的路由缓存功能。Folio 监听 route:cache Artisan 命令，以确保 Folio 页面定义和路由名称被正确缓存，以实现最佳性能。

Laravel FortifyLaravel Homestead（Laravel 家园）