展開文件目錄

路由

基礎路由

最基本的 Laravel 路由接受一個 URI 和一個閉包,提供了一種非常簡單且具有表現力的方法來定義路由和行為,而無需複雜的路由設定檔:

use Illuminate\Support\Facades\Route;

Route::get('/greeting', function () {
    return 'Hello World';
});

預設路由檔案

所有的 Laravel 路由都定義在 routes 目錄下的路由檔案中。這些檔案由 Laravel 根據應用程式 bootstrap/app.php 檔案中指定的設定自動載入。routes/web.php 檔案定義了用於 Web 介面的路由。這些路由被分配了 web 中介層群組,它提供了 Session 狀態和 CSRF 保護等功能。

對於大多數應用程式,你將從在 routes/web.php 檔案中定義路由開始。在 routes/web.php 中定義的路由可以透過在瀏覽器中輸入定義的路由 URL 來存取。例如,你可以透過在瀏覽器中導航到 http://example.com/user 來存取以下路由:

use App\Http\Controllers\UserController;

Route::get('/user', [UserController::class, 'index']);

API 路由

如果你的應用程式也提供無狀態的 API,你可以使用 install:api Artisan 指令啟用 API 路由:

php artisan install:api

install:api 指令會安裝 Laravel Sanctum,它提供了一個強大且簡單的 API 令牌身分驗證 Guard,可用於驗證第三方 API 消費者、SPA 或行動應用程式。此外,install:api 指令會建立 routes/api.php 檔案:

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

當然,對於應該公開存取的路由,你可以自由地省略 auth:sanctum 中介層。

routes/api.php 中的路由是無狀態的,並被分配到 api 中介層群組。此外,/api URI 前綴會自動應用於這些路由,因此你不需要手動將其應用於檔案中的每個路由。你可以透過修改應用程式的 bootstrap/app.php 檔案來更改前綴:

->withRouting(
    api: __DIR__.'/../routes/api.php',
    apiPrefix: 'api/admin',
    // ...
)

可用的路由器方法

路由器允許你註冊回應任何 HTTP 動詞的路由:

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 動詞的路由:

Route::match(['get', 'post'], '/', function () {
    // ...
});

Route::any('/', function () {
    // ...
});

[!NOTE] 當定義多個共享相同 URI 的路由時,使用 getpostputpatchdeleteoptions 方法的路由應該定義在由 anymatchredirect 方法定義的路由之前。這可以確保傳入的請求與正確的路由匹配。

依賴注入

你可以在路由的閉包簽章中對路由所需的任何依賴項進行型別提示。宣告的依賴項將由 Laravel 服務容器自動解析並注入到閉包中。例如,你可以對 Illuminate\Http\Request 類別進行型別提示,以便將當前的 HTTP 請求自動注入到你的路由閉包中:

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    // ...
});

CSRF 保護

請記住,指向 web 路由檔案中定義的 POSTPUTPATCHDELETE 路由的任何 HTML 表單都應包含 CSRF 令牌欄位。否則,請求將被拒絕。你可以在 CSRF 文件中閱讀有關 CSRF 保護的更多資訊:

<form method="POST" action="/profile">
    @source/csrf.md
    ...
</form>

重導向路由

如果你正在定義一個重導向到另一個 URI 的路由,你可以使用 Route::redirect 方法。此方法提供了一個方便的捷徑,因此你不需要為執行簡單的重導向而定義完整的路由或控制器:

Route::redirect('/here', '/there');

預設情況下,Route::redirect 回傳 302 狀態碼。你可以使用選用的第三個參數來自定義狀態碼:

Route::redirect('/here', '/there', 301);

或者,你可以使用 Route::permanentRedirect 方法來回傳 301 狀態碼:

Route::permanentRedirect('/here', '/there');

[!WARNING] 在重導向路由中使用路由參數時,以下參數由 Laravel 保留且不能使用:destinationstatus

視圖路由

如果你的路由只需要回傳一個 視圖,你可以使用 Route::view 方法。與 redirect 方法一樣,此方法提供了一個簡單的捷徑,因此你不需要定義完整的路由或控制器。view 方法接受一個 URI 作為其第一個參數,並接受一個視圖名稱作為其第二個參數。此外,你可以提供一個資料陣列作為選用的第三個參數傳遞給視圖:

Route::view('/welcome', 'welcome');

Route::view('/welcome', 'welcome', ['name' => 'Taylor']);

[!WARNING] 在視圖路由中使用路由參數時,以下參數由 Laravel 保留且不能使用:viewdatastatusheaders

列出你的路由

route:list Artisan 指令可以輕鬆地提供應用程式定義的所有路由概覽:

php artisan route:list

預設情況下,分配給每個路由的路由中介層不會顯示在 route:list 輸出中;但是,你可以透過在指令中加入 -v 選項來指示 Laravel 顯示路由中介層和中介層群組名稱:

php artisan route:list -v

# 展開中介層群組...
php artisan route:list -vv

你也可以指示 Laravel 僅顯示以給定 URI 開頭的路由:

php artisan route:list --path=api

此外,你可以透過在執行 route:list 指令時提供 --except-vendor 選項,指示 Laravel 隱藏由第三方套件定義的任何路由:

php artisan route:list --except-vendor

同樣地,你也可以透過在執行 route:list 指令時提供 --only-vendor 選項,指示 Laravel 僅顯示由第三方套件定義的路由:

php artisan route:list --only-vendor

路由自定義

預設情況下,應用程式的路由由 bootstrap/app.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 閉包。在此閉包中,你可以註冊應用程式所需的任何額外路由:

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 路由,你必須負責手動註冊所有路由:

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。你可以透過定義路由參數來做到這一點:

Route::get('/user/{id}', function (string $id) {
    return 'User '.$id;
});

你可以根據路由需要定義任意數量的路由參數:

Route::get('/posts/{post}/comments/{comment}', function (string $postId, string $commentId) {
    // ...
});

路由參數始終包裹在 {} 大括號內,並且應由字母字元組成。下底線 (_) 在路由參數名稱中也是可以接受的。路由參數根據其順序注入到路由閉包 / 控制器中 - 路由閉包 / 控制器引數的名稱並不重要。

參數與依賴注入

如果你的路由有希望 Laravel 服務容器自動注入到路由閉包中的依賴項,你應該在依賴項之後列出你的路由參數:

use Illuminate\Http\Request;

Route::get('/user/{id}', function (Request $request, string $id) {
    return 'User '.$id;
});

可選參數

有時你可能需要指定一個不一定會出現在 URI 中的路由參數。你可以透過在參數名稱後放置一個 ? 標記來做到這一點。確保為路由對應的變數提供一個預設值:

Route::get('/user/{name?}', function (?string $name = null) {
    return $name;
});

Route::get('/user/{name?}', function (?string $name = 'John') {
    return $name;
});

正規表示式限制

你可以使用路由實例上的 where 方法來限制路由參數的格式。where 方法接受參數名稱和定義如何限制參數的正規表示式:

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

為了方便起見,一些常用的正規表示式模式具有輔助方法,可以讓你快速向路由添加模式限制:

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 方法中定義這些模式:

use Illuminate\Support\Facades\Route;

/**
 * 啟動任何應用程式服務。
 */
public function boot(): void
{
    Route::pattern('id', '[0-9]+');
}

一旦定義了模式,它就會自動應用於使用該參數名稱的所有路由:

Route::get('/user/{id}', function (string $id) {
    // 僅在 {id} 為數字時執行...
});

編碼後的斜線

Laravel 路由元件允許除了 / 之外的所有字元出現在路由參數值中。你必須使用 where 條件正規表示式明確允許 / 成為佔位符的一部分:

Route::get('/search/{search}', function (string $search) {
    return $search;
})->where('search', '.*');

[!WARNING] 編碼後的斜線僅在最後一個路由片段中受支援。

具名路由

具名路由允許為特定路由方便地產生 URL 或重導向。你可以透過在路由定義上鏈接 name 方法來為路由指定名稱:

Route::get('/user/profile', function () {
    // ...
})->name('profile');

你也可以為控制器動作指定路由名稱:

Route::get(
    '/user/profile',
    [UserProfileController::class, 'show']
)->name('profile');

[!WARNING] 路由名稱應始終是唯一的。

產生具名路由的 URL

一旦你為特定路由分配了名稱,你就可以在透過 Laravel 的 routeredirect 輔助函數產生 URL 或重導向時使用該路由名稱:

// 產生 URL...
$url = route('profile');

// 產生重導向...
return redirect()->route('profile');

return to_route('profile');

如果具名路由定義了參數,你可以將參數作為第二個引數傳遞給 route 函數。給定的參數將自動插入到產生的 URL 中的正確位置:

Route::get('/user/{id}/profile', function (string $id) {
    // ...
})->name('profile');

$url = route('profile', ['id' => 1]);

如果你在陣列中傳遞額外的參數,這些鍵值對將自動添加到產生的 URL 的查詢字串中:

Route::get('/user/{id}/profile', function (string $id) {
    // ...
})->name('profile');

$url = route('profile', ['id' => 1, 'photos' => 'yes']);

// http://example.com/user/1/profile?photos=yes

[!NOTE] 有時,你可能希望為 URL 參數指定請求範圍內的預設值,例如當前語系。為了實現這一點,你可以使用 URL::defaults 方法

檢查當前路由

如果你想確定當前請求是否已路由到給定的具名路由,你可以在路由實例上使用 named 方法。例如,你可以從路由中介層檢查當前路由名稱:

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);
}

路由群組

路由群組允許你跨大量路由共享路由屬性(如中介層),而無需在每個單獨的路由上定義這些屬性。

巢狀群組會嘗試智慧地與其父群組「合併」屬性。中介層和 where 條件會被合併,而名稱和前綴會被追加。在 URI 前綴中,命名空間分隔符號和斜線會在適當的地方自動添加。

中介層

要將 中介層 分配給群組內的所有路由,你可以在定義群組之前使用 middleware 方法。中介層按照它們在陣列中列出的順序執行:

Route::middleware(['first', 'second'])->group(function () {
    Route::get('/', function () {
        // 使用 first 和 second 中介層...
    });

    Route::get('/user/profile', function () {
        // 使用 first 和 second 中介層...
    });
});

控制器

如果一組路由都使用相同的 控制器,你可以使用 controller 方法為群組內的所有路由定義共同的控制器。然後,在定義路由時,你只需要提供它們呼叫的控制器方法:

use App\Http\Controllers\OrderController;

Route::controller(OrderController::class)->group(function () {
    Route::get('/orders/{id}', 'show');
    Route::post('/orders', 'store');
});

子網域路由

路由群組也可用於處理子網域路由。子網域可以像路由 URI 一樣分配路由參數,允許你擷取子網域的一部分用於路由或控制器。子網域可以透過在定義群組之前呼叫 domain 方法來指定:

Route::domain('{account}.example.com')->group(function () {
    Route::get('/user/{id}', function (string $account, string $id) {
        // ...
    });
});

路由前綴

prefix 方法可用於為群組中的每個路由加上給定的 URI 前綴。例如,你可能希望為群組內的所有路由 URI 加上 admin 前綴:

Route::prefix('admin')->group(function () {
    Route::get('/users', function () {
        // 匹配 "/admin/users" URL
    });
});

路由名稱前綴

name 方法可用於為群組中的每個路由名稱加上給定的字串前綴。例如,你可能希望為群組中所有路由的名稱加上 admin 前綴。給定的字串會完全按照指定的方式加到路由名稱的前面,因此我們要在前綴中提供結尾的 . 字元:

Route::name('admin.')->group(function () {
    Route::get('/users', function () {
        // 路由被分配的名稱為 "admin.users"...
    })->name('users');
});

路由模型繫結

當將模型 ID 注入到路由或控制器動作時,你通常會查詢資料庫以擷取與該 ID 對應的模型。Laravel 路由模型繫結提供了一種方便的方法,可以將模型實例直接自動注入到你的路由中。例如,你可以注入與給定 ID 匹配的整個 User 模型實例,而不是注入使用者的 ID。

隱式繫結

Laravel 會自動解析在路由或控制器動作中定義的 Eloquent 模型,其型別提示的變數名稱與路由片段名稱匹配。例如:

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return $user->email;
});

由於 $user 變數被型別提示為 App\Models\User Eloquent 模型,且變數名稱與 {user} URI 片段匹配,Laravel 將自動注入 ID 與請求 URI 對應值匹配的模型實例。如果在資料庫中找不到匹配的模型實例,將自動產生 404 HTTP 回應。

當然,使用控制器方法時也可以進行隱式繫結。同樣,請注意 {user} URI 片段與控制器中包含 App\Models\User 型別提示的 $user 變數匹配:

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 方法,指示隱式繫結擷取這些模型:

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return $user->email;
})->withTrashed();

自定義鍵名

有時你可能希望使用 id 以外的欄位來解析 Eloquent 模型。為此,你可以在路由參數定義中指定該欄位:

use App\Models\Post;

Route::get('/posts/{post:slug}', function (Post $post) {
    return $post;
});

如果你希望模型繫結在擷取給定模型類別時始終使用 id 以外的資料庫欄位,你可以覆寫 Eloquent 模型上的 getRouteKeyName 方法:

/**
 * 取得模型的路由鍵。
 */
public function getRouteKeyName(): string
{
    return 'slug';
}

自定義鍵與範圍限制 (Scoping)

當在單個路由定義中隱式繫結多個 Eloquent 模型時,你可能希望限定第二個 Eloquent 模型,使其必須是前一個 Eloquent 模型的子模型。例如,考慮這個為特定使用者透過 Slug 擷取部落格文章的路由定義:

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 方法:

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
    return $post;
})->scopeBindings();

或者,你可以指示整個路由定義群組使用限定繫結:

Route::scopeBindings()->group(function () {
    Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
        return $post;
    });
});

同樣地,你可以透過呼叫 withoutScopedBindings 方法,明確指示 Laravel 不要限定繫結:

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
})->withoutScopedBindings();

自定義遺漏模型行為

通常,如果找不到隱式繫結的模型,將產生 404 HTTP 回應。但是,你可以透過在定義路由時呼叫 missing 方法來自定義此行為。missing 方法接受一個閉包,如果找不到隱式繫結的模型,該閉包將被呼叫:

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');
    });

隱式 Enum 繫結

PHP 8.1 引入了對 Enum 的支援。為了補充此功能,Laravel 允許你在路由定義中對 字串型別的 Enum 進行型別提示,且 Laravel 僅在該路由片段對應於有效的 Enum 值時才會呼叫該路由。否則,將自動回傳 404 HTTP 回應。例如,給定以下 Enum:

<?php

namespace App\Enums;

enum Category: string
{
    case Fruits = 'fruits';
    case People = 'people';
}

你可以定義一個路由,該路由僅在 {category} 路由片段為 fruitspeople 時才被呼叫。否則,Laravel 將回傳 404 HTTP 回應:

use App\Enums\Category;
use Illuminate\Support\Facades\Route;

Route::get('/categories/{category}', function (Category $category) {
    return $category->value;
});

顯式繫結

你不需要使用 Laravel 的隱式、基於約定的模型解析即可使用模型繫結。你也可以明確定義路由參數如何對應到模型。要註冊顯式繫結,請使用路由器的 model 方法為給定參數指定類別。你應該在 AppServiceProvider 類別的 boot 方法開頭定義你的顯式模型繫結:

use App\Models\User;
use Illuminate\Support\Facades\Route;

/**
 * 啟動任何應用程式服務。
 */
public function boot(): void
{
    Route::model('user', User::class);
}

接下來,定義一個包含 {user} 參數的路由:

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    // ...
});

由於我們已將所有 {user} 參數繫結到 App\Models\User 模型,因此該類別的實例將注入到路由中。因此,例如,對 users/1 的請求將注入資料庫中 ID 為 1User 實例。

如果在資料庫中找不到匹配的模型實例,將自動產生 404 HTTP 回應。

自定義解析邏輯

如果你希望定義自己的模型繫結解析邏輯,可以使用 Route::bind 方法。傳遞給 bind 方法的閉包將接收 URI 片段的值,並應回傳應注入到路由中的類別實例。同樣,此自定義應發生在應用程式 AppServiceProviderboot 方法中:

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 片段的值,並應回傳應注入到路由中的類別實例:

/**
 * 擷取繫結值的模型。
 *
 * @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 方法來解析父模型的子繫結:

/**
 * 擷取繫結值的子模型。
 *
 * @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 中介層群組中的所有中介層都將應用於該路由。你可以根據需要自由地向此路由添加額外の中介層:

Route::fallback(function () {
    // ...
});

速率限制

定義速率限制器

Laravel 包含強大且可自定義的速率限制服務,你可以利用這些服務來限制給定路由或路由群組的流量。要開始使用,你應該定義符合應用程式需求的速率限制器設定。

速率限制器可以定義在應用程式 App\Providers\AppServiceProvider 類別的 boot 方法中:

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 類別的實例。此類別包含有用的「建構器」方法,以便你可以快速定義限制。速率限制器名稱可以是任何你想要的字串:

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 方法:

RateLimiter::for('global', function (Request $request) {
    return Limit::perMinute(1000)->response(function (Request $request, array $headers) {
        return response('Custom response...', 429, $headers);
    });
});

由於速率限制器閉包接收傳入的 HTTP 請求實例,因此你可以根據傳入請求或經過身分驗證的使用者動態建構適當的速率限制:

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()?->vipCustomer()
        ? Limit::none()
        : Limit::perHour(10);
});

分段速率限制

有時你可能希望按某些任意值對速率限制進行分段。例如,你可能希望允許使用者每分鐘按 IP 位址存取給定路由 100 次。為了實現這一點,你可以在建構速率限制時使用 by 方法:

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()->vipCustomer()
        ? Limit::none()
        : Limit::perMinute(100)->by($request->ip());
});

為了使用另一個範例來說明此功能,我們可以將路由存取限制為每位經過身分驗證的使用者 ID 每分鐘 100 次,或每位訪客每分鐘 10 次(按 IP 位址):

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()
        ? Limit::perMinute(100)->by($request->user()->id)
        : Limit::perMinute(10)->by($request->ip());
});

多個速率限制

如果需要,你可以為給定的速率限制器設定回傳速率限制陣列。每個速率限制將根據它們在陣列中的放置順序對路由進行評估:

RateLimiter::for('login', function (Request $request) {
    return [
        Limit::perMinute(500),
        Limit::perMinute(3)->by($request->input('email')),
    ];
});

如果你要分配由相同 by 值分段的多個速率限制,你應該確保每個 by 值都是唯一的。實現此目的最簡單方法是為給予 by 方法的值加上前綴:

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 回應,或者允許使用者重試驗證失敗的請求,而不會在僅應限制成功操作的端點上耗盡其速率限制:

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 中介層 將速率限制器附加到路由或路由群組。throttle 中介層接受你想要分配給路由的速率限制器名稱:

Route::middleware(['throttle:uploads'])->group(function () {
    Route::post('/audio', function () {
        // ...
    });

    Route::post('/video', function () {
        // ...
    });
});

使用 Redis 進行限制

預設情況下,throttle 中介層對應到 Illuminate\Routing\Middleware\ThrottleRequests 類別。但是,如果你使用 Redis 作為應用程式的快取驅動程式,你可能希望指示 Laravel 使用 Redis 來管理速率限制。為此,你應該在應用程式的 bootstrap/app.php 檔案中使用 throttleWithRedis 方法。此方法將 throttle 中介層對應到 Illuminate\Routing\Middleware\ThrottleRequestsWithRedis 中介層類別:

->withMiddleware(function (Middleware $middleware): void {
    $middleware->throttleWithRedis();
    // ...
})

表單方法欺騙

HTML 表單不支援 PUTPATCHDELETE 動作。因此,當定義從 HTML 表單呼叫的 PUTPATCHDELETE 路由時,你需要向表單添加隱藏的 _method 欄位。隨 _method 欄位發送的值將用作 HTTP 請求方法:

<form action="/example" method="POST">
    <input type="hidden" name="_method" value="PUT">
    <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

為了方便起見,你可以使用 @method Blade 指令 來產生 _method 輸入欄位:

<form action="/example" method="POST">
    @method('PUT')
    @source/csrf.md
</form>

存取當前路由

你可以使用 Route Facade 上的 currentcurrentRouteNamecurrentRouteAction 方法來存取有關處理傳入請求的路由資訊:

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 請求將由應用程式全域中介層堆疊中自動包含的 HandleCors 中介層 自動處理。

有時,你可能需要為應用程式自定義 CORS 設定值。你可以使用 config:publish Artisan 指令發佈 cors 設定檔來做到這一點:

php artisan config:publish cors

此指令將在應用程式的 config 目錄中放置一個 cors.php 設定檔。

[!NOTE] 有關 CORS 和 CORS 標頭的更多資訊,請查閱 MDN 關於 CORS 的 Web 文件

路由快取

將應用程式部署到正式環境時,你應該利用 Laravel 的路由快取。使用路由快取將大大減少註冊應用程式所有路由所需的時間。要產生路由快取,請執行 route:cache Artisan 指令:

php artisan route:cache

執行此指令後,快取的路由檔案將在每次請求時載入。請記住,如果你添加了任何新路由,你將需要產生新的路由快取。因此,你應該只在專案部署期間執行 route:cache 指令。

你可以使用 route:clear 指令來清除路由快取:

php artisan route:clear

ClearcutLogger: Flush already in progress, marking pending flush.