与其将所有请求处理逻辑定义为路由文件中的闭包,你可能希望使用“控制器”类来组织这种行为。控制器可以将相关的请求处理逻辑归入一个类中。例如,一个 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[!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);
},
];
}如果你将应用程序中的每个 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 消费的资源路由时,您通常会希望排除呈现 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,因为子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 模型。
默认情况下,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]
请记住让你的控制器保持专注。如果你发现自己经常需要超出典型资源动作集的方法,请考虑将你的控制器拆分为两个更小的控制器。
有时,你的应用程序会拥有可能只有一个实例的资源。
例如,用户的"profile"可以被编辑或更新,但一个用户不能拥有多个"profile"。
同样,一张图片可能只有一个"thumbnail"。
这些资源被称为"singleton resources",意味着资源只能存在一个实例。
在这些场景中,你可以注册一个"singleton"资源控制器:
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();该 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');
}
}