Thinkphp6.0中间件的具体使用

admin3年前 (2023-05-20)PHP教程25

系统的部分功能交给中间件进行统一管理，包括全局请求缓存、多语言的自动检测和加载、Session初始化和页面Trace调试，也就是说，默认安装后的应用是不支持Session的，你必须全局开启Session初始化中间件后Session才能生效。对于API应用来说，本身就不需要Session功能支持。

你可以在全局中间件定义文件中添加你的应用中间件，但尽可能确保系统中间件的优先执行，中间件定义需要使用完整的类名，通过命令行指令可以快速创建一个应用中间件：

1	`php think make:middleware Test`

会自动生成一个app\middleware\Test中间件类，内容如下：

1
2
3
4
5
6
7
8
9
10 <?php

namespace app\middleware;

class Test
{
public function handle($request, \Closure $next)
{
}
}

也支持通过指定完整命名空间的方式创建中间件类

1	`php think make:middleware app\middleware\Hello`

我们添加一个测试输出

1
2
3
4
5
6
7
8
9
10
11
12
13
14 <?php

namespace app\middleware;

class Test
{
public function handle($request, \Closure $next)
{
echo 'Before Middleware ';
$response = $next($request);
echo 'After Middleware ';
return $response;
}
}

中间件handle方法的返回值必须是一个Response对象。

然后在全局中间件定义中添加

1
2
3 return [
\app\middleware\Test::class,
];

假设我们要访问的控制器方法为

1
2
3
4
5
6
7
8
9
10
11 <?php

namespace app\controller;

class Index
{
public function hello()
{
return 'Hello,ThinkPHP! ';
}
}

访问该操作方法的输出为

Before Middleware
Hello,ThinkPHP!
After Middleware

你可以看出中间件的执行过程，从执行流程上可以分为前置中间件和后置中间件，当然，一个中间件可能同时有前置和后置行为，上面的Test中间件就是如此。 $next($request)之前的代码属于前置中间件范畴，之后的代码则属于后置中间件范畴。

应用中间件

如果是多应用模式的话，应用中间件就是在app\应用名\middleware.php中定义的中间件，只会在该应用下有效，定义格式和全局中间件一致。

路由中间件

路由中间件则表示仅在路由匹配之后才会执行某个中间件，在路由定义中使用middleware方法定义，例如：

1 2	`Route::get('hello/:name','index/hello')` `->middleware(\app\middleware\Hello::class);`

可以给路由分组定义中间件

1
2
3
4 Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware(\app\middleware\Hello::class);

如果要执行多个中间件，可以使用

1
2
3
4 Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware([\app\middleware\Hello::class,\app\middleware\Check::class]);

对于经常要使用的中间件，我们可以定义一个别名，在config\middleware.php配置文件中，设置

1
2
3
4 return [
'hello' => \app\middleware\Hello::class,
'check' => \app\middleware\Check::class,
];

路由定义可以改为：

1
2
3
4 Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware(['hello','check']);

支持给一组中间件定义别名

1
2
3 return [
'test' => [\app\middleware\Hello::class,\app\middleware\Check::class],
];

路由定义可以改为

1
2
3
4 Route::group(function(){
Route::get('hello/:name','index/hello');
//...
})->middleware('test');

中间件支持传入一个参数，中间件定义如下

1
2
3
4
5
6
7
8
9
10
11
12 <?php

namespace app\middleware;

class Hello
{
public function handle($request, \Closure $next, string $name = '')
{
echo 'Hello'. $name . ' ';
return $next($request);
}
}

可以在路由中间件的第二个参数传入name参数

1 2	`Route::get('hello/:name','index/hello')` `->middleware('hello',` `'middleware');`

除了支持参数外，你可以在中间件的handle方法中使用依赖注入。

控制器中间件

控制器中间件仅当访问某个控制器的时候生效

1
2
3
4
5
6
7
8
9
10
11
12
13 <?php

namespace app\controller;

class Hello
{
protected $middleware = ['hello','check'];

public function index()
{
return 'Hello,ThinkPHP! ';
}
}

由于前面已经定义了中间件别名，所以这里直接使用别名定义，否则你必须使用完整的命名空间定义。

默认情况下，控制器中定义的中间件访问控制器的任何操作方法都会执行，有时候并不希望所有的操作都需要执行中间件，有两种方式来定义控制器中间件的执行过滤。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 <?php

namespace app\controller;

class Index
{
protected $middleware = [
'hello' => ['only' => ['hello']],
'check' => ['except'=> ['hello']],
];

public function hello()
{
return 'Hello,ThinkPHP! ';
}

public function check()
{
return 'this action require check! ';
}
}

hello中间件仅在执行Index控制器的hello操作的时候才会执行，而check中间件除了hello方法外，都会执行，具体效果你可以实际测试下。

中间件传参

中间件和控制器之间传参的方式有很多，一个简单的方法是使用Request来进行传参。

1
2
3
4
5
6
7
8
9
10
11
12
13 <?php

namespace app\middleware;

class Hello
{
public function handle($request, \Closure $next)
{
$request->hello = 'ThinkPHP';

return $next($request);
}
}