主题
路由
基本路由
最基本的 Laravel 路由接受一个 URI 和一个闭包,提供了一种非常简单且富有表现力的方法来定义路由和行为,而无需复杂的路由配置文件:
php
use Illuminate\Support\Facades\Route;
Route::get('/greeting', function () {
return 'Hello World';
});默认路由文件
所有 Laravel 路由都在路由文件中定义,这些文件位于 routes 目录中。Laravel 使用应用程序的 bootstrap/app.php 文件中指定的配置自动加载这些文件。routes/web.php 文件定义了用于 Web 界面的路由。这些路由被分配了 web middleware 组,该组提供会话状态和 CSRF 保护等功能。
对于大多数应用程序,你将从在 routes/web.php 文件中定义路由开始。在 routes/web.php 中定义的路由可以通过在浏览器中输入定义的路由 URL 来访问。例如,你可以通过在浏览器中导航到 http://example.com/user 来访问以下路由:
php
use App\Http\Controllers\UserController;
Route::get('/user', [UserController::class, 'index']);API 路由
如果你的应用程序还将提供无状态 API,你可以使用 install:api Artisan 命令启用 API 路由:
shell
php artisan install:apiinstall:api 命令安装 Laravel Sanctum,它提供了一个强大而简单的 API 令牌认证守卫,可用于认证第三方 API 消费者、SPA 或移动应用程序。此外,install:api 命令创建 routes/api.php 文件:
php
Route::get('/user', function (Request $request) {
return $request->user();
})->middleware('auth:sanctum');当然,你可以在应该公开访问的路由上省略 auth:sanctum middleware。
routes/api.php 中的路由是无状态的,并被分配到 api middleware 组。此外,/api URI 前缀会自动应用于这些路由,因此你无需手动将其应用于文件中的每个路由。你可以通过修改应用程序的 bootstrap/app.php 文件来更改前缀:
php
->withRouting(
api: __DIR__.'/../routes/api.php',
apiPrefix: 'api/admin',
// ...
)可用的路由方法
路由器允许你注册响应任何 HTTP 动词的路由:
php
Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);有时你可能需要注册一个响应多个 HTTP 动词的路由。你可以使用 match 方法来实现。或者,你甚至可以使用 any 方法注册一个响应所有 HTTP 动词的路由:
php
Route::match(['get', 'post'], '/', function () {
// ...
});
Route::any('/', function () {
// ...
});NOTE
当定义共享同一 URI 的多个路由时,使用 get、post、put、patch、delete 和 options 方法的路由应在使用 any、match 和 redirect 方法的路由之前定义。这确保传入的请求与正确的路由匹配。
依赖注入
你可以在路由的回调签名中类型提示路由所需的任何依赖项。声明的依赖项将由 Laravel 服务容器自动解析并注入到回调中。例如,你可以类型提示 Illuminate\Http\Request 类,让当前 HTTP 请求自动注入到你的路由回调中:
php
use Illuminate\Http\Request;
Route::get('/users', function (Request $request) {
// ...
});CSRF 保护
请记住,任何指向在 web 路由文件中定义的 POST、PUT、PATCH 或 DELETE 路由的 HTML 表单都应包含 CSRF 令牌字段。否则,请求将被拒绝。你可以在 CSRF 文档中阅读更多关于 CSRF 保护的信息:
blade
<form method="POST" action="/profile">
@csrf
...
</form>重定向路由
如果你要定义一个重定向到另一个 URI 的路由,你可以使用 Route::redirect 方法。此方法提供了一个便捷的快捷方式,这样你就不必为执行简单的重定向而定义完整的路由或控制器:
php
Route::redirect('/here', '/there');默认情况下,Route::redirect 返回 302 状态码。你可以使用可选的第三个参数自定义状态码:
php
Route::redirect('/here', '/there', 301);或者,你可以使用 Route::permanentRedirect 方法返回 301 状态码:
php
Route::permanentRedirect('/here', '/there');WARNING
在重定向路由中使用路由参数时,以下参数是 Laravel 保留的,不能使用:destination 和 status。
视图路由
如果你的路由只需要返回一个视图,你可以使用 Route::view 方法。与 redirect 方法类似,此方法提供了一个简单的快捷方式,这样你就不必定义完整的路由或控制器。view 方法接受一个 URI 作为第一个参数,视图名称作为第二个参数。此外,你可以提供一个数据数组作为可选的第三个参数传递给视图:
php
Route::view('/welcome', 'welcome');
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);WARNING
在视图路由中使用路由参数时,以下参数是 Laravel 保留的,不能使用:view、data、status 和 headers。
列出路由
route:list Artisan 命令可以轻松提供应用程序定义的所有路由的概览:
shell
php artisan route:list默认情况下,分配给每个路由的路由 middleware 不会显示在 route:list 输出中;但是,你可以通过向命令添加 -v 选项来指示 Laravel 显示路由 middleware 和 middleware 组名称:
shell
php artisan route:list -v
# 展开 middleware 组...
php artisan route:list -vv你也可以指示 Laravel 仅显示以给定 URI 开头的路由:
shell
php artisan route:list --path=api此外,你可以在执行 route:list 命令时提供 --except-vendor 选项,指示 Laravel 隐藏由第三方包定义的任何路由:
shell
php artisan route:list --except-vendor同样,你也可以在执行 route:list 命令时提供 --only-vendor 选项,指示 Laravel 仅显示由第三方包定义的路由:
shell
php artisan route:list --only-vendor路由自定义
默认情况下,你的应用程序的路由由 bootstrap/app.php 文件配置和加载:
php
<?php
use Illuminate\Foundation\Application;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)->create();但是,有时你可能希望定义一个全新的文件来包含应用程序路由的子集。为此,你可以向 withRouting 方法提供一个 then 闭包。在此闭包中,你可以注册应用程序所需的任何额外路由:
php
use Illuminate\Support\Facades\Route;
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
then: function () {
Route::middleware('api')
->prefix('webhooks')
->name('webhooks.')
->group(base_path('routes/webhooks.php'));
},
)或者,你甚至可以通过向 withRouting 方法提供 using 闭包来完全控制路由注册。当传递此参数时,框架不会注册任何 HTTP 路由,你负责手动注册所有路由:
php
use Illuminate\Support\Facades\Route;
->withRouting(
commands: __DIR__.'/../routes/console.php',
using: function () {
Route::middleware('api')
->prefix('api')
->group(base_path('routes/api.php'));
Route::middleware('web')
->group(base_path('routes/web.php'));
},
)路由参数
必选参数
有时你需要在路由中捕获 URI 的片段。例如,你可能需要从 URL 中捕获用户的 ID。你可以通过定义路由参数来实现:
php
Route::get('/user/{id}', function (string $id) {
return 'User '.$id;
});你可以根据路由的需要定义任意数量的路由参数:
php
Route::get('/posts/{post}/comments/{comment}', function (string $postId, string $commentId) {
// ...
});路由参数始终包裹在 {} 大括号中,并且应由字母字符组成。下划线(_)在路由参数名称中也是可以接受的。路由参数根据它们的顺序注入到路由回调/控制器中——路由回调/控制器参数的名称无关紧要。
参数与依赖注入
如果你的路由有你希望 Laravel 服务容器自动注入到路由回调中的依赖项,你应该在依赖项之后列出路由参数:
php
use Illuminate\Http\Request;
Route::get('/user/{id}', function (Request $request, string $id) {
return 'User '.$id;
});可选参数
有时你可能需要指定一个不一定总是出现在 URI 中的路由参数。你可以通过在参数名称后放置 ? 标记来实现。确保为路由的相应变量提供默认值:
php
Route::get('/user/{name?}', function (?string $name = null) {
return $name;
});
Route::get('/user/{name?}', function (?string $name = 'John') {
return $name;
});正则表达式约束
你可以使用路由实例上的 where 方法来约束路由参数的格式。where 方法接受参数名称和定义参数应如何约束的正则表达式:
php
Route::get('/user/{name}', function (string $name) {
// ...
})->where('name', '[A-Za-z]+');
Route::get('/user/{id}', function (string $id) {
// ...
})->where('id', '[0-9]+');
Route::get('/user/{id}/{name}', function (string $id, string $name) {
// ...
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);为了方便起见,一些常用的正则表达式模式有辅助方法,允许你快速为路由添加模式约束:
php
Route::get('/user/{id}/{name}', function (string $id, string $name) {
// ...
})->whereNumber('id')->whereAlpha('name');
Route::get('/user/{name}', function (string $name) {
// ...
})->whereAlphaNumeric('name');
Route::get('/user/{id}', function (string $id) {
// ...
})->whereUuid('id');
Route::get('/user/{id}', function (string $id) {
// ...
})->whereUlid('id');
Route::get('/category/{category}', function (string $category) {
// ...
})->whereIn('category', ['movie', 'song', 'painting']);
Route::get('/category/{category}', function (string $category) {
// ...
})->whereIn('category', CategoryEnum::cases());如果传入的请求与路由模式约束不匹配,将返回 404 HTTP 响应。
全局约束
如果你希望路由参数始终受给定正则表达式的约束,可以使用 pattern 方法。你应该在应用程序的 App\Providers\AppServiceProvider 类的 boot 方法中定义这些模式:
php
use Illuminate\Support\Facades\Route;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
Route::pattern('id', '[0-9]+');
}一旦定义了模式,它会自动应用于使用该参数名称的所有路由:
php
Route::get('/user/{id}', function (string $id) {
// 仅在 {id} 为数字时执行...
});编码的正斜杠
Laravel 路由组件允许除 / 之外的所有字符出现在路由参数值中。你必须使用 where 条件正则表达式明确允许 / 成为占位符的一部分:
php
Route::get('/search/{search}', function (string $search) {
return $search;
})->where('search', '.*');WARNING
编码的正斜杠仅在最后一个路由段中受支持。
命名路由
命名路由允许方便地为特定路由生成 URL 或重定向。你可以通过将 name 方法链接到路由定义上来为路由指定名称:
php
Route::get('/user/profile', function () {
// ...
})->name('profile');你也可以为控制器操作指定路由名称:
php
Route::get(
'/user/profile',
[UserProfileController::class, 'show']
)->name('profile');WARNING
路由名称应始终是唯一的。
生成命名路由的 URL
一旦你为给定路由分配了名称,你可以在通过 Laravel 的 route 和 redirect 辅助函数生成 URL 或重定向时使用路由的名称:
php
// 生成 URL...
$url = route('profile');
// 生成重定向...
return redirect()->route('profile');
return to_route('profile');如果命名路由定义了参数,你可以将参数作为第二个参数传递给 route 函数。给定的参数将自动插入到生成的 URL 中的正确位置:
php
Route::get('/user/{id}/profile', function (string $id) {
// ...
})->name('profile');
$url = route('profile', ['id' => 1]);如果你在数组中传递了额外的参数,这些键/值对将自动添加到生成的 URL 的查询字符串中:
php
Route::get('/user/{id}/profile', function (string $id) {
// ...
})->name('profile');
$url = route('profile', ['id' => 1, 'photos' => 'yes']);
// http://example.com/user/1/profile?photos=yesNOTE
有时,你可能希望为 URL 参数指定请求范围的默认值,例如当前语言环境。为此,你可以使用 URL::defaults 方法。
检查当前路由
如果你想确定当前请求是否路由到给定的命名路由,你可以在 Route 实例上使用 named 方法。例如,你可以从路由 middleware 中检查当前路由名称:
php
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* 处理传入的请求。
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
*/
public function handle(Request $request, Closure $next): Response
{
if ($request->route()->named('profile')) {
// ...
}
return $next($request);
}路由组
路由组允许你在大量路由之间共享路由属性(如 middleware),而无需在每个单独的路由上定义这些属性。
嵌套组会尝试智能地将属性与其父组「合并」。Middleware 和 where 条件会被合并,而名称和前缀会被追加。URI 前缀中的命名空间分隔符和斜杠会在适当的地方自动添加。
Middleware
要将 middleware 分配给组内的所有路由,你可以在定义组之前使用 middleware 方法。Middleware 按照它们在数组中列出的顺序执行:
php
Route::middleware(['first', 'second'])->group(function () {
Route::get('/', function () {
// 使用 first 和 second middleware...
});
Route::get('/user/profile', function () {
// 使用 first 和 second middleware...
});
});控制器
如果一组路由都使用相同的控制器,你可以使用 controller 方法为组内的所有路由定义公共控制器。然后,在定义路由时,你只需提供它们调用的控制器方法:
php
use App\Http\Controllers\OrderController;
Route::controller(OrderController::class)->group(function () {
Route::get('/orders/{id}', 'show');
Route::post('/orders', 'store');
});子域路由
路由组也可以用于处理子域路由。子域可以像路由 URI 一样被分配路由参数,允许你捕获子域的一部分以在路由或控制器中使用。可以在定义组之前通过调用 domain 方法来指定子域:
php
Route::domain('{account}.example.com')->group(function () {
Route::get('/user/{id}', function (string $account, string $id) {
// ...
});
});路由前缀
prefix 方法可以用给定的 URI 为组内的每个路由添加前缀。例如,你可能希望将组内所有路由 URI 的前缀设置为 admin:
php
Route::prefix('admin')->group(function () {
Route::get('/users', function () {
// 匹配 "/admin/users" URL
});
});路由名称前缀
name 方法可以用给定的字符串为组内的每个路由名称添加前缀。例如,你可能希望为组内所有路由的名称添加 admin 前缀。给定的字符串将完全按照指定的方式添加到路由名称前缀中,因此我们将确保在前缀中提供尾部的 . 字符:
php
Route::name('admin.')->group(function () {
Route::get('/users', function () {
// 路由被分配名称 "admin.users"...
})->name('users');
});路由模型绑定
当向路由或控制器操作注入模型 ID 时,你通常会查询数据库以检索与该 ID 对应的模型。Laravel 路由模型绑定提供了一种便捷的方式,可以自动将模型实例直接注入到你的路由中。例如,你可以注入与给定 ID 匹配的整个 User 模型实例,而不是注入用户的 ID。
隐式绑定
Laravel 自动解析在路由或控制器操作中定义的 Eloquent 模型,其类型提示的变量名称与路由段名称匹配。例如:
php
use App\Models\User;
Route::get('/users/{user}', function (User $user) {
return $user->email;
});由于 $user 变量被类型提示为 App\Models\User Eloquent 模型,并且变量名称与 {user} URI 段匹配,Laravel 将自动注入具有与请求 URI 中相应值匹配的 ID 的模型实例。如果在数据库中找不到匹配的模型实例,将自动生成 404 HTTP 响应。
当然,使用控制器方法时也可以使用隐式绑定。同样,请注意 {user} URI 段与控制器中包含 App\Models\User 类型提示的 $user 变量匹配:
php
use App\Http\Controllers\UserController;
use App\Models\User;
// 路由定义...
Route::get('/users/{user}', [UserController::class, 'show']);
// 控制器方法定义...
public function show(User $user)
{
return view('user.profile', ['user' => $user]);
}软删除模型
通常,隐式模型绑定不会检索已被软删除的模型。但是,你可以通过将 withTrashed 方法链接到路由定义上来指示隐式绑定检索这些模型:
php
use App\Models\User;
Route::get('/users/{user}', function (User $user) {
return $user->email;
})->withTrashed();自定义键
有时你可能希望使用 id 以外的列来解析 Eloquent 模型。为此,你可以在路由参数定义中指定列:
php
use App\Models\Post;
Route::get('/posts/{post:slug}', function (Post $post) {
return $post;
});如果你希望模型绑定在检索给定模型类时始终使用 id 以外的数据库列,可以在 Eloquent 模型上重写 getRouteKeyName 方法:
php
/**
* 获取模型的路由键。
*/
public function getRouteKeyName(): string
{
return 'slug';
}自定义键和作用域
当在单个路由定义中隐式绑定多个 Eloquent 模型时,你可能希望对第二个 Eloquent 模型进行作用域限定,使其必须是前一个 Eloquent 模型的子级。例如,考虑以下路由定义,它通过 slug 为特定用户检索博客文章:
php
use App\Models\Post;
use App\Models\User;
Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
return $post;
});当使用自定义键的隐式绑定作为嵌套路由参数时,Laravel 将自动限定查询范围,使用约定猜测父级上的关系名称,通过其父级检索嵌套模型。在这种情况下,将假定 User 模型有一个名为 posts(路由参数名称的复数形式)的关系,可用于检索 Post 模型。
如果你愿意,即使没有提供自定义键,你也可以指示 Laravel 对「子」绑定进行作用域限定。为此,你可以在定义路由时调用 scopeBindings 方法:
php
use App\Models\Post;
use App\Models\User;
Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
return $post;
})->scopeBindings();或者,你可以指示整组路由定义使用作用域绑定:
php
Route::scopeBindings()->group(function () {
Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
return $post;
});
});同样,你可以通过调用 withoutScopedBindings 方法明确指示 Laravel 不进行作用域绑定:
php
Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
return $post;
})->withoutScopedBindings();自定义缺失模型行为
通常,如果找不到隐式绑定的模型,将生成 404 HTTP 响应。但是,你可以通过在定义路由时调用 missing 方法来自定义此行为。missing 方法接受一个闭包,当找不到隐式绑定的模型时将调用该闭包:
php
use App\Http\Controllers\LocationsController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;
Route::get('/locations/{location:slug}', [LocationsController::class, 'show'])
->name('locations.view')
->missing(function (Request $request) {
return Redirect::route('locations.index');
});隐式枚举绑定
PHP 8.1 引入了对 Enum 的支持。为了补充此功能,Laravel 允许你在路由定义中类型提示字符串支持的 Enum,Laravel 只会在路由段对应有效的 Enum 值时调用该路由。否则,将自动返回 404 HTTP 响应。例如,给定以下 Enum:
php
<?php
namespace App\Enums;
enum Category: string
{
case Fruits = 'fruits';
case People = 'people';
}你可以定义一个仅在 {category} 路由段为 fruits 或 people 时才会被调用的路由。否则,Laravel 将返回 404 HTTP 响应:
php
use App\Enums\Category;
use Illuminate\Support\Facades\Route;
Route::get('/categories/{category}', function (Category $category) {
return $category->value;
});显式绑定
你不必使用 Laravel 基于约定的隐式模型解析来使用模型绑定。你也可以显式定义路由参数如何对应模型。要注册显式绑定,请使用路由器的 model 方法为给定参数指定类。你应该在 AppServiceProvider 类的 boot 方法的开头定义显式模型绑定:
php
use App\Models\User;
use Illuminate\Support\Facades\Route;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
Route::model('user', User::class);
}接下来,定义一个包含 {user} 参数的路由:
php
use App\Models\User;
Route::get('/users/{user}', function (User $user) {
// ...
});由于我们已将所有 {user} 参数绑定到 App\Models\User 模型,该类的实例将被注入到路由中。例如,对 users/1 的请求将注入数据库中 ID 为 1 的 User 实例。
如果在数据库中找不到匹配的模型实例,将自动生成 404 HTTP 响应。
自定义解析逻辑
如果你希望定义自己的模型绑定解析逻辑,可以使用 Route::bind 方法。你传递给 bind 方法的闭包将接收 URI 段的值,并应返回应注入到路由中的类的实例。同样,此自定义应在应用程序的 AppServiceProvider 的 boot 方法中进行:
php
use App\Models\User;
use Illuminate\Support\Facades\Route;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
Route::bind('user', function (string $value) {
return User::where('name', $value)->firstOrFail();
});
}或者,你可以在 Eloquent 模型上重写 resolveRouteBinding 方法。此方法将接收 URI 段的值,并应返回应注入到路由中的类的实例:
php
/**
* 检索绑定值的模型。
*
* @param mixed $value
* @param string|null $field
* @return \Illuminate\Database\Eloquent\Model|null
*/
public function resolveRouteBinding($value, $field = null)
{
return $this->where('name', $value)->firstOrFail();
}如果路由使用了隐式绑定作用域,resolveChildRouteBinding 方法将用于解析父模型的子绑定:
php
/**
* 检索绑定值的子模型。
*
* @param string $childType
* @param mixed $value
* @param string|null $field
* @return \Illuminate\Database\Eloquent\Model|null
*/
public function resolveChildRouteBinding($childType, $value, $field)
{
return parent::resolveChildRouteBinding($childType, $value, $field);
}回退路由
使用 Route::fallback 方法,你可以定义一个当没有其他路由与传入请求匹配时将执行的路由。通常,未处理的请求会通过应用程序的异常处理器自动渲染一个「404」页面。但是,由于你通常会在 routes/web.php 文件中定义 fallback 路由,web middleware 组中的所有 middleware 都将应用于该路由。你可以根据需要向此路由添加额外的 middleware:
php
Route::fallback(function () {
// ...
});速率限制
定义速率限制器
Laravel 包含强大且可自定义的速率限制服务,你可以利用它来限制给定路由或路由组的流量。要开始使用,你应该定义满足应用程序需求的速率限制器配置。
速率限制器可以在应用程序的 App\Providers\AppServiceProvider 类的 boot 方法中定义:
php
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
RateLimiter::for('api', function (Request $request) {
return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
});
}速率限制器使用 RateLimiter facade 的 for 方法定义。for 方法接受一个速率限制器名称和一个闭包,该闭包返回应用于分配给速率限制器的路由的限制配置。限制配置是 Illuminate\Cache\RateLimiting\Limit 类的实例。此类包含有用的「构建器」方法,以便你可以快速定义限制。速率限制器名称可以是你想要的任何字符串:
php
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
RateLimiter::for('global', function (Request $request) {
return Limit::perMinute(1000);
});
}如果传入的请求超过指定的速率限制,Laravel 将自动返回带有 429 HTTP 状态码的响应。如果你想定义速率限制应返回的自己的响应,可以使用 response 方法:
php
RateLimiter::for('global', function (Request $request) {
return Limit::perMinute(1000)->response(function (Request $request, array $headers) {
return response('Custom response...', 429, $headers);
});
});由于速率限制器回调接收传入的 HTTP 请求实例,你可以根据传入的请求或已认证的用户动态构建适当的速率限制:
php
RateLimiter::for('uploads', function (Request $request) {
return $request->user()?->vipCustomer()
? Limit::none()
: Limit::perHour(10);
});分段速率限制
有时你可能希望按某个任意值对速率限制进行分段。例如,你可能希望允许用户每个 IP 地址每分钟访问给定路由 100 次。为此,你可以在构建速率限制时使用 by 方法:
php
RateLimiter::for('uploads', function (Request $request) {
return $request->user()->vipCustomer()
? Limit::none()
: Limit::perMinute(100)->by($request->ip());
});为了用另一个示例来说明此功能,我们可以将已认证用户 ID 的路由访问限制为每分钟 100 次,或者将访客的 IP 地址限制为每分钟 10 次:
php
RateLimiter::for('uploads', function (Request $request) {
return $request->user()
? Limit::perMinute(100)->by($request->user()->id)
: Limit::perMinute(10)->by($request->ip());
});多重速率限制
如果需要,你可以为给定的速率限制器配置返回一个速率限制数组。每个速率限制将根据它们在数组中的放置顺序对路由进行评估:
php
RateLimiter::for('login', function (Request $request) {
return [
Limit::perMinute(500),
Limit::perMinute(3)->by($request->input('email')),
];
});如果你分配了按相同 by 值分段的多个速率限制,你应该确保每个 by 值是唯一的。实现这一点的最简单方法是为传递给 by 方法的值添加前缀:
php
RateLimiter::for('uploads', function (Request $request) {
return [
Limit::perMinute(10)->by('minute:'.$request->user()->id),
Limit::perDay(1000)->by('day:'.$request->user()->id),
];
});基于响应的速率限制
除了对传入请求进行速率限制外,Laravel 还允许你使用 after 方法基于响应进行速率限制。当你只想将某些响应计入速率限制时(例如验证错误、404 响应或其他特定的 HTTP 状态码),这非常有用。
after 方法接受一个闭包,该闭包接收响应,如果响应应计入速率限制则返回 true,如果应忽略则返回 false。这对于通过限制连续的 404 响应来防止枚举攻击,或允许用户重试验证失败的请求而不耗尽其在应该只限制成功操作的端点上的速率限制特别有用:
php
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
use Symfony\Component\HttpFoundation\Response;
RateLimiter::for('resource-not-found', function (Request $request) {
return Limit::perMinute(10)
->by($request->user()?->id ?: $request->ip())
->after(function (Response $response) {
// 仅将 404 响应计入速率限制以防止枚举...
return $response->status() === 404;
});
});将速率限制器附加到路由
速率限制器可以使用 throttle middleware 附加到路由或路由组。throttle middleware 接受你希望分配给路由的速率限制器的名称:
php
Route::middleware(['throttle:uploads'])->group(function () {
Route::post('/audio', function () {
// ...
});
Route::post('/video', function () {
// ...
});
});使用 Redis 进行限流
默认情况下,throttle middleware 映射到 Illuminate\Routing\Middleware\ThrottleRequests 类。但是,如果你使用 Redis 作为应用程序的缓存驱动,你可能希望指示 Laravel 使用 Redis 来管理速率限制。为此,你应该在应用程序的 bootstrap/app.php 文件中使用 throttleWithRedis 方法。此方法将 throttle middleware 映射到 Illuminate\Routing\Middleware\ThrottleRequestsWithRedis middleware 类:
php
->withMiddleware(function (Middleware $middleware): void {
$middleware->throttleWithRedis();
// ...
})表单方法伪造
HTML 表单不支持 PUT、PATCH 或 DELETE 操作。因此,当定义从 HTML 表单调用的 PUT、PATCH 或 DELETE 路由时,你需要向表单添加一个隐藏的 _method 字段。随 _method 字段发送的值将用作 HTTP 请求方法:
blade
<form action="/example" method="POST">
<input type="hidden" name="_method" value="PUT">
<input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>为方便起见,你可以使用 @method Blade 指令生成 _method 输入字段:
blade
<form action="/example" method="POST">
@method('PUT')
@csrf
</form>访问当前路由
你可以使用 Route facade 上的 current、currentRouteName 和 currentRouteAction 方法来访问有关处理传入请求的路由的信息:
php
use Illuminate\Support\Facades\Route;
$route = Route::current(); // Illuminate\Routing\Route
$name = Route::currentRouteName(); // string
$action = Route::currentRouteAction(); // string你可以参考 Route facade 底层类和 Route 实例的 API 文档,以查看路由器和路由类上可用的所有方法。
跨域资源共享(CORS)
Laravel 可以使用你配置的值自动响应 CORS OPTIONS HTTP 请求。OPTIONS 请求将由自动包含在应用程序全局 middleware 栈中的 HandleCors middleware 自动处理。
有时,你可能需要为应用程序自定义 CORS 配置值。你可以使用 config:publish Artisan 命令发布 cors 配置文件来实现:
shell
php artisan config:publish cors此命令将在应用程序的 config 目录中放置一个 cors.php 配置文件。
NOTE
有关 CORS 和 CORS 头的更多信息,请查阅 MDN 关于 CORS 的 Web 文档。
路由缓存
在将应用程序部署到生产环境时,你应该利用 Laravel 的路由缓存。使用路由缓存将大大减少注册所有应用程序路由所需的时间。要生成路由缓存,请执行 route:cache Artisan 命令:
shell
php artisan route:cache运行此命令后,你的缓存路由文件将在每个请求中加载。请记住,如果你添加了任何新路由,你将需要生成新的路由缓存。因此,你应该只在项目部署期间运行 route:cache 命令。
你可以使用 route:clear 命令清除路由缓存:
shell
php artisan route:clear