控制器

簡介
編寫控制器
- 基礎控制器
- 單動作控制器
控制器中介軟體
- 中介軟體屬性
- 授權屬性
資源控制器
依賴注入與控制器

簡介

與其將所有的請求處理邏輯定義為路由檔案中的閉包，不如使用“控制器”類來組織這些行為。控制器可以將相關的請求處理邏輯歸類到一個單獨的類中。例如，一個 UserController 類可以處理所有與使用者相關的傳入請求，包括顯示、建立、更新和刪除使用者。預設情況下，控制器儲存在 app/Http/Controllers 目錄中。

編寫控制器

基礎控制器

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

1php artisan make:controller UserController

php artisan make:controller UserController

讓我們看一個基礎控制器的示例。控制器可以包含任意數量的公共方法，這些方法將響應傳入的 HTTP 請求。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Models\User;
 6use Illuminate\View\View;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Show the profile for a given user.
12     */
13    public function show(string $id): View
14    {
15        return view('user.profile', [
16            'user' => User::findOrFail($id)
17        ]);
18    }
19}

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

編寫完控制器類和方法後，您可以像這樣定義指向該控制器方法的路由：

1use App\Http\Controllers\UserController;
2 
3Route::get('/user/{id}', [UserController::class, 'show']);

use App\Http\Controllers\UserController;

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

當傳入請求與指定的路由 URI 匹配時，App\Http\Controllers\UserController 類中的 show 方法將被呼叫，並且路由引數將被傳遞給該方法。

控制器不需要繼承基類。但是，繼承包含可在所有控制器中共享的方法的基控制器類有時會很方便。

單動作控制器

如果某個控制器動作特別複雜，您可能會覺得將整個控制器類專門用於該單一動作會更方便。要實現這一點，您可以在控制器中定義一個單獨的 __invoke 方法。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5class ProvisionServer extends Controller
 6{
 7    /**
 8     * Provision a new web server.
 9     */
10    public function __invoke()
11    {
12        // ...
13    }
14}

<?php

namespace App\Http\Controllers;

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

為單動作控制器註冊路由時，無需指定控制器方法。相反，您只需將控制器名稱傳遞給路由器即可：

1use App\Http\Controllers\ProvisionServer;
2 
3Route::post('/server', ProvisionServer::class);

use App\Http\Controllers\ProvisionServer;

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

您可以使用 make:controller Artisan 命令的 --invokable 選項來生成可呼叫的控制器。

1php artisan make:controller ProvisionServer --invokable

php artisan make:controller ProvisionServer --invokable

控制器存根（stubs）可以透過釋出存根進行自定義。

控制器中介軟體

中介軟體可以分配給路由檔案中的控制器路由。

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

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

或者，您可能會發現在控制器類中指定中介軟體更方便。為此，您的控制器應實現 HasMiddleware 介面，該介面規定控制器必須有一個靜態的 middleware 方法。在該方法中，您可以返回一個應應用於控制器動作的中介軟體陣列。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Routing\Controllers\HasMiddleware;
 6use Illuminate\Routing\Controllers\Middleware;
 7 
 8class UserController implements HasMiddleware
 9{
10    /**
11     * Get the middleware that should be assigned to the controller.
12     */
13    public static function middleware(): array
14    {
15        return [
16            'auth',
17            new Middleware('log', only: ['index']),
18            new Middleware('subscribed', except: ['store']),
19        ];
20    }
21 
22    // ...
23}

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

    // ...
}

您還可以將控制器中介軟體定義為閉包，這提供了一種無需編寫整個中介軟體類即可定義內聯中介軟體的便捷方式。

 1use Closure;
 2use Illuminate\Http\Request;
 3 
 4/**
 5 * Get the middleware that should be assigned to the controller.
 6 */
 7public static function middleware(): array
 8{
 9    return [
10        function (Request $request, Closure $next) {
11            return $next($request);
12        },
13    ];
14}

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 屬性（attributes）將中介軟體分配給控制器。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Routing\Attributes\Controllers\Middleware;
 6 
 7#[Middleware('auth')]
 8#[Middleware('log', only: ['index'])]
 9#[Middleware('subscribed', except: ['store'])]
10class UserController
11{
12    // ...
13}

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Attributes\Controllers\Middleware;

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

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

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Closure;
 6use Illuminate\Http\Request;
 7use Illuminate\Routing\Attributes\Controllers\Middleware;
 8 
 9#[Middleware('auth')]
10class UserController
11{
12    #[Middleware('log')]
13    #[Middleware('subscribed')]
14    public function index()
15    {
16        // ...
17    }
18 
19    #[Middleware(static function (Request $request, Closure $next) {
20        // ...
21 
22        return $next($request);
23    })]
24    public function store()
25    {
26        // ...
27    }
28}

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

授權屬性

如果您透過策略（Policies）對控制器動作進行授權，則可以使用 Authorize 屬性作為 can 中介軟體的便捷快捷方式。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Models\Comment;
 6use App\Models\Post;
 7use Illuminate\Routing\Attributes\Controllers\Authorize;
 8 
 9class CommentController
10{
11    #[Authorize('create', [Comment::class, 'post'])]
12    public function store(Post $post)
13    {
14        // ...
15    }
16 
17    #[Authorize('delete', 'comment')]
18    public function destroy(Comment $comment)
19    {
20        // ...
21    }
22}

<?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 選項快速建立一個用於處理這些動作的控制器。

1php artisan make:controller PhotoController --resource

php artisan make:controller PhotoController --resource

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

1use App\Http\Controllers\PhotoController;
2 
3Route::resource('photos', PhotoController::class);

use App\Http\Controllers\PhotoController;

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

這條單一的路由宣告建立了多個路由，用於處理資源上的各種動作。生成的控制器將已經為這些動作中的每一個預留了方法存根。請記住，您始終可以透過執行 route:list Artisan 命令快速檢視應用程式的路由概況。

您甚至可以透過向 resources 方法傳遞一個數組，一次性註冊多個資源控制器。

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

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

softDeletableResources 方法註冊了多個均使用 withTrashed 方法的資源控制器。

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

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 方法接受一個閉包，如果無法為資源的任何路由找到隱式繫結的模型，該閉包將被呼叫。

1use App\Http\Controllers\PhotoController;
2use Illuminate\Http\Request;
3use Illuminate\Support\Facades\Redirect;
4 
5Route::resource('photos', PhotoController::class)
6    ->missing(function (Request $request) {
7        return Redirect::route('photos.index');
8    });

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 方法來指示框架允許使用軟刪除模型。

1use App\Http\Controllers\PhotoController;
2 
3Route::resource('photos', PhotoController::class)->withTrashed();

use App\Http\Controllers\PhotoController;

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

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

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

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

指定資源模型

如果您正在使用路由模型繫結，並希望資源控制器的方法對模型例項進行型別提示，您可以在生成控制器時使用 --model 選項。

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

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

生成表單請求

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

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

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

部分資源路由

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

1use App\Http\Controllers\PhotoController;
2 
3Route::resource('photos', PhotoController::class)->only([
4    'index', 'show'
5]);
6 
7Route::resource('photos', PhotoController::class)->except([
8    'create', 'store', 'update', 'destroy'
9]);

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 方法自動排除這兩個路由。

1use App\Http\Controllers\PhotoController;
2 
3Route::apiResource('photos', PhotoController::class);

use App\Http\Controllers\PhotoController;

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

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

1use App\Http\Controllers\PhotoController;
2use App\Http\Controllers\PostController;
3 
4Route::apiResources([
5    'photos' => PhotoController::class,
6    'posts' => PostController::class,
7]);

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

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

要快速生成不包含 create 或 edit 方法的 API 資源控制器，請在執行 make:controller 命令時使用 --api 開關。

1php artisan make:controller PhotoController --api

php artisan make:controller PhotoController --api

巢狀資源

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

1use App\Http\Controllers\PhotoCommentController;
2 
3Route::resource('photos.comments', PhotoCommentController::class);

use App\Http\Controllers\PhotoCommentController;

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

此路由將註冊一個巢狀資源，可以透過如下所示的 URI 進行訪問：

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

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

巢狀資源作用域

Laravel 的隱式模型繫結功能可以自動對巢狀繫結進行作用域限制，確保解析出的子模型屬於父模型。透過在定義巢狀資源時使用 scoped 方法，您可以啟用自動作用域限制，並告知 Laravel 應透過哪個欄位檢索子資源。有關如何實現此操作的更多資訊，請參閱關於資源路由作用域的文件。

淺層巢狀

通常，URI 中不必同時包含父 ID 和子 ID，因為子 ID 已經是唯一識別符號。在使用自動遞增主鍵等唯一識別符號來標識 URI 段中的模型時，您可以選擇使用“淺層巢狀”。

1use App\Http\Controllers\CommentController;
2 
3Route::resource('photos.comments', CommentController::class)->shallow();

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 陣列來覆蓋這些名稱。

1use App\Http\Controllers\PhotoController;
2 
3Route::resource('photos', PhotoController::class)->names([
4    'create' => 'photos.build'
5]);

use App\Http\Controllers\PhotoController;

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

命名資源路由引數

預設情況下，Route::resource 將根據資源名稱的“單數”版本為您的資源路由建立路由引數。您可以使用 parameters 方法輕鬆地為每個資源覆蓋此設定。傳遞給 parameters 方法的陣列應該是資源名稱和引數名稱的關聯陣列。

1use App\Http\Controllers\AdminUserController;
2 
3Route::resource('users', AdminUserController::class)->parameters([
4    'users' => 'admin_user'
5]);

use App\Http\Controllers\AdminUserController;

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

上面的示例為資源的 show 路由生成了以下 URI：

1/users/{admin_user}

/users/{admin_user}

資源路由作用域

Laravel 的作用域隱式模型繫結功能可以自動對巢狀繫結進行作用域限制，確保解析出的子模型屬於父模型。透過在定義巢狀資源時使用 scoped 方法，您可以啟用自動作用域限制，並告知 Laravel 應透過哪個欄位檢索子資源。

1use App\Http\Controllers\PhotoCommentController;
2 
3Route::resource('photos.comments', PhotoCommentController::class)->scoped([
4    'comment' => 'slug',
5]);

use App\Http\Controllers\PhotoCommentController;

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

此路由將註冊一個作用域巢狀資源，可以透過如下所示的 URI 進行訪問：

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

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

當使用自定義鍵控隱式繫結作為巢狀路由引數時，Laravel 將自動限制查詢範圍，以透過父模型檢索巢狀模型，並使用約定來猜測父模型上的關係名稱。在這種情況下，將假定 Photo 模型具有一個名為 comments（路由引數名稱的複數）的關係，該關係可用於檢索 Comment 模型。

本地化資源 URI

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

 1/**
 2 * Bootstrap any application services.
 3 */
 4public function boot(): void
 5{
 6    Route::resourceVerbs([
 7        'create' => 'crear',
 8        'edit' => 'editar',
 9    ]);
10}

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

Laravel 的複數轉換器支援幾種不同的語言，您可以根據需要進行配置。一旦自定義了動詞和複數語言，資源路由註冊（如 Route::resource('publicacion', PublicacionController::class)）將生成以下 URI：

1/publicacion/crear
2
3/publicacion/{publicaciones}/editar

/publicacion/crear

/publicacion/{publicaciones}/editar

補充資源控制器

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

1use App\Http\Controller\PhotoController;
2 
3Route::get('/photos/popular', [PhotoController::class, 'popular']);
4Route::resource('photos', PhotoController::class);

use App\Http\Controller\PhotoController;

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

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

單例資源控制器

有時，您的應用程式會有可能只有一個例項的資源。例如，使用者的“個人資料”可以被編輯或更新，但使用者不能擁有多個“個人資料”。同樣，一張圖片可能只有一個“縮圖”。這些資源被稱為“單例資源”，意味著該資源只能存在一個且僅一個例項。在這種情況下，您可以註冊一個“單例”資源控制器。

1use App\Http\Controllers\ProfileController;
2use Illuminate\Support\Facades\Route;
3 
4Route::singleton('profile', ProfileController::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

單例資源也可以巢狀在標準資源中。

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

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

1Route::singleton('photos.thumbnail', ThumbnailController::class)->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 方法。

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

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

API 單例資源

apiSingleton 方法可用於註冊將透過 API 操作的單例資源，從而使 create 和 edit 路由不再必要。

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

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

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

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

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

中介軟體與資源控制器

Laravel 允許您使用 middleware、middlewareFor 和 withoutMiddlewareFor 方法將中介軟體分配給資源路由的全部或特定方法。這些方法提供了對應用於每個資源動作的中介軟體的細粒度控制。

將中介軟體應用於所有方法

您可以使用 middleware 方法將中介軟體分配給資源或單例資源路由生成的所有路由。

1Route::resource('users', UserController::class)
2    ->middleware(['auth', 'verified']);
3 
4Route::singleton('profile', ProfileController::class)
5    ->middleware('auth');

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

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

將中介軟體應用於特定方法

您可以使用 middlewareFor 方法將中介軟體分配給給定資源控制器的一個或多個特定方法。

 1Route::resource('users', UserController::class)
 2    ->middlewareFor('show', 'auth');
 3 
 4Route::apiResource('users', UserController::class)
 5    ->middlewareFor(['show', 'update'], 'auth');
 6 
 7Route::resource('users', UserController::class)
 8    ->middlewareFor('show', 'auth')
 9    ->middlewareFor('update', 'auth');
10 
11Route::apiResource('users', UserController::class)
12    ->middlewareFor(['show', 'update'], ['auth', 'verified']);

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 單例資源控制器結合使用。

1Route::singleton('profile', ProfileController::class)
2    ->middlewareFor('show', 'auth');
3 
4Route::apiSingleton('profile', ProfileController::class)
5    ->middlewareFor(['show', 'update'], 'auth');

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

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

從特定方法中排除中介軟體

您可以使用 withoutMiddlewareFor 方法從資源控制器的特定方法中排除中介軟體。

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

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 控制器。因此，您可以在建構函式中對控制器所需的任何依賴項進行型別提示。宣告的依賴項將自動被解析並注入到控制器例項中。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Repositories\UserRepository;
 6 
 7class UserController extends Controller
 8{
 9    /**
10     * Create a new controller instance.
11     */
12    public function __construct(
13        protected UserRepository $users,
14    ) {}
15}

<?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 例項注入到控制器方法中。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Http\RedirectResponse;
 6use Illuminate\Http\Request;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Store a new user.
12     */
13    public function store(Request $request): RedirectResponse
14    {
15        $name = $request->name;
16 
17        // Store the user...
18 
19        return redirect('/users');
20    }
21}

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

如果您的控制器方法還需要來自路由引數的輸入，請將路由引數列在其他依賴項之後。例如，如果您的路由定義如下：

1use App\Http\Controllers\UserController;
2 
3Route::put('/user/{id}', [UserController::class, 'update']);

use App\Http\Controllers\UserController;

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

您仍然可以對 Illuminate\Http\Request 進行型別提示，並透過按如下方式定義控制器方法來訪問您的 id 引數：

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Http\RedirectResponse;
 6use Illuminate\Http\Request;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Update the given user.
12     */
13    public function update(Request $request, string $id): RedirectResponse
14    {
15        // Update the user...
16 
17        return redirect('/users');
18    }
19}

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

控制器

簡介

編寫控制器

基礎控制器

單動作控制器

控制器中介軟體

中介軟體屬性

授權屬性

資源控制器

資源控制器處理的動作

自定義缺失模型的行為

軟刪除模型

指定資源模型

生成表單請求

部分資源路由

API 資源路由

巢狀資源

巢狀資源作用域

淺層巢狀

命名資源路由

命名資源路由引數

資源路由作用域

本地化資源 URI

補充資源控制器

單例資源控制器

可建立的單例資源

API 單例資源

中介軟體與資源控制器

將中介軟體應用於所有方法

將中介軟體應用於特定方法

從特定方法中排除中介軟體

依賴注入與控制器

建構函式注入

方法注入

在此頁面上

產品

Packages

資源

合作伙伴