一、什么是中间件?
通过之前对路由和控制器的学习,我们知道一个请求可以通过路由分配到某个控制器上然后进行处理,如果我们想对请求加一个限制,只允许某些请求能够到达控制器,而过滤掉我们不想要的请求,这时候就可以使用 Laravel 的中间件。
例如,Laravel 自带的 Auth 中间件可以用来验证用户的身份,如果用户未通过身份验证,中间件将会把用户导向登录页面,反之,当用户通过了身份验证,中间件将会通过此请求并接着往下执行。
当然了,除了验证,中间件也可以完成其他的各种各样的任务,如:CORS 中间件负责替所有即将离开程序的响应加入适当的标头;而日志中间件则可以记录所有传入应用程序的请求。
Laravel 框架已经内置了一些中间件,包括维护、身份验证、CSRF 保护,等等。所有的中间件都放在 app/Http/Middleware 目录内。
除了 Laravel 内置的中间件以外,我们也可以根据自己的需要创建中间件。
二、创建中间件
下面我们通过一个简单的例子来体会一下 midddleware 的工作过程。
思路如下:
- 创建一个带参路由,用来产生一个请求,并且附带一个 age 参数;
- 创建一个简单的中间件,用来过滤掉 age > 25 的用户,来实现一个简单的中间件过滤;
- 未通过中间件的请求将被重定向到主页;
- 通过中间件的的请求将达到指定的控制器,实现相应动作。
首先创建带参路由:
app/Http/routes.php
<?php
Route::get('/', function () {
return view('welcome');
});
Route::get('/young/{age}','UserController@young');
根据我们的思路:
• age > 25的路由如 网址/young/56 应该被过滤
• age <= 25的路由如 网址/young/18 应该被通过
然后创建中间件,我们使用 artisan 来创建:
cd ~/Code/myweb
php artisan make:middleware YoungMiddleware
此命令将会在 app/Http/Middleware 目录内创建一个名称为 YoungMiddleware 的中间件。
在这个中间件内我们只允许请求的年龄 age 变量小于 25 时才能访问路由,否则,我们会将用户重定向到首页。
打开这个中间件:
app/Http/Middleware/YoungMiddleware.php
<?php
namespace App\Http\Middleware;
use Closure;
class YoungMiddleware
{
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
return $next($request);
}
默认生成的中间件代码是没做任何过滤的,也就是说任何请求都会通过。
下面我们加入我们的过滤代码:
<?php
namespace App\Http\Middleware;
use Closure;
class YoungMiddleware
{
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
// 如果传入的参数 age 大于25,重定向到'/'
if ($request->age > 25) {
return redirect('/');
}
return $next($request);
}
至此,中间件创建完成。
三、注册并添加中间件
中间件创建好后,还需要注册并添加到相应的路由上,才能工作。
注册中间件:
打开 app/Http/Kernel.php
app/Http/Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
/**
* The application's global HTTP middleware stack.
*
* @var array
*/
protected $middleware = [
\Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
\App\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\App\Http\Middleware\VerifyCsrfToken::class,
];
/**
* The application's route middleware.
*
* @var array
*/
protected $routeMiddleware = [
'auth' => \App\Http\Middleware\Authenticate::class,
'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
];
}
如果你希望每个 HTTP 请求都经过一个中间件,只要将该中间件的类加入到 app/Http/Kernel.php 的 middleware属性清单列表中。如果你要指派中间件给特定路由,就要将该中间件的类加入到app/Http/Kernel.php的middleware属性清单列表中。如果你要指派中间件给特定路由,就要将该中间件的类加入到app/Http/Kernel.php的routeMiddleware 属性清单列表中,并给这个中间件起一个名字。
因为我们这里只需要对我们本节实验开始创建的路由添加这个中间件,所以我们修改代码如下:
app/Http/Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
/**
* The application's global HTTP middleware stack.
*
* @var array
*/
protected $middleware = [
\Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
\App\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\App\Http\Middleware\VerifyCsrfToken::class,
//如果需要全局中间件在这里注册
];
/**
* The application's route middleware.
*
* @var array
*/
protected $routeMiddleware = [
'auth' => \App\Http\Middleware\Authenticate::class,
'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
//在这里添加了一行
'young' => \App\Http\Middleware\YoungMiddleware::class,
];
}
注册完成后,我们回到routes.php文件中为路由添加中间件。
打开 app/Http/routes.php 修改代码:
app/Http/routes.php
<?php
Route::get('/young/{age}', 'UserController@young')->middleware('young');
这里注意后面添加部分!!!
至此,一个简单的中间件就完成了!
此时,根据我们之前的思路:
• age > 25 的路由如 网址/young/56 应该会被重定向到 ‘/’
• age <= 25 的路由如 网址/young/18 应该会通过中间件,到达控制器UserController@young
最后,完成控制器部分的代码。
使用 artisan 命令创建一个控制器:
php artisan make:controller UserController --plain
添加 –plain 后缀可以不生成默认的空方法。
打开app/Http/Controllers/UserController.php,添加young()方法:
app/Http/Controllers/UserController.php
<?php
class UserController extends Controller
{
public function young(){
return 'I`m young!';
}
}
至此,所有的代码都完成了,打开浏览器测试一下效果。
访问 localhost/young/18 成功显示
个人总结:
中间件用于过滤 首先在原来的控制器、路由是不用修改的,增加过滤只要指向中间件就好了,这里框架里为了增加可读性而增加了kernel,可以注册,也就是给原来中间件的位置起一个别名
形式如下:Route::get(‘/young/{age}’, ‘Mycontroller@young’)->middleware(‘young’);
中间件的书写方式:
1、创建中间件 app/Http/Middleware下创建中间件文件
2、注册并添加中间件 app/Http/Kernel.php文件中注册中间件
3、修改routes app/Http/routes.php