控制器

• 簡介
• 撰寫控制器
  • 基本控制器
  • 單一動作控制器
• 控制器中介層
  • 中介層屬性
  • 授權屬性
• 資源控制器
  • 部分資源路由
  • 巢狀資源
  • 命名資源路由
  • 命名資源路由參數
  • 限制資源路由範圍
  • 本地化資源 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 方法，並將路由參數傳遞給該方法。

[!NOTE] 控制器並不需要擴展基礎類別。但是，有時擴展一個包含應在所有控制器之間共享的方法的基礎控制器類別會很方便。

單一動作控制器

如果控制器動作特別複雜，您可能會發現將整個控制器類別專門用於該單一動作會很方便。為此，您可以在控制器中定義一個單一的 __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

[!NOTE] 控制器模板可以透過模板發佈來自訂。

控制器中介層

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

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

中介層屬性

您也可以使用 PHP 屬性將中介層分配給控制器：

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Attributes\Controllers\Middleware;

#[Middleware('auth')]
#[Middleware('log', only: ['index'])]
#[Middleware('subscribed', except: ['store'])]
class UserController
{
    // ...
}

您也可以將中介層屬性放置在個別的控制器方法上。分配給方法的中介層將與在類別層級分配的中介層合併：

<?php

namespace App\Http\Controllers;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Routing\Attributes\Controllers\Middleware;

#[Middleware('auth')]
class UserController
{
    #[Middleware('log')]
    #[Middleware('subscribed')]
    public function index()
    {
        // ...
    }

    #[Middleware(static function (Request $request, Closure $next) {
        // ...

        return $next($request);
    })]
    public function store()
    {
        // ...
    }
}

授權屬性

如果您透過政策授權控制器動作，可以使用 Authorize 屬性作為 can 中介層的便捷快捷方式：

<?php

namespace App\Http\Controllers;

use App\Models\Comment;
use App\Models\Post;
use Illuminate\Routing\Attributes\Controllers\Authorize;

class CommentController
{
    #[Authorize('create', [Comment::class, 'post'])]
    public function store(Post $post)
    {
        // ...
    }

    #[Authorize('delete', 'comment')]
    public function destroy(Comment $comment)
    {
        // ...
    }
}

第一個參數是您要授權的能力。第二個參數是應傳遞給政策的模型類別、路由參數或參數。

資源控制器

如果您將應用程式中的每個 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,
]);

資源控制器處理的動作

自訂缺失模型行為

通常，如果找不到隱式綁定的資源模型，將會產生 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 資源路由

宣告將由 API 使用的資源路由時，通常會想要排除呈現 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

巢狀資源

有時您可能需要定義通往巢狀資源的路由。例如，一個照片資源可能有多個可以附加到照片的評論。要巢狀資源控制器，您可以在路由宣告中使用「點」符號：

use App\Http\Controllers\PhotoCommentController;

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

這條路由將註冊一個巢狀資源，可以透過像這樣的 URI 存取：

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

限制巢狀資源範圍

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

淺巢狀

通常，在 URI 中同時具有父級和子級 ID 並不是完全必要的，因為子級 ID 已經是唯一識別碼。在使用自動遞增主鍵等唯一識別碼來在 URI 區段中識別模型時，您可以選擇使用「淺巢狀」：

use App\Http\Controllers\CommentController;

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

此路由定義將定義以下路由：

命名資源路由

預設情況下，所有資源控制器動作都有一個路由名稱；但是，您可以透過傳遞一個包含所需路由名稱的 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 的限制範圍的隱式模型綁定功能可以自動限制巢狀綁定的範圍，確保解析的子模型屬於父模型。透過在定義巢狀資源時使用 scoped 方法，您可以啟用自動範圍限制，並指示 Laravel 應透過哪個欄位來檢索子資源：

use App\Http\Controllers\PhotoCommentController;

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

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

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

使用自訂鍵的隱式綁定作為巢狀路由參數時，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);

[!NOTE] 請記住保持控制器重點明確。如果您發現自己經常需要超出典型資源動作集之外的方法，請考慮將控制器拆分為兩個較小的控制器。

單例資源控制器

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

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

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

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

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

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

在此範例中，photos 資源將接收所有標準資源路由；但是，thumbnail 資源將是具有以下路由的單例資源：

可建立的單例資源

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

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

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

如果您希望 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');
    }
}