Thinkphp6.0中间件的具体使用
作者:私域流量 时间:2024-04-30 08:47:21
目录
全局中间件
应用中间件
路由中间件
控制器中间件
中间件传参
6.0中间件分为系统中间件和应用中间件,系统中间件为核心框架内置的中间件,应用中间件是在应用里面创建的中间件。
中间件的主要应用场景可以包括对HTTP请求的数据过滤、权限检测、请求拦截等行为,使用中间件能够让控制器的定义更加简单,很多额外的非核心业务流程的处理都可以交给中间件执行。
从中间件的使用范围来看,可以分为全局中间件、应用中间件、控制器中间件和路由中间件。
全局中间件
全局中间件是在app\middleware.php中定义的中间件,默认没有启用任何中间件,但对支持的系统中间件做了注释,你只需要取消注释就可以使用相应的系统中间件,默认内容如下:
return [
// 全局请求缓存
// 'think\middleware\CheckRequestCache',
// 多语言加载
// 'think\middleware\LoadLangPack',
// Session初始化
// 'think\middleware\SessionInit',
// 页面Trace调试
// 'think\middleware\TraceDebug',
];
系统的部分功能交给中间件进行统一管理,包括全局请求缓存、多语言的自动检测和加载、Session初始化和页面Trace调试,也就是说,默认安装后的应用是不支持Session的,你必须全局开启Session初始化中间件后Session才能生效。对于API应用来说,本身就不需要Session功能支持。
你可以在全局中间件定义文件中添加你的应用中间件,但尽可能确保系统中间件的优先执行,中间件定义需要使用完整的类名,通过命令行指令可以快速创建一个应用中间件:
php think make:middleware Test
会自动生成一个app\middleware\Test中间件类,内容如下:
<?php
namespace app\middleware;
class Test
{
public function handle($request, \Closure $next)
{
}
}
也支持通过指定完整命名空间的方式创建中间件类
php think make:middleware app\middleware\Hello
我们添加一个测试输出
<?php
namespace app\middleware;
class Test
{
public function handle($request, \Closure $next)
{
echo 'Before Middleware<br/>';
$response = $next($request);
echo 'After Middleware<br/>';
return $response;
}
}
中间件handle方法的返回值必须是一个Response对象。
然后在全局中间件定义中添加
return [
\app\middleware\Test::class,
];
假设我们要访问的控制器方法为
<?php
namespace app\controller;
class Index
{
public function hello()
{
return 'Hello,ThinkPHP!<br/>';
}
}
访问该操作方法的输出为
Before Middleware
Hello,ThinkPHP!
After Middleware
你可以看出中间件的执行过程,从执行流程上可以分为前置中间件和后置中间件,当然,一个中间件可能同时有前置和后置行为,上面的Test中间件就是如此。 $next($request)之前的代码属于前置中间件范畴,之后的代码则属于后置中间件范畴。
应用中间件
如果是多应用模式的话,应用中间件就是在app\应用名\middleware.php中定义的中间件,只会在该应用下有效,定义格式和全局中间件一致。
路由中间件
路由中间件则表示仅在路由匹配之后才会执行某个中间件,在路由定义中使用middleware方法定义,例如:
Route::get('hello/:name','index/hello')
->middleware(\app\middleware\Hello::class);
可以给路由分组定义中间件
Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware(\app\middleware\Hello::class);
如果要执行多个中间件,可以使用
Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware([\app\middleware\Hello::class,\app\middleware\Check::class]);
对于经常要使用的中间件,我们可以定义一个别名,在config\middleware.php配置文件中,设置
return [
'hello' => \app\middleware\Hello::class,
'check' => \app\middleware\Check::class,
];
路由定义可以改为:
Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware(['hello','check']);
支持给一组中间件定义别名
return [
'test' => [\app\middleware\Hello::class,\app\middleware\Check::class],
];
路由定义可以改为
Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware('test');
中间件支持传入一个参数,中间件定义如下
<?php
namespace app\middleware;
class Hello
{
public function handle($request, \Closure $next, string $name = '')
{
echo 'Hello'. $name . '<br/>';
return $next($request);
}
}
可以在路由中间件的第二个参数传入name参数
Route::get('hello/:name','index/hello')
->middleware('hello', 'middleware');
除了支持参数外,你可以在中间件的handle方法中使用依赖注入。
控制器中间件
控制器中间件仅当访问某个控制器的时候生效
<?php
namespace app\controller;
class Hello
{
protected $middleware = ['hello','check'];
public function index()
{
return 'Hello,ThinkPHP!<br/>';
}
}
由于前面已经定义了中间件别名,所以这里直接使用别名定义,否则你必须使用完整的命名空间定义。
默认情况下,控制器中定义的中间件访问控制器的任何操作方法都会执行,有时候并不希望所有的操作都需要执行中间件,有两种方式来定义控制器中间件的执行过滤。
<?php
namespace app\controller;
class Index
{
protected $middleware = [
'hello' => ['only' => ['hello']],
'check' => ['except'=> ['hello']],
];
public function hello()
{
return 'Hello,ThinkPHP!<br/>';
}
public function check()
{
return 'this action require check!<br/>';
}
}
hello中间件仅在执行Index控制器的hello操作的时候才会执行,而check中间件除了hello方法外,都会执行,具体效果你可以实际测试下。
中间件传参
中间件和控制器之间传参的方式有很多,一个简单的方法是使用Request来进行传参。
<?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
}
来源:https://blog.csdn.net/maysh2008/article/details/106357578