路由

基礎路由
路由參數
具名路由
路由群組
路由模型綁定
回退路由
速率限制
- 定義速率限制器
- 將速率限制器附加至路由
表單方法欺騙
存取目前路由
跨來源資源共用 (CORS)
路由快取

基礎路由

最基礎的 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 中介層群組，該群組提供了例如工作階段狀態 (session state) 和 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 路由

如果您的應用程式還將提供無狀態 (stateless) 的 API，您可以使用 install:api Artisan 指令來啟用 API 路由：

shell

php artisan install:api

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

php

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

當然，您可以自由地在應該公開存取的路由上省略 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 方法的路由之前定義。這能確保傳入的請求與正確的路由匹配。

依賴注入

您可以在路由的回呼函式簽章中，對路由所需的任何依賴項使用型別提示 (type-hint)。宣告的依賴項將由 Laravel 服務容器自動解析並注入到回呼函式中。例如，您可以對 Illuminate\Http\Request 類別使用型別提示，以便將目前的 HTTP 請求自動注入到您的路由回呼函式中：

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

然而，有時您可能想要定義一個全新的檔案來包含應用程式路由的一個子集。若要實現此目標，您可以向 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) {
    // ...
});

路由參數始終被包裹在 {} 大括號中，且應由英文字母組成。在路由參數名稱中使用底線 (_) 也是可以接受的。路由參數會根據其順序被注入到路由回呼函數 (callbacks) / 控制器中 —— 路由回呼函數 / 控制器引數的名稱並不重要。

參數與依賴注入

如果您的路由具有希望由 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 的查詢字串 (query string) 中：

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) {
        // ...
    });
});

路由前綴

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 的路由模型綁定提供了一種便捷的方法，可以直接將模型實例自動注入到您的路由中。例如，您可以直接注入與給定 ID 匹配的整個 User 模型實例，而不是注入使用者的 ID。

隱含綁定

Laravel 會自動解析定義在路由或控制器動作中，且其型別提示(type-hint)的變數名稱與路由片段名稱相符的 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 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 模型進行範圍限定(scope)，使其必須是前一個 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 (string-backed 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 回應來防止枚舉攻擊 (enumeration attacks)，或者允許使用者在不耗盡端點速率限制的情況下重試驗證失敗的請求特別有用（該端點應僅對成功操作進行節流）：

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 中介層附加至路由或路由群組。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 指令來產生 _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 請求將由自動包含在應用程式全域中介層堆疊中的 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)

路由快取