中间件
中间件主要用于拦截或过滤应用的HTTP
请求,并进行必要的业务处理。
新版部分核心功能使用中间件处理,你可以灵活关闭。包括Session功能、请求缓存和多语言功能。
定义中间件
使用中间件首先得创建中间件,可以通过cmd找到对应tp6项目路径,输入以下以下命令自动创建中间件目录及文件,这个指令会 app/middleware
目录下面生成一个Check
中间件。
php think make:middleware Check
<?php
namespace app\middleware;
class Check
{
public function handle($request, \Closure $next)
{
if ($request->param('name') == 'think') {
return redirect('index/think');
}
return $next($request);
}
}
中间件的入口执行方法必须是handle
方法,而且第一个参数是Request
对象,第二个参数是一个闭包。
中间件
handle
方法的返回值必须是一个Response
对象。
在这个中间件中我们判断当前请求的name
参数等于think
的时候进行重定向处理。否则,请求将进一步传递到应用中。要让请求继续传递到应用程序中,只需使用 $request
作为参数去调用回调函数 $next
前置/后置中间件
中间件是在请求具体的操作之前还是之后执行,完全取决于中间件的定义本身。
下面是一个前置行为的中间件
<?php
namespace app\middleware;
class Before
{
public function handle($request, \Closure $next)
{
// 添加中间件执行代码
return $next($request);
}
}
下面是一个后置行为的中间件
<?php
namespace app\middleware;
class After
{
public function handle($request, \Closure $next)
{
$response = $next($request);
// 添加中间件执行代码
return $response;
}
}
中间件方法同样也可以支持依赖注入。
定义中间件别名
可以直接在应用配置目录下的middleware.php
中先预定义中间件(其实就是增加别名标识),例如:
return [
'alias' => [
'auth' => app\middleware\Auth::class,
'check' => app\middleware\Check::class,
],
];
可以支持使用别名定义一组中间件,例如:
return [
'alias' => [
'check' => [
app\middleware\Auth::class,
app\middleware\Check::class,
],
],
];
注册中间件
新版的中间件分为全局中间件、应用中间件(多应用模式下有效)、路由中间件以及控制器中间件四个组。执行顺序分别为:
全局中间件->应用中间件->路由中间件->控制器中间件
全局中间件
全局中间件在app
目录下面middleware.php
文件中定义,使用下面的方式:
<?php
return [
\app\middleware\Auth::class,
'check',
'Hello',
];
中间件的注册应该使用完整的类名,如果已经定义了中间件别名(或者分组)则可以直接使用。
全局中间件的执行顺序就是定义顺序。可以在定义全局中间件的时候传入中间件参数,支持两种方式传入。
<?php
return [
[\app\http\middleware\Auth::class, 'admin'],
'Check',
['hello','thinkphp'],
];
上面的定义表示 给Auth
中间件传入admin
参数,给Hello
中间件传入thinkphp
参数。
应用中间件
如果你使用了多应用模式,则支持应用中间件定义,你可以直接在应用目录下面增加middleware.php
文件,定义方式和全局中间件定义一样,只是只会在该应用下面生效。
路由中间件
路由中间件声明方法:找到对应的路由文件(如route/app.php),在文件中定义,使用下面的方式,这样访问路径时便可以通过该中间件进行限制。
最常用的中间件注册方式是注册路由中间件
Route::rule('hello/:name','hello')
->middleware(\app\middleware\Auth::class);
Route::rule('hhh','test/index')->middleware(\app\middleware\Check2::class);
支持注册多个中间件
Route::rule('hello/:name','hello')
->middleware([\app\middleware\Auth::class, \app\middleware\Check::class]);
如果你希望某个路由中间件是全局执行(不管路由是否匹配),可以不需要在路由里面定义,支持直接在路由配置文件中定义,例如在config/route.php
配置文件中添加:
'middleware' => [
app\middleware\Auth::class,
app\middleware\Check::class,
],
这样,所有该应用下的请求都会执行Auth
和Check
中间件。
控制器中间件
支持为控制器定义中间件,只需要在控制器中定义middleware
属性,例如:
<?php
namespace app\controller;
class Index
{
protected $middleware = ['auth'];
public function index()
{
return 'index';
}
public function hello()
{
return 'hello';
}
}
当执行index
控制器的时候就会调用auth
中间件,一样支持使用完整的命名空间定义。
如果需要设置控制器中间的生效操作,可以如下定义:
<?php
namespace app\controller;
class Index
{
protected $middleware = [
'auth' => ['except' => ['hello'] ],
'check' => ['only' => ['hello'] ],
];
public function index()
{
return 'index';
}
public function hello()
{
return 'hello';
}
}
中间件向控制器传参
可以通过给请求对象赋值的方式传参给控制器(或者其它地方),例如
<?php
namespace app\middleware;
class Hello
{
public function handle($request, \Closure $next)
{
$request->hello = 'ThinkPHP';
return $next($request);
}
}
复制
然后在控制器的方法里面可以直接使用
public function index(Request $request)
{
return $request->hello; // ThinkPHP
}
内置中间件
新版内置了几个系统中间件,包括:
中间件类 | 描述 |
---|---|
think\middleware\AllowCrossDomain | 跨域请求支持 |
think\middleware\CheckRequestCache | 请求缓存 |
think\middleware\LoadLangPack | 多语言加载 |
think\middleware\SessionInit | Session初始化 |
think\middleware\FormTokenCheck | 表单令牌 |
这些内置中间件默认都没有定义,你可以在应用的middleware.php
文件中、路由或者控制器中定义这些中间件,如果不需要使用的话,取消定义即可。
~~~~~~~~~~~~~~~~~~~~~~~~~~~
一.中间件的定义和使用方法示例
1.1定义中间件
<?php
namespace app\index\middleware;
class Check
{
public function handle($request, \Closure $next)
{
echo '得到name=' . $request->param('name') . '<br>';
if ($request->param('name') == 'qipa250') {
echo '你好我是奇葩250';
} else {
echo '你好我不是奇葩250';
}
echo '<br>';
echo '走到app\index\middleware\Check类的handle方法了';
return $next($request);
}
}
1.2配置引入中间件
在app/middleware.php或者app/admin/middleware.php里添加如下代码:
<?php
return [
app\index\middleware\Check::class,
];
二.写一个登陆中间件的步骤
1.在项目的app/middleware目录下新建一个LoginMiddleware.php文件,编写如下代码:
<?php
namespace app\middleware;
use think\facade\Session;
use think\facade\Request;
use think\facade\Response;
class LoginMiddleware
{
public function handle(Request $request, \Closure $next)
{
// 判断用户是否登录
if (!Session::has('user')) {
return Response::create('请先登录', 'html', 401);
}
return $next($request);
}
}
2.在项目的config/middlware.php文件中添加中间件的别名和命名空间:
return [
'login' => \app\middleware\LoginMiddleware::class,
];
3.在需要验证登录的路由中使用中间件:
Route::get('/user/profile', 'UserController@profile')->middleware('login');
注意:此处假设UserController中的profile方法需要验证登录状态。
4.引用中间件
use app\middleware\LoginMiddleware;