从零开始编写一个PHP框架 系列的《中间件模块》
项目地址：terse
前言
先说一下个人的见解，如有错误，请谅解并指出。
其实在写中间件的时候，我很纠结。因为我认为中间件能干的事情，其实事件管理器也是可以做的，但是为什么还是要有中间件这么一个模块呢？
事后想了想，作用域不同吧。
对于事件管理器而言，它是贯穿整个系统的。而中间件，它就像门卫，可以对进入的请求进行管理，也可以对于出去的结果进行筛选。
自己的想法到此结束，下面开始说说关于中间件的事情。
调研和思考
之前没有写过关于中间件相关的东西，对于中间件的理解停留在“先执行，后执行”的层面上。于是在写之前，看了一下关于中间件的文档，和各个框架中间件的对比，其中主要看了 laravel 和 tp5.1。
这里推荐一篇文章，说了几个框架的中间件的不同，当然，作者的言论并非完全正确，各人各异，传送门。
话不多说，看了 laravel 和 tp5.1 的实现后，还是忍不住将 laravel 的 pipeline 个偷窃了过来。
对的，就是偷窃，关于这点，毫不避嫌。没办法... pipeline 是写的真好！！！
为什么直接忽略 tp5.1 的思路呢，关于这点，很简单，laravel 使用了后绑定的方式，而 tp5.1 却是直接实例化，虽然是单线程，但是谁又能保证，这个会一直执行下去呢？
目录结构
.
├── Http
│ ├── Interfaces
│ │ └── Middleware.php [接口类]
│ └── Pipeline.php [管道类]
└── Mvc
└── Middleware.php [调度类]
实现
废话说了一堆，也要开始实现了。
根据上面的目录结构，主要要实现三个类：接口类、调度类、管道类。
接口类
由于实现的比较简单，这里只需要每个中间件都实现 handle 方法就可以。
关于 handle，这个在 laravel 里是可以自定义的。我这里直接规定了这个方法名，不以规矩不成方圆嘛。
<?php
/**
* Middleware interface
*/
interface Middleware
{
public function handle($possable, $next);
}
调度类
关于调度类的实现，这里先要说一下另一个想法。
因为我想要实现的中间件和事件管理器有点类似，中间件是有不同类别的，也就是说，可以看一下下面的配置。
[
'middleware' => [
'route' => [
\App\Middleware\Filter::class
],
'app' => [
\App\Middleware\Auth::class
]，
// more...
]
]
也就是说，中间件是有不同层别的，而且可以有包含关系，比如 app 是框架级别的，而 route 只是针对路由级别。
可能这个设计没什么意义，但是既然做了，就多做了一点，可以简用嘛。当然，这个在框架里还没有埋点。(尴尬)
从上面的想法来看，为了方面管理这些中间件，调度类需要实现几个功能：set(array $middlewares)、get($type = null)、remove($type)、clear()
<?php
/**
* Middleware
*/
class Middleware
{
/**
* 中间件
*
* @var array
*/
protected $middlewares = [];
/**
* 获取中间件列表
*
* @param string $type
* @return array
*/
public function get($type = null)
{
if ($type) {
return isset($this->middlewares[$type]) ? $this->middlewares[$type] : [];
}
return $this->middlewares;
}
/**
* 设置中间件
*
* @param array $middlewares
*/
public function set(array $middlewares)
{
if (!$middlewares) {
return $this;
}
$result = $this->middlewares;
foreach ($middlewares as $type => $middleware) {
if (isset($result[$type])) {
array_merge($result[$type], $middleware);
continue;
}
$result[$type] = $middleware;
}
$this->middlewares = $result;
return $this;
}
/**
* 移除某一类中间件
*
* @param string $type
* @return boolean
*/
public function remove($type)
{
if (isset($this->middlewares[$type])) {
unset($this->middlewares[$type]);
}
return true;
}
/**
* 清空中间件
*
* @return boolean
*/
public function clear()
{
$this->middlewares = [];
}
}
这个类的主要功能还是调度，dispatch 肯定是少不了的。
/**
* 调度
* @param \Closure $possable
* @param \Closure $then
* @param string $type
* @return mixed
*/
public function dispatch(\Closure $possable, \Closure $then, $type)
{
$middlewares = $this->middlewares;
$middleware = isset($middlewares[$type]) ? $middlewares[$type] : [];
return (new Pipeline())->send($possable)->through($middleware)->then($then);
}
管道类
laravel 的管道类，支持的方式比较多，这里只支持 方法、类 和 类命名空间。
关于 pipeline 的解析，可以参考这篇文章(作者用心了)：传送门
<?php
/**
* Pipeline
*/
class Pipeline
{
/**
* 中间件
*
* @var array
*/
protected $middlewares = [];
protected $possable = null;
/**
* 设置需要用的对象
*
* @param mixed $possable
* @return $this
*/
public function send($possable)
{
$this->possable = $possable;
return $this;
}
/**
* 设置中间件
*
* @param array $middlewares
* @return $this
*/
public function through(array $middlewares)
{
$this->middlewares = $middlewares;
return $this;
}
/**
* 执行
*
* @param \Closure $destination
* @return mixed
*/
public function then(\Closure $destination)
{
$pipeline = array_reduce(array_reverse($this->middlewares), $this->carry(), $this->prepareDestination($destination));
return $pipeline($this->possable);
}
/**
* 最后执行的一步
* @param \Closure $destination
* @return \Closure
*/
protected function prepareDestination(\Closure $destination)
{
return function ($possable) use ($destination) {
return $destination($possable);
};
}
/**
* 回调函数
* @return \Closure
*/
protected function carry()
{
return function ($stack, $pipe) {
return function ($possable) use ($stack, $pipe) {
if (is_callable($pipe)) {
return $pipe($possable, $stack);
}
if (is_object($pipe)) {
$params = [$possable, $stack];
} elseif (class_exists($pipe)) {
$params = [$possable, $stack];
$class = new \ReflectionClass($pipe);
$pipe = $class->newInstanceArgs([]);
} else {
throw new \Exception('pipe 不支持', -__LINE__);
}
return call_user_func_array([$pipe, 'handle'], $params);
};
};
}
}
调用方式示例
$middlewareCls = (new Middleware())->set($config);
$middlewareCls->dispatch(function () {
echo 'this is previous' . PHP_EOL;
}, function ($possable) {
$possable();
echo 'this is after' . PHP_EOL;
}, 'test');
最后
下一篇《响应模块》。
