Laravel Folio

简介
安装
- 页面路径 / URI
- 子域名路由
创建路由
- 嵌套路由
- 索引路由
路由参数
路由模型绑定
- 软删除模型
渲染钩子
命名路由
中间件
路由缓存

简介

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

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

1<div>
2    Hello World
3</div>

<div>
    Hello World
</div>

安装

要开始使用，请使用 Composer 包管理器将 Folio 安装到您的项目中

1composer require laravel/folio

composer require laravel/folio

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

1php artisan folio:install

php artisan folio:install

页面路径 / URI

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

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

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

 1use Laravel\Folio\Folio;
 2 
 3Folio::path(resource_path('views/pages/guest'))->uri('/');
 4 
 5Folio::path(resource_path('views/pages/admin'))
 6    ->uri('/admin')
 7    ->middleware([
 8        '*' => [
 9            'auth',
10            'verified',
11 
12            // ...
13        ],
14    ]);

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 方法来实现此目的

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

use Laravel\Folio\Folio;

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

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

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

use Laravel\Folio\Folio;

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

创建路由

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

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

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

1php artisan folio:list

php artisan folio:list

嵌套路由

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

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

php artisan folio:page user/profile

# pages/user/profile.blade.php → /user/profile

索引路由

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

1php artisan folio:page index
2# pages/index.blade.php → /
3 
4php artisan folio:page users/index
5# pages/users/index.blade.php → /users

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

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

路由参数

通常，您需要将传入请求的 URL 的段注入到您的页面中，以便您可以与之交互。例如，您可能需要访问正在显示其配置文件的用户的“ID”。要实现此目的，您可以将页面文件名的段封装在方括号中

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

php artisan folio:page "users/[id]"

# pages/users/[id].blade.php → /users/1

捕获的段可以作为 Blade 模板中的变量访问

1<div>
2    User {{ $id }}
3</div>

<div>
    User {{ $id }}
</div>

要捕获多个段，您可以使用三个点 ... 作为封装段的前缀

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

php artisan folio:page "users/[...ids]"

# pages/users/[...ids].blade.php → /users/1/2/3

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

1<ul>
2    @foreach ($ids as $id)
3        <li>User {{ $id }}</li>
4    @endforeach
5</ul>

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

路由模型绑定

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

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

php artisan folio:page "users/[User]"

# pages/users/[User].blade.php → /users/1

捕获的模型可以作为 Blade 模板中的变量访问。模型的变量名称将转换为“驼峰式命名”

1<div>
2    User {{ $user->id }}
3</div>

<div>
    User {{ $user->id }}
</div>

自定义键

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

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

模型位置

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

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

php artisan folio:page "users/[.App.Models.User]"

# pages/users/[.App.Models.User].blade.php → /users/1

软删除模型

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

 1<?php
 2 
 3use function Laravel\Folio\{withTrashed};
 4 
 5withTrashed();
 6 
 7?>
 8 
 9<div>
10    User {{ $user->id }}
11</div>

<?php

use function Laravel\Folio\{withTrashed};

withTrashed();

?>

<div>
    User {{ $user->id }}
</div>

渲染钩子

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

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

 1<?php
 2 
 3use App\Models\Post;
 4use Illuminate\Support\Facades\Auth;
 5use Illuminate\View\View;
 6 
 7use function Laravel\Folio\render;
 8 
 9render(function (View $view, Post $post) {
10    if (! Auth::user()->can('view', $post)) {
11        return response('Unauthorized', 403);
12    }
13 
14    return $view->with('photos', $post->author->photos);
15}); ?>
16 
17<div>
18    {{ $post->content }}
19</div>
20 
21<div>
22    This author has also taken {{ count($photos) }} photos.
23</div>

<?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('Unauthorized', 403);
    }

    return $view->with('photos', $post->author->photos);
}); ?>

<div>
    {{ $post->content }}
</div>

<div>
    This author has also taken {{ count($photos) }} photos.
</div>

命名路由

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

1<?php
2 
3use function Laravel\Folio\name;
4 
5name('users.index');

<?php

use function Laravel\Folio\name;

name('users.index');

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

1<a href="{{ route('users.index') }}">
2    All Users
3</a>

<a href="{{ route('users.index') }}">
    All Users
</a>

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

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

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

中间件

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

 1<?php
 2 
 3use function Laravel\Folio\{middleware};
 4 
 5middleware(['auth', 'verified']);
 6 
 7?>
 8 
 9<div>
10    Dashboard
11</div>

<?php

use function Laravel\Folio\{middleware};

middleware(['auth', 'verified']);

?>

<div>
    Dashboard
</div>

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

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

 1use Laravel\Folio\Folio;
 2 
 3Folio::path(resource_path('views/pages'))->middleware([
 4    'admin/*' => [
 5        'auth',
 6        'verified',
 7 
 8        // ...
 9    ],
10]);

use Laravel\Folio\Folio;

Folio::path(resource_path('views/pages'))->middleware([
    'admin/*' => [
        'auth',
        'verified',

        // ...
    ],
]);

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

 1use Closure;
 2use Illuminate\Http\Request;
 3use Laravel\Folio\Folio;
 4 
 5Folio::path(resource_path('views/pages'))->middleware([
 6    'admin/*' => [
 7        'auth',
 8        'verified',
 9 
10        function (Request $request, Closure $next) {
11            // ...
12 
13            return $next($request);
14        },
15    ],
16]);

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 页面定义和路由名称被正确缓存以获得最佳性能。

序言

开始入门

架构概念

基础知识

深入探讨

安全

数据库

Eloquent ORM

测试

扩展包