Lithe 的中间件:它是如何工作的以及如何创建自己的中间件
中间件提供了一种方便的机制来检查和过滤进入应用程序的 http 请求。例如,lithe 包含用于检查应用程序用户是否经过身份验证的中间件。如果用户未经过身份验证,中间件会将用户重定向到应用程序的登录屏幕。但是,如果用户经过身份验证,中间件将允许请求在应用程序内继续进行。
中间件在 lithe 中的工作原理
在 lithe 中,中间件是可以访问应用程序请求响应循环中的请求对象 ($req)、响应对象 ($res) 和 $next 函数的函数。 $next 函数是 lithe 路由器中的一个函数,调用时会执行当前中间件旁边的中间件。
中间件函数提供了一种方便的机制来检查、过滤和处理进入应用程序的 http 请求。
中间件函数可以执行以下任务:
如果当前中间件函数没有结束请求-响应周期,则必须调用 $next() 将控制权传递给下一个中间件函数。否则,请求将被等待处理。
中间件功能的元素
以下代码显示了中间件函数调用的元素:
$app->use(function ($req, $res, $next) { $next();});
地点:
- $req:中间件函数的 http 请求参数,按照惯例称为“$req”。
- $res:中间件函数的 http 响应参数,按照惯例称为“$res”。
- $next:中间件函数的回调参数,按照惯例称为“$next”。
定义中间件
让我们从一个名为 mylogger 的简单中间件示例开始。每次请求通过该中间件时,该中间件都会打印 logged 消息。中间件被定义为分配给名为 mylogger 的变量的函数:
$mylogger = function ($req, $res, $next) { echo 'logged'; $next();};
注意上面对 $next() 的调用。调用此函数会调用应用程序中的下一个中间件函数。 $next() 函数不是 php 或 lithe 的一部分,但它是传递给中间件函数的第三个参数。 $next() 函数可以有任何名称,但按照惯例,它始终称为“next”。为了避免混淆,请始终使用此约定。
最好将中间件视为 http 请求在到达应用程序之前必须经过的一系列“层”。每一层都可以检查请求,甚至完全拒绝它。
加载中间件
要加载中间件函数,您可以调用 litheapp 类的 use() 方法,并指定所需的中间件函数。例如,以下代码在执行到根路径(/)的路由之前加载 mylogger 中间件函数:
$app = new lithepp;$mylogger = function ($req, $res, $next) { echo 'logged'; $next();};$app->use($mylogger);$app->get('/', function ($req, $res, $next) { $res->send('hello world!');});
每当应用程序收到请求时,它都会打印消息“logged”。
中间件加载顺序很重要:先加载的中间件函数也会先执行。
mylogger 中间件函数只是打印一条消息,然后通过调用 $next() 函数将请求传递给堆栈上的下一个中间件函数。
使用中间件
lithe 应用程序可以使用以下类型的中间件:
应用层中间件
使用 use() 和 method() 方法将应用程序级中间件绑定到应用程序对象的实例,其中 method 是中间件函数处理的请求的 http 方法(例如 get、put 或 post)小写。
此示例显示了一个没有汇编路径的中间件函数。每次应用程序收到请求时都会执行该函数。
$app->use(function ($req, $res, $next) { echo 'hello world!'; $next();});
下面的示例显示了一个处理路径 /user/:id 中的 get 请求的中间件。
$app->get('/user/:id', function ($req, $res, $next) { // se o id do usuário for '0', passa para o próximo middleware if ($req->param('id') === '0') { return $next(); } // caso contrário, envia uma resposta específica $res->send('id não é 0');}, function ($req, $res) { // envia uma resposta quando o id for '0' $res->send('regular');});
路由器级中间件
路由器级中间件的工作方式与应用程序级中间件相同,只是它绑定到 lithehttprouter 的实例。
$router = new lithehttpouter;
使用 use 和 method 函数加载路由器级中间件。
以下示例代码展示了使用路由器级中间件的中间件系统:
$router = new lithehttpouter;// middleware de nível de roteador para todas as rotas do roteador$router->use(function ($req, $res, $next) { echo 'time: ', date('h:i:s'), '<br>'; $next();});$router->get('/user/:id', function ($req, $res, $next) { // verifica se o id do usuário é '0'; se for, redireciona para / if ($req->param('id') === '0') { $res->redirect('/'); } // caso contrário, passa o controle para o próximo middleware na pilha $next()}, function ($req, $res, $next) { echo $req->param('id'); $res->render('special');});// monta o roteador na aplicação$app->use('/api', $router);
第三方中间件
使用第三方中间件为 lithe 应用程序添加功能。
安装所需功能所需的 php 模块,然后在应用程序级别或路由器级别将其加载到您的应用程序中。
以下示例说明了加载会话中间件,即 lithemiddlewaresessionsession 函数。
use function lithemiddlewaresessionsession;$app = new lithepp;$app->use(session([ 'secure' => true]));
lithe 常用的第三方中间件功能的部分列表,请参阅:第三方中间件。
可配置的中间件
如果您需要可配置的中间件,请创建一个接受选项数组或其他参数的函数,然后根据输入参数返回中间件实现。
<?phpfunction my_middleware ($options) { return function ($req, $res, $next) use ($options) { // implementação do middleware com base na array de opções // chama o próximo middleware $next(); };};
现在可以使用中间件了,如下所示。
$app->use(my_middleware(['option1' => '1', 'option2' => '2']));