路由

基本路由
路由參數
命名路由
路由群組
路由模型綁定
備用路由
頻率限制
- 定義頻率限制器
- 將頻率限制器附加到路由
表單方法偽造
存取當前路由
跨來源資源共享 (CORS)
路由快取

基本路由

Laravel 最基本的路由接受一個 URI 和一個 Closure (閉包)，這提供了一個非常簡單且富有表達力的方法來定義路由與行為，無需複雜的路由設定檔：

php

use Illuminate\Support\Facades\Route;

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

預設路由檔案

所有 Laravel 路由都定義在您的路由檔案中，這些檔案位於 routes 目錄。Laravel 會依據應用程式 bootstrap/app.php 檔案中指定的配置自動載入這些檔案。routes/web.php 檔案定義了用於網頁介面的路由。這些路由會被指派 web 中介層群組，該群組提供了諸如 Session 狀態和 CSRF 保護等功能。

對於大多數應用程式，您會從 routes/web.php 檔案中定義路由開始。您可以在瀏覽器中輸入定義好的路由 URL 來存取 routes/web.php 中定義的路由。例如，您可以透過在瀏覽器中導覽至 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:api

install:api 命令會安裝 Laravel Sanctum，它提供了一個強大而簡單的 API Token 認證守衛，可用於認證第三方 API 消費者、SPA 或行動應用程式。此外，install:api 命令會建立 routes/api.php 檔案：

php

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

routes/api.php 中的路由是無狀態的，並且被指派到 api 中介層群組。此外，/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 () {
    // ...
});

📌 備註

當定義多個共用相同 URI 的路由時，使用 get、post、put、patch、delete 和 options 方法的路由應在使用 any、match 和 redirect 方法的路由之前定義。這可確保傳入的請求與正確的路由匹配。

依賴注入

您可以在路由的 callback 簽名中為路由所需的任何依賴項進行型別提示。宣告的依賴項將由 Laravel 服務容器自動解析並注入到 callback 中。例如，您可以對 Illuminate\Http\Request 類別進行型別提示，以讓當前的 HTTP 請求自動注入到您的路由 callback 中：

php

use Illuminate\Http\Request;

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

CSRF 保護

請記住，任何指向 web 路由檔案中定義的 POST、PUT、PATCH 或 DELETE 路由的 HTML 表單都應包含一個 CSRF Token 欄位。否則，請求將會被拒絕。您可以在 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');

⚠️ 警告

當在重新導向路由中使用路由參數時，以下參數是 Laravel 保留的，不能使用：destination 和 status。

視圖路由

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

php

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

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

⚠️ 警告

當在視圖路由中使用路由參數時，以下參數是 Laravel 保留的，不能使用：view、data、status 和 headers。

列出路由

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

shell

php artisan route:list

預設情況下，指派給每個路由的路由中介層不會顯示在 route:list 輸出中；但是，您可以透過在命令中添加 -v 選項來指示 Laravel 顯示路由中介層和中介層群組名稱：

shell

php artisan route:list -v

# Expand middleware groups...
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();

不過，有時候您可能會想要定義一個全新的檔案，以包含您應用程式部分路由。為此，您可以提供一個 then 閉包給 withRouting 方法。在此閉包中，您可以註冊任何您的應用程式所需要的額外路由：

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

或者，您甚至可以透過提供一個 using 閉包給 withRouting 方法，以完全掌控路由的註冊。當傳入此參數時，框架將不會註冊任何 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;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::pattern('id', '[0-9]+');
}

一旦定義了模式，它將自動應用於所有使用該參數名稱的路由：

php

Route::get('/user/{id}', function (string $id) {
    // Only executed if {id} is numeric...
});

編碼斜線

Laravel 路由元件允許所有字元（除了 /）出現在路由參數值中。您必須使用 where 條件正規表達式明確允許 / 作為預留位置的一部分：

php

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

⚠️ 警告

編碼的斜線僅在最後一個路由段中受支援。

命名路由

命名路由允許方便地為特定路由產生 URL 或重新導向。您可以透過將 name 方法鏈接到路由定義來為路由指定名稱：

php

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

您也可以為控制器動作指定路由名稱：

php

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

⚠️ 警告

路由名稱應該始終是唯一的。

產生命名路由的 URL

一旦您為給定路由分配了名稱，您就可以透過 Laravel 的 route 和 redirect 輔助函數在產生 URL 或重新導向時使用路由的名稱：

php

// Generating URLs...
$url = route('profile');

// Generating Redirects...
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=yes

📌 備註

有時，您可能希望為 URL 參數指定請求範圍的預設值，例如當前語系。為此，您可以使用 URL::defaults 方法。

檢查當前路由

如果您想判斷當前請求是否路由到給定的命名路由，您可以使用 Route 實例上的 named 方法。例如，您可以從路由中介層中檢查當前路由名稱：

php

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Handle an incoming request.
 *
 * @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 方法。中介層會依照它們在陣列中列出的順序執行：

php

Route::middleware(['first', 'second'])->group(function () {
    Route::get('/', function () {
        // Uses first & second middleware...
    });

    Route::get('/user/profile', function () {
        // Uses 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) {
        // ...
    });
});

⚠️ 警告

為確保您的子網域路由可達，您應該在註冊根網域路由之前註冊子網域路由。這將防止根網域路由覆寫具有相同 URI 路徑的子網域路由。

路由前綴

prefix 方法可用於為群組中的每個路由加上指定的 URI 前綴。例如，您可能希望將群組內的所有路由 URI 都加上 admin 前綴：

php

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

路由名稱前綴

name 方法可用於為群組中的每個路由名稱加上指定的字串前綴。例如，您可能希望將群組中所有路由的名稱都加上 admin 前綴。所提供的字串會完全按照指定的方式加到路由名稱前，因此我們務必在該前綴中提供尾隨的 . 字元：

php

Route::name('admin.')->group(function () {
    Route::get('/users', function () {
        // Route assigned name "admin.users"...
    })->name('users');
});

路由模型綁定

當你將模型 ID 注入路由或控制器動作時，你通常會查詢資料庫來擷取與該 ID 相符的模型。Laravel 的路由模型綁定 (Route Model Binding) 提供了一種便捷的方式，能自動將模型實例直接注入你的路由中。例如，你無須注入使用者的 ID，就能夠注入與指定 ID 相符的完整 User 模型實例。

隱式綁定

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 會自動注入其 ID 與請求 URI 中的相應值相符的模型實例。如果在資料庫中找不到匹配的模型實例，將自動產生 404 HTTP 回應。

當然，隱式綁定也適用於使用控制器方法。再次強調，請注意 {user} URI 區段與控制器中包含 App\Models\User 型別提示的 $user 變數相符：

php

use App\Http\Controllers\UserController;
use App\Models\User;

// Route definition...
Route::get('/users/{user}', [UserController::class, 'show']);

// Controller method definition...
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

/**
 * Get the route key for the model.
 */
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');
    });

隱式 Enum 綁定

PHP 8.1 引入了對 Enums 的支援。為了補足此功能，Laravel 允許你在路由定義上型別提示字串型別的 Enum，並且只有當該路由區段對應到一個有效的 Enum 值時，Laravel 才會調用該路由。否則，將自動返回 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;

/**
 * Bootstrap any application services.
 */
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;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::bind('user', function (string $value) {
        return User::where('name', $value)->firstOrFail();
    });
}

或者，您可以覆寫 Eloquent 模型上的 resolveRouteBinding 方法。此方法將接收 URI 片段的值，並應回傳應注入到路由中的類別實例：

php

/**
 * Retrieve the model for a bound value.
 *
 * @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

/**
 * Retrieve the child model for a bound value.
 *
 * @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 中介層群組中的所有中介層都將應用於該路由。您可以根據需要為此路由添加額外的中介層：

php

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

頻率限制

定義頻率限制器

Laravel 包含強大且可自訂的頻率限制服務，您可以用來限制給定路由或路由群組的流量。要開始使用，您應該定義符合應用程式需求的頻率限制器配置。

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

php

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;

/**
 * Bootstrap any application services.
 */
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;

/**
 * Bootstrap any application services.
 */
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) {
            // Only count 404 responses toward the rate limit to prevent enumeration...
            return $response->status() === 404;
        });
});

將頻率限制器附加到路由

頻率限制器可以使用 throttle middleware 附加到路由或路由群組。throttle 中介層接受您希望分配給路由的頻率限制器名稱：

php

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 中介層類別：

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 directive 來產生 _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 文件，以查閱路由和 Route 類別中所有可用的方法。

跨來源資源共享 (CORS)

Laravel 可以自動回應 CORS OPTIONS HTTP 請求，並帶有您配置的值。這些 OPTIONS 請求將由 HandleCors 中介層自動處理，該中介層已自動包含在您應用程式的全局中介層堆疊中。

有時，您可能需要為您的應用程式自訂 CORS 配置值。您可以透過使用 config:publish Artisan 指令來發布 cors 配置檔案：

shell

php artisan config:publish cors

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

📌 備註

有關 CORS 和 CORS 標頭的更多資訊，請查閱 MDN 關於 CORS 的網路文件。

路由快取

當將您的應用程式部署到生產環境時，您應該利用 Laravel 的路由快取。使用路由快取將顯著減少註冊所有應用程式路由所需的時間。要生成路由快取，請執行 route:cache Artisan 指令：

shell

php artisan route:cache

執行此指令後，您的快取路由檔案將在每個請求時載入。請記住，如果您添加任何新路由，則需要重新生成路由快取。因此，您應該只在專案部署期間運行 route:cache 指令。

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

shell

php artisan route:clear

路由 ​

基本路由 ​

預設路由檔案 ​

API 路由 ​

可用的路由器方法 ​

依賴注入 ​

CSRF 保護 ​

重新導向路由 ​

視圖路由 ​

列出路由 ​

路由自訂 ​

路由參數 ​

必要參數 ​

參數與依賴注入 ​

選用參數 ​

正規表達式限制 ​

全域限制 ​

編碼斜線 ​

命名路由 ​

產生命名路由的 URL ​

檢查當前路由 ​

路由群組 ​

中介層 ​

控制器 ​

子網域路由 ​

路由前綴 ​

路由名稱前綴 ​

路由模型綁定 ​

隱式綁定 ​

軟刪除模型 ​

自訂鍵值 ​

自訂鍵值與範圍綁定 ​

自訂模型遺失行為 ​

隱式 Enum 綁定 ​

顯式綁定 ​

自訂解析邏輯 ​

備用路由 ​

頻率限制 ​

定義頻率限制器 ​

分段頻率限制 ​

多重頻率限制 ​

基於回應的頻率限制 ​

將頻率限制器附加到路由 ​

使用 Redis 進行頻率限制 ​

表單方法偽造 ​

存取當前路由 ​

跨來源資源共享 (CORS) ​

路由快取 ​

路由

基本路由

預設路由檔案

API 路由

可用的路由器方法

依賴注入

CSRF 保護

重新導向路由

視圖路由

列出路由

路由自訂

路由參數

必要參數

參數與依賴注入

選用參數

正規表達式限制

全域限制

編碼斜線

命名路由

產生命名路由的 URL

檢查當前路由

路由群組

中介層

控制器

子網域路由

路由前綴

路由名稱前綴

路由模型綁定

隱式綁定

軟刪除模型

自訂鍵值

自訂鍵值與範圍綁定

自訂模型遺失行為

隱式 Enum 綁定

顯式綁定

自訂解析邏輯

備用路由

頻率限制

定義頻率限制器

分段頻率限制

多重頻率限制

基於回應的頻率限制

將頻率限制器附加到路由

使用 Redis 進行頻率限制

表單方法偽造

存取當前路由

跨來源資源共享 (CORS)

路由快取