控制器

• 簡介
• 編寫控制器
  • 基本控制器
  • 單一動作控制器
• 控制器中介層
• 資源控制器
  • 部分資源路由
  • 巢狀資源
  • 命名資源路由
  • 命名資源路由參數
  • 資源路由範圍
  • 本地化資源 URI
  • 補充資源控制器
  • 單例資源控制器
  • 中介層與資源控制器
• 依賴注入與控制器

簡介

您可能希望使用「控制器」類別來組織請求處理邏輯，而非將所有邏輯定義為路由檔案中的閉包。控制器能將相關的請求處理邏輯分組到單一類別中。例如，UserController 類別可能處理所有與使用者相關的傳入請求，包括顯示、建立、更新和刪除使用者。預設情況下，控制器儲存在 app/Http/Controllers 目錄中。

編寫控制器

基本控制器

若要快速產生新的控制器，您可以執行 make:controller Artisan 命令。預設情況下，應用程式的所有控制器都儲存在 app/Http/Controllers 目錄中：

php artisan make:controller UserController

讓我們看看基本控制器的一個範例。控制器可以有多個公開方法，這些方法將響應傳入的 HTTP 請求：

<?php

namespace App\Http\Controllers;

use App\Models\User;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * Show the profile for a given user.
     */
    public function show(string $id): View
    {
        return view('user.profile', [
            'user' => User::findOrFail($id)
        ]);
    }
}

編寫控制器類別和方法後，您可以像這樣為控制器方法定義路由：

use App\Http\Controllers\UserController;

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

當傳入請求匹配指定的路由 URI 時，App\Http\Controllers\UserController 類別上的 show 方法將被調用，路由參數將傳遞給該方法。

📌 備註

控制器不要求繼承基底類別。不過，有時繼承一個包含應在所有控制器之間共享方法的基本控制器類別會很方便。

單一動作控制器

如果控制器動作特別複雜，您可能會覺得將整個控制器類別專用於該單一動作很方便。為此，您可以在控制器中定義一個單一的 __invoke 方法：

<?php

namespace App\Http\Controllers;

class ProvisionServer extends Controller
{
    /**
     * Provision a new web server.
     */
    public function __invoke()
    {
        // ...
    }
}

註冊單一動作控制器路由時，您不需要指定控制器方法。相反地，您可以直接將控制器名稱傳遞給路由器：

use App\Http\Controllers\ProvisionServer;

Route::post('/server', ProvisionServer::class);

您可以使用 make:controller Artisan 命令的 --invokable 選項來產生一個可呼叫的控制器：

php artisan make:controller ProvisionServer --invokable

📌 備註

控制器 Stub 可以透過 Stub 發佈 來客製化。

控制器中介層

中介層 可以指派給控制器在路由檔案中的路由：

Route::get('/profile', [UserController::class, 'show'])->middleware('auth');

或者，您可能會覺得在控制器類別中指定中介層很方便。為此，您的控制器應實作 HasMiddleware 介面，這表示控制器應該有一個靜態的 middleware 方法。在這個方法中，您可以回傳一個應該應用於控制器動作的中介層陣列：

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Controllers\HasMiddleware;
use Illuminate\Routing\Controllers\Middleware;

class UserController implements HasMiddleware
{
    /**
     * Get the middleware that should be assigned to the controller.
     */
    public static function middleware(): array
    {
        return [
            'auth',
            new Middleware('log', only: ['index']),
            new Middleware('subscribed', except: ['store']),
        ];
    }

    // ...
}

您也可以將控制器中介層定義為閉包，這提供了一種方便的方式來定義行內中介層，而無需編寫完整的中介層類別：

use Closure;
use Illuminate\Http\Request;

/**
 * Get the middleware that should be assigned to the controller.
 */
public static function middleware(): array
{
    return [
        function (Request $request, Closure $next) {
            return $next($request);
        },
    ];
}

資源控制器

如果您將應用程式中的每個 Eloquent 模型都視為一個「資源」，那麼對應用程式中的每個資源執行相同的操作集合是很常見的。例如，假設您的應用程式包含一個 Photo 模型和一個 Movie 模型。使用者很可能會建立、讀取、更新或刪除這些資源。

由於這種常見的使用情境，Laravel 資源路由使用單行程式碼，將典型的建立、讀取、更新和刪除（「CRUD」）路由分配給一個控制器。要開始使用，我們可以使用 make:controller Artisan 指令的 --resource 選項來快速建立一個控制器來處理這些動作：

php artisan make:controller PhotoController --resource

這個指令將會在 app/Http/Controllers/PhotoController.php 產生一個控制器。該控制器將包含每個可用資源操作的方法。接下來，您可以註冊一個指向該控制器的資源路由：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class);

這個單一路由宣告會建立多個路由來處理資源上的各種操作。產生的控制器已經為這些操作提供了方法存根。請記住，您隨時可以透過執行 route:list Artisan 指令來快速概覽應用程式的路由。

您甚至可以透過將陣列傳遞給 resources 方法，一次註冊多個資源控制器：

Route::resources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

softDeletableResources 方法註冊了許多資源控制器，這些控制器都使用了 withTrashed 方法：

Route::softDeletableResources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

資源控制器處理的動作

動詞	URI	動作	路由名稱
GET	/photos	index	photos.index
GET	/photos/create	create	photos.create
POST	/photos	store	photos.store
GET	/photos/{photo}	show	photos.show
GET	/photos/{photo}/edit	edit	photos.edit
PUT/PATCH	/photos/{photo}	update	photos.update
DELETE	/photos/{photo}	destroy	photos.destroy

自訂缺少模型行為

通常，如果找不到隱式綁定的資源模型，將會產生 404 HTTP 回應。然而，您可以透過在定義資源路由時呼叫 missing 方法來客製化此行為。missing 方法接受一個閉包，如果為任何資源的路由找不到隱式綁定的模型，該閉包將會被呼叫：

use App\Http\Controllers\PhotoController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;

Route::resource('photos', PhotoController::class)
    ->missing(function (Request $request) {
        return Redirect::route('photos.index');
    });

軟刪除模型

通常，隱式模型綁定不會擷取已 軟刪除 的模型，而是會返回 404 HTTP 回應。然而，您可以透過在定義資源路由時呼叫 withTrashed 方法，指示框架允許軟刪除模型：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->withTrashed();

呼叫不帶引數的 withTrashed 將允許 show、edit 和 update 資源路由使用軟刪除模型。您可以透過將陣列傳遞給 withTrashed 方法來指定這些路由的子集：

Route::resource('photos', PhotoController::class)->withTrashed(['show']);

指定資源模型

如果您正在使用 路由模型綁定 並且希望資源控制器的方法型別提示模型實例，您可以在產生控制器時使用 --model 選項：

php artisan make:controller PhotoController --model=Photo --resource

產生表單請求

您可以在產生資源控制器時提供 --requests 選項，以指示 Artisan 為控制器的儲存和更新方法產生 表單請求類別：

php artisan make:controller PhotoController --model=Photo --resource --requests

部分資源路由

宣告資源路由時，您可以指定控制器應處理的動作子集，而不是完整的預設動作集：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->only([
    'index', 'show'
]);

Route::resource('photos', PhotoController::class)->except([
    'create', 'store', 'update', 'destroy'
]);

API 資源路由

在宣告將由 APIs 消費的資源路由時，您通常會希望排除呈現 HTML 範本的路由，例如 create 和 edit。為方便起見，您可以使用 apiResource 方法自動排除這兩個路由：

use App\Http\Controllers\PhotoController;

Route::apiResource('photos', PhotoController::class);

您可以透過將陣列傳遞給 apiResources 方法，一次註冊多個 API 資源控制器：

use App\Http\Controllers\PhotoController;
use App\Http\Controllers\PostController;

Route::apiResources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

要快速產生一個不包含 create 或 edit 方法的 API 資源控制器，可以在執行 make:controller 指令時使用 --api 開關：

php artisan make:controller PhotoController --api

巢狀資源

有時您可能需要定義巢狀資源的路由。例如，一個 photo 資源可能有多個可附加到該 photo 的 comments。要巢狀資源控制器，您可以在路由宣告中使用「點號表示法 (dot notation)」：

use App\Http\Controllers\PhotoCommentController;

Route::resource('photos.comments', PhotoCommentController::class);

此路由將註冊一個巢狀資源，可透過以下 URI 存取：

/photos/{photo}/comments/{comment}

巢狀資源範圍界定

Laravel 的隱式模型綁定功能可以自動限定巢狀綁定 (nested bindings) 的範圍，以確保解析出的子模型屬於其父模型。透過在定義巢狀資源時使用 scoped 方法，您可以啟用自動範圍限定 (automatic scoping)，並指示 Laravel 應透過哪個欄位來檢索子資源。有關如何實現此目的的更多資訊，請參閱資源路由範圍的相關文件。

淺層巢狀 (Shallow Nesting)

通常，URI 中同時包含父級與子級 ID 並非完全必要，因為子級 ID 本身已是唯一識別碼。當在 URI 區段中使用唯一識別碼（例如自動遞增主鍵）來識別模型時，您可以選擇使用「淺層巢狀 (shallow nesting)」：

use App\Http\Controllers\CommentController;

Route::resource('photos.comments', CommentController::class)->shallow();

這個路由定義將會定義以下路由：

動詞	URI	動作	路由名稱
GET	/photos/{photo}/comments	index	photos.comments.index
GET	/photos/{photo}/comments/create	create	photos.comments.create
POST	/photos/{photo}/comments	store	photos.comments.store
GET	/comments/{comment}	show	comments.show
GET	/comments/{comment}/edit	edit	comments.edit
PUT/PATCH	/comments/{comment}	update	comments.update
DELETE	/comments/{comment}	destroy	comments.destroy

命名資源路由

預設情況下，所有資源控制器動作都帶有路由名稱；但是，您可以透過傳入一個 names 陣列，並指定您想要的路由名稱來覆寫這些名稱：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->names([
    'create' => 'photos.build'
]);

命名資源路由參數

預設情況下，Route::resource 會根據資源名稱的「單數化」版本來為您的資源路由建立路由參數。您可以透過 parameters 方法，輕易地針對每個資源來覆寫此行為。傳入 parameters 方法的陣列應該是一個包含資源名稱與參數名稱的關聯陣列：

use App\Http\Controllers\AdminUserController;

Route::resource('users', AdminUserController::class)->parameters([
    'users' => 'admin_user'
]);

上述範例將為該資源的 show 路由產生以下 URI：

/users/{admin_user}

資源路由範圍

Laravel 的範圍限定隱式模型綁定功能可以自動限定巢狀綁定 (nested bindings) 的範圍，以確保解析出的子模型屬於其父模型。透過在定義巢狀資源時使用 scoped 方法，您可以啟用自動範圍限定 (automatic scoping)，並指示 Laravel 應透過哪個欄位來檢索子資源：

use App\Http\Controllers\PhotoCommentController;

Route::resource('photos.comments', PhotoCommentController::class)->scoped([
    'comment' => 'slug',
]);

此路由將註冊一個範圍限定的巢狀資源，可透過以下 URI 存取：

/photos/{photo}/comments/{comment:slug}

當使用自訂鍵的隱式綁定 (custom keyed implicit binding) 作為巢狀路由參數時，Laravel 會自動限定查詢範圍，透過慣例猜測父級上的關聯名稱來檢索巢狀模型。在此情況下，將假定 Photo 模型具有一個名為 comments（路由參數名稱的複數形式）的關聯，可用於檢索 Comment 模型。

本地化資源 URI

預設情況下，Route::resource 會使用英文動詞和複數規則建立資源 URI。如果您需要本地化 create 和 edit 動作動詞，可以使用 Route::resourceVerbs 方法。這可以在您應用程式的 App\Providers\AppServiceProvider 中，於 boot 方法的開頭完成：

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

Laravel 的複數器支援多種不同的語言，您可以根據需求進行配置。一旦動詞和複數化語言經過客製化，像 Route::resource('publicacion', PublicacionController::class) 這樣的資源路由註冊將會產生以下 URI：

/publicacion/crear

/publicacion/{publicaciones}/editar

補充資源控制器

如果您需要在資源控制器中，除了預設的資源路由集合之外，添加額外路由，您應該在呼叫 Route::resource 方法之前定義這些路由；否則，resource 方法所定義的路由可能會無意中優先於您的補充路由：

use App\Http\Controller\PhotoController;

Route::get('/photos/popular', [PhotoController::class, 'popular']);
Route::resource('photos', PhotoController::class);

📌 備註

請記住保持您的控制器專注。如果您發現自己經常需要使用典型資源動作集合之外的方法，請考慮將您的控制器拆分為兩個較小的控制器。

單例資源控制器

有時，你的應用程式會有只能有一個實例的資源。例如，使用者的「個人資料」可以被編輯或更新，但使用者不能擁有超過一份「個人資料」。同樣地，一張圖片可能只有一個「縮圖」。這些資源被稱為「單例資源」，意指該資源只能存在一個實例。在這些情況下，你可以註冊一個「單例」資源控制器：

use App\Http\Controllers\ProfileController;
use Illuminate\Support\Facades\Route;

Route::singleton('profile', ProfileController::class);

上述單例資源定義將註冊以下路由。如你所見，「建立」路由不會為單例資源註冊，且註冊的路由不接受識別碼，因為該資源只能存在一個實例：

動詞	URI	動作	路由名稱
GET	/profile	show	profile.show
GET	/profile/edit	edit	profile.edit
PUT/PATCH	/profile	update	profile.update

單例資源也可以巢狀地定義在標準資源內：

Route::singleton('photos.thumbnail', ThumbnailController::class);

在此範例中，photos 資源將接收所有 標準資源路由；然而，thumbnail 資源將是一個單例資源，包含以下路由：

動詞	URI	動作	路由名稱
GET	/photos/{photo}/thumbnail	show	photos.thumbnail.show
GET	/photos/{photo}/thumbnail/edit	edit	photos.thumbnail.edit
PUT/PATCH	/photos/{photo}/thumbnail	update	photos.thumbnail.update

可建立的單例資源

有時，你可能希望為單例資源定義建立和儲存路由。為此，你可以在註冊單例資源路由時呼叫 creatable 方法：

Route::singleton('photos.thumbnail', ThumbnailController::class)->creatable();

在此範例中，將註冊以下路由。如你所見，可建立的單例資源也會註冊一個 DELETE 路由：

動詞	URI	動作	路由名稱
GET	/photos/{photo}/thumbnail/create	create	photos.thumbnail.create
POST	/photos/{photo}/thumbnail	store	photos.thumbnail.store
GET	/photos/{photo}/thumbnail	show	photos.thumbnail.show
GET	/photos/{photo}/thumbnail/edit	edit	photos.thumbnail.edit
PUT/PATCH	/photos/{photo}/thumbnail	update	photos.thumbnail.update
DELETE	/photos/{photo}/thumbnail	destroy	photos.thumbnail.destroy

如果你希望 Laravel 為單例資源註冊 DELETE 路由，但不註冊建立或儲存路由，你可以使用 destroyable 方法：

Route::singleton(...)->destroyable();

API 單例資源

apiSingleton 方法可用於註冊一個將透過 API 操作的單例資源，因此使得 create 和 edit 路由變得不必要：

Route::apiSingleton('profile', ProfileController::class);

當然，API 單例資源也可以是 creatable，這將為該資源註冊 store 和 destroy 路由：

Route::apiSingleton('photos.thumbnail', ProfileController::class)->creatable();

中介層與資源控制器

Laravel 允許你使用 middleware、middlewareFor 和 withoutMiddlewareFor 方法，為資源路由的所有方法或特定方法分配中介層。這些方法提供了對每個資源動作應用哪些中介層的精細控制。

對所有方法應用中介層

你可以使用 middleware 方法為資源或單例資源路由生成的所有路由分配中介層：

Route::resource('users', UserController::class)
    ->middleware(['auth', 'verified']);

Route::singleton('profile', ProfileController::class)
    ->middleware('auth');

對特定方法應用中介層

你可以使用 middlewareFor 方法為給定資源控制器的一個或多個特定方法分配中介層：

Route::resource('users', UserController::class)
    ->middlewareFor('show', 'auth');

Route::apiResource('users', UserController::class)
    ->middlewareFor(['show', 'update'], 'auth');

Route::resource('users', UserController::class)
    ->middlewareFor('show', 'auth')
    ->middlewareFor('update', 'auth');

Route::apiResource('users', UserController::class)
    ->middlewareFor(['show', 'update'], ['auth', 'verified']);

middlewareFor 方法也可以與單例和 API 單例資源控制器結合使用：

Route::singleton('profile', ProfileController::class)
    ->middlewareFor('show', 'auth');

Route::apiSingleton('profile', ProfileController::class)
    ->middlewareFor(['show', 'update'], 'auth');

從特定方法中排除中介層

你可以使用 withoutMiddlewareFor 方法從資源控制器的特定方法中排除中介層：

Route::middleware(['auth', 'verified', 'subscribed'])->group(function () {
    Route::resource('users', UserController::class)
        ->withoutMiddlewareFor('index', ['auth', 'verified'])
        ->withoutMiddlewareFor(['create', 'store'], 'verified')
        ->withoutMiddlewareFor('destroy', 'subscribed');
});

依賴注入與控制器

建構子注入

Laravel 的 服務容器 用於解析所有的 Laravel 控制器。因此，你可以在控制器的建構子中型別提示任何所需的依賴。這些宣告的依賴將會自動解析並注入到控制器實例中：

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * Create a new controller instance.
     */
    public function __construct(
        protected UserRepository $users,
    ) {}
}

方法注入

除了建構子注入，你也可以在控制器的方法上型別提示依賴。方法注入的常見用途是將 Illuminate\Http\Request 實例注入到你的控制器方法中：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Store a new user.
     */
    public function store(Request $request): RedirectResponse
    {
        $name = $request->name;

        // Store the user...

        return redirect('/users');
    }
}

如果你的控制器方法也期望從路由參數中獲取輸入，請將你的路由參數列在其他依賴之後。例如，如果你的路由定義如下：

use App\Http\Controllers\UserController;

Route::put('/user/{id}', [UserController::class, 'update']);

你仍然可以型別提示 Illuminate\Http\Request 並透過以下方式定義控制器方法來存取你的 id 參數：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Update the given user.
     */
    public function update(Request $request, string $id): RedirectResponse
    {
        // Update the user...

        return redirect('/users');
    }
}