onRequest 事件(即收到请求事件)

使用场景及原理

当 EasySwoole 收到任何的 HTTP 请求时，均会执行该事件。可以使用该事件可以对 HTTP 请求全局拦截，包括对请求进行允许跨域等操作。

使用方式说明

框架对 onRequest 事件的实现在 3.4.x 及以后的版本 中做了新的改动，实现方式由原来旧版本在主服务创建事件(mainServerCreate 事件)中定义改变为在 initialize 事件 中使用 Di 方式注入。目前最新稳定版本框架(3.4.x)，具体实现及使用方式 (在 EasySwooleEvent.php 中的 initialize 事件中注入) 如下：

  1. <?php
  3. namespace EasySwoole\EasySwoole;
  5. use EasySwoole\EasySwoole\AbstractInterface\Event;
  6. use EasySwoole\EasySwoole\Swoole\EventRegister;
  8. class EasySwooleEvent implements Event
  9. {
  10.     public static function initialize()
  11.     {
  12.         date_default_timezone_set('Asia/Shanghai');
  14.         // 实现 onRequest 事件
  15.         \EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::HTTP_GLOBAL_ON_REQUEST, function (\EasySwoole\Http\Request $request, \EasySwoole\Http\Response $response): bool {
  16.             ###### 对请求进行拦截 ######
  17.             // 不建议在这拦截请求，可增加一个控制器基类进行拦截
  18.             // 如果真要拦截，判断之后 return false; 即可
  19.             /*
  20.             $code = $request->getRequestParam('code');
  21.             if (0){ // empty($code)验证失败
  22.                 $data = array(
  23.                     "code" => \EasySwoole\Http\Message\Status::CODE_BAD_REQUEST,
  24.                     "result" => [],
  25.                     "msg" => '验证失败'
  26.                 );
  27.                 $response->write(json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
  28.                 $response->withHeader('Content-type', 'application/json;charset=utf-8');
  29.                 $response->withStatus(\EasySwoole\Http\Message\Status::CODE_BAD_REQUEST);
  30.                 return false;
  31.             }
  32.             return true;
  33.             */
  35.             ###### 处理请求的跨域问题 ######
  36.             $response->withHeader('Access-Control-Allow-Origin', '*');
  37.             $response->withHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS');
  38.             $response->withHeader('Access-Control-Allow-Credentials', 'true');
  39.             $response->withHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization, X-Requested-With');
  40.             if ($request->getMethod() === 'OPTIONS') {
  41.                 $response->withStatus(\EasySwoole\Http\Message\Status::CODE_OK);
  42.                 return false;
  43.             }
  44.             return true;
  45.         });
  46.     }
  48.     public static function mainServerCreate(EventRegister $register)
  49.     {
  51.     }
  52. }

旧版本(3.4.x 之前版本)框架的 onRequest 事件的实现如下所示：

  1. <?php
  3. namespace EasySwoole\EasySwoole;
  5. use EasySwoole\EasySwoole\Swoole\EventRegister;
  6. use EasySwoole\EasySwoole\AbstractInterface\Event;
  7. use EasySwoole\Http\Request;
  8. use EasySwoole\Http\Response;
  10. class EasySwooleEvent implements Event
  11. {
  12.     public static function initialize()
  13.     {
  14.         // TODO: Implement initialize() method.
  15.         date_default_timezone_set('Asia/Shanghai');
  16.     }
  18.     public static function mainServerCreate(EventRegister $register)
  19.     {
  21.     }
  23.     // 注册 onRequest 事件回调
  24.     public static function onRequest(Request $request, Response $response): bool
  25.     {
  26.         ###### 对请求进行拦截 ######
  27.         // 不建议在这拦截请求，可增加一个控制器基类进行拦截
  28.         // 如果真要拦截，判断之后 return false; 即可
  29.         /*
  30.         $code = $request->getRequestParam('code');
  31.         if (0){ // empty($code)验证失败
  32.             $data = array(
  33.                 "code" => \EasySwoole\Http\Message\Status::CODE_BAD_REQUEST,
  34.                 "result" => [],
  35.                 "msg" => '验证失败'
  36.             );
  37.             $response->write(json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
  38.             $response->withHeader('Content-type', 'application/json;charset=utf-8');
  39.             $response->withStatus(\EasySwoole\Http\Message\Status::CODE_BAD_REQUEST);
  40.             return false;
  41.         }
  42.         return true;
  43.         */
  45.         ###### 处理请求的跨域问题 ######
  46.         $response->withHeader('Access-Control-Allow-Origin', '*');
  47.         $response->withHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS');
  48.         $response->withHeader('Access-Control-Allow-Credentials', 'true');
  49.         $response->withHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization, X-Requested-With');
  50.         if ($request->getMethod() === 'OPTIONS') {
  51.             $response->withStatus(\EasySwoole\Http\Message\Status::CODE_OK);
  52.             return false;
  53.         }
  54.         return true;
  55.     }
  56. }

注意事项

若在该事件中，执行 $response->end()，则该次请求不会进入路由匹配阶段。