Laravel中间件的使用详解
目录
- 一:创建中间件
- 二:前置和后置中间件
- 1:前置中间件
- 2:后置中间件
- 三:注册中间件
- 1:注册全局中间件
- 2:为路由分配中间件
- 3:中间件组
- 4:排序中间件
- 5:中间件参数
- 6:Terminable 中间件
Laravel 中间件提供了一种方便的机制来过滤进入应用的 HTTP 请求。例如,Laravel 内置了一个中间件来验证用户的身份认证。如果用户没有通过身份认证,中间件会将用户重定向到登录界面。但是,如果用户被认证,中间件将允许该请求进一步进入该应用,所有中间件都位于 app/Http/Middleware 目录下
一:创建中间件
使用 make:middleware 命令来创建新的中间件
php artisan make:middleware CheckAge #CheckAge表示的是中间件文件名称
该命令将会在 app/Http/Middleware 目录内新建一个 CheckAge 类
在这个中间件里,我们仅允许提供的参数 id 大于 200 的请求访问该路由。否则,我们会将用户重定向到 home
<?php namespace App\Http\Middleware; use Closure; class CheckAge { /** * 处理传入的请求 * * @param \Illuminate\Http\Request $request * @param \Closure $next * @return mixed */ public function handle($request, Closure $next) { if ($request->id<= 200) { return redirect("home"); } return $next($request); } }
二:前置和后置中间件
中间件是在请求之前或之后运行取决于中间件本身
1:前置中间件
<?php namespace App\Http\Middleware; use Closure; class BeforeMiddleware { public function handle($request, Closure $next) { // 执行动作 return $next($request); } }
2:后置中间件
<?php namespace App\Http\Middleware; use Closure; class AfterMiddleware { public function handle($request, Closure $next) { $response = $next($request); // 执行动作 return $response; } }
三:注册中间件
1:注册全局中间件
如果你想让中间件在你应用的每个 HTTP 请求期间运行,只需在 app/Http/Kernel.php 类中的 $middleware 属性里列出这个中间件类
protected $middleware = [ \App\Http\Middleware\TrustProxies::class, \App\Http\Middleware\CheckForMaintenanceMode::class, \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class, \App\Http\Middleware\TrimStrings::class, \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class, ];
2:为路由分配中间件
如果想为指定的路由配置中间件,首先应该在 app/Http/Kernel.php 文件内为该中间件指定一个键。默认情况下,Kernel 类的 $routeMiddleware 属性包含 Laravel 内置的中间件条目。要加入自定义的,只需把它附加到列表后并为其分配一个自定义键即可
protected $routeMiddleware = [ "auth" => \App\Http\Middleware\Authenticate::class, "auth.basic" => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class, "bindings" => \Illuminate\Routing\Middleware\SubstituteBindings::class, "cache.headers" => \Illuminate\Http\Middleware\SetCacheHeaders::class, "can" => \Illuminate\Auth\Middleware\Authorize::class, "guest" => \App\Http\Middleware\RedirectIfAuthenticated::class, "signed" => \Illuminate\Routing\Middleware\ValidateSignature::class, "throttle" => \Illuminate\Routing\Middleware\ThrottleRequests::class, "verified" => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class, ];
一旦在 Kernel 中定义了中间件,就可使用 middleware 方法将中间件分配给路由
Route::get("admin/profile", function () { // })->middleware("auth");
你还可以为路由分配多个中间件
Route::get("/", function () { // })->middleware("first", "second");
分配中间件时,你还可以传递完整的类名
use App\Http\Middleware\CheckAge; Route::get("admin/profile", function () { // })->middleware(CheckAge::class);
3:中间件组
有时你可能想用单一的键为几个中间件分组,使其更容易分配到路由。可以使用 Kernel 类的 $middlewareGroups 属性来实现
protected $middlewareGroups = [ "web" => [ \App\Http\Middleware\EncryptCookies::class, \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, \Illuminate\Session\Middleware\StartSession::class, // \Illuminate\Session\Middleware\AuthenticateSession::class, \Illuminate\View\Middleware\ShareErrorsFromSession::class, \App\Http\Middleware\VerifyCsrfToken::class, \Illuminate\Routing\Middleware\SubstituteBindings::class, ], "api" => [ "throttle:60,1", "bindings", ], ];
可以使用与单个中间件相同的语法将中间件组分配给路由和控制器操作
Route::get("/", function () { // })->middleware("web"); Route::group(["middleware" => ["web"]], function () { // });
4:排序中间件
很少情况下,你可能需要中间件以特定的顺序执行,但是当它们被分配到路由时,你无法控制它们的顺序。在这种情况下,可以使用 app/Http/Kernel.php 文件的 $middlewarePriority 属性指定中间件优先级
protected $middlewarePriority = [ \Illuminate\Session\Middleware\StartSession::class, \Illuminate\View\Middleware\ShareErrorsFromSession::class, \App\Http\Middleware\Authenticate::class, \Illuminate\Routing\Middleware\ThrottleRequests::class, \Illuminate\Session\Middleware\AuthenticateSession::class, \Illuminate\Routing\Middleware\SubstituteBindings::class, \Illuminate\Auth\Middleware\Authorize::class, ];
5:中间件参数
中间件也可以接受额外的参数。例如,如果应用需要在运行特定操作前验证经过身份认证的用户是否具备给定的「角色」,你可以新建一个 CheckRole 中间件,由它来接收「角色」名称作为附加参数。
附加的中间件参数应该在 $next 参数之后被传递:
<?php namespace App\Http\Middleware; use Closure; class CheckRole { /** * 处理传入的请求 * * @param \Illuminate\Http\Request $request * @param \Closure $next * @param string $role * @return mixed */ public function handle($request, Closure $next, $role) { if (! $request->user()->hasRole($role)) { // 重定向... } return $next($request); } }
定义路由时通过一个 : 来隔开中间件名称和参数来指定中间件参数。多个参数就使用逗号分隔
Route::put("post/{id}", function ($id) { // })->middleware("role:editor");
6:Terminable 中间件
laravel 内置的「session」中间件会在响应发送到浏览器之后将会话数据写入存储器中。如果你在中间件中定义一个 terminate 方法,则会在响应发送到浏览器后自动调用
<?php namespace Illuminate\Session\Middleware; use Closure; class StartSession { public function handle($request, Closure $next) { return $next($request); } public function terminate($request, $response) { // Store the session data... } }
terminate 方法应该同时接收和响应。一旦定义了这个中间件,你应该将它添加到路由列表或 app/Http/Kernel.php 文件的全局中间件中
在你的中间件上调用 terminate 调用时,Laravel 会从 服务容器 中解析出一个新的中间件实例。如果要在调用 handle 和 terminate 方法时使用同一个中间件实例,就使用容器的 singleton 方法向容器注册中间件
到此这篇关于Laravel中间件的使用详解的文章就介绍到这了,更多相关Laravel中间件内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!