[FEATURE] 增加 RequestHandled 事件

[gokure]

Is your feature request related to a problem? Please describe.
当开发 hyperf-cors 或者 hyperf-http-logger 等扩展时，需要同时对正常请求和异常结果进行包装，因为没有一个请求完毕的最终结果事件，需要增加ExceptionHandler来处理异常情况，同时还要说明让其异常处理器的顺序，例如想定义一个收集异常结果的日志，就要将这个异常处理器放在返回异常结果的后面，并且不能stopPropagation()。

Describe the solution you'd like
即与上面所述，建议在处理完正常请求和异常请求包装完响应之后，增加 RequestHandled 事件来处理最终响应结果，类似于Laravel的RequestHandled事件

Additional context
在 Hyperf\HttpServer\Server 类的 onRequest() 方法 finally 块中增加类似如下代码：

...
} finally {
    if ($container->has(EventDispatcherInterface::class)) {
        $eventDispatcher = $container->get(EventDispatcherInterface::class);
        $eventDispatcher->dispatch(new RequestHandled($psr7Request, $psr7Response));
    }
    ...
}

[limingxinleo]

你写个中间件，自己加个这个 事件 就行了

[gokure]

如上所述，要获取异常后处理的响应Body内容，作为扩展里提供的异常处理器，只能让用户将异常处理器放在exceptions.php的最下面，但如果更高优先级的异常处理器中终止了事件冒泡，即$this-> stopPropagation()，后面的异常处理器也就不会执行，进而无法获取异常的Body内容了。

而这个事件是在处理完所有的中间件，控制器方法和异常之后，在即将包装成SwooleResponse前触发的。

[limingxinleo]

放到Middleware里不行？

[gokure]

放到Middleware里不行？
简单的回答：不友好，且在Middleware里catch的结果也不是最终的Response。

或许我还是没用表达清楚，通过异常处理器（ExceptionHandler）将异常转换成Response，用户可以配置多个异常处理器进行修改Response的Headers或者Body，如果不是在最后一个ExceptionHandler，是获取不全完整的Response，如果Hyperf框架提供了相关的核心事件，对于开发者来说就会很容器提供诸如记录请求和响应的功能。

最终用户可以通过编程将需要的功能添加到最后的异常处理器中，但作为开发者的扩展，这样就很不友好了。

[limingxinleo]

暂不考虑增加这个事件，你可以直接重写 Hyperf\HttpServer\Server 来处理

[limingxinleo]

直接重洗 Hyperf\HttpServer\ResponseEmitter 也可以，Request 从上下文里拿。不过这个 Request 有可能是被代码修改过的

[gokure]

我只是提个建议，Hyperf团队考虑即可，作为开发者和贡献者，都是在为框架繁荣做贡献，为最终用户提供便利，目前我可以提供说明让最终用户将ExceptionHandler放置最末尾以支持获取Response响应的Body，也可以通过该谢Server类的onRequest方法来hack，但都有成本，最框架的维护和入侵性也更重。

Hyperf团队可以考虑将来是否增加该特征。

[liumingzhij26]

我觉得这个提议不错，希望能增加OnRequest,OnResponse 事件，目前我们就是使用直接重写 Hyperf\HttpServer\Server 来处理，类似下面代码

class HttpServer extends \Hyperf\HttpServer\Server
{

    /**
     * @Inject
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    public function onRequest(SwooleRequest $request, SwooleResponse $response): void
    {
        // 利用协程上下文存储请求开始的时间，用来计算程序执行时间
        Context::set('execution_start_time', microtime(true));
        parent::onRequest($request, $response);
        $this->eventDispatcher->dispatch(new OnRequest($request, $response));
    }
}

埋 OnResponse 好麻烦，要处理多个地方，http,rpc 还不一样。

ResponseEmitter 有点麻烦，我使用了 class_map 重写

[limingxinleo]

@liumingzhij26 直接 class_map 重写吧，这块大概率是不会改的，本来设计的 OnRequest 就是可拆卸的，没必要所有的逻辑都放到官方实现的 HttpServer 里

[limingxinleo]

@liumingzhij26 另外给你提个建议

$this->eventDispatcher->dispatch(new OnRequest($request, $response));

这段代码最好改成下面

try{
$this->eventDispatcher->dispatch(new OnRequest($request, $response));
}catch(\Throwable){}

[limingxinleo]

也可以试试，写一个中间件，放在所有中间件前面，然后 defer 来处理。

就不会存在这些问题了

[wilbur-yu]

也可以试试，写一个中间件，放在所有中间件前面，然后 defer 来处理。

就不会存在这些问题了

我按您这个方法试了一下, 也看了您个人仓库 https://github.com/limingxinleo/hyperf-utils 中的DebugDeferMiddleware中间件,
在我项目中没有成功, 上下文获取的 Psr\Http\Message\ResponseInterface 的实例方法 getBody() 为空,
然后我调整了下,
DebugDeferMiddleware.php

	// 省略不重要部分
	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $time = microtime(true);

        defer(function () use ($time, $request) {
            try {
                $this->log($time, $request);
            } catch (Throwable) {
            }
        });

        return $handler->handle($request);
    }

    protected function log(float $startTime, ?ServerRequestInterface $request): void
    {
        $logger = Log::get('request');
        $response = Context::get(ResponseInterface::class);
        // 日志
        $time = microtime(true) - $startTime;
        $debug = 'URI: '.$request?->getUri()->getPath().PHP_EOL;
        $debug .= 'TIME: '.$time.PHP_EOL;
        if ($customData = $this->getCustomData()) {
            $debug .= 'DATA: '.$customData.PHP_EOL;
        }
        if (isset($request)) {
            $debug .= 'REQUEST_HEADERS: '.Json::encode($request->getHeaders()).PHP_EOL;
            $debug .= 'REQUEST_BODY: '.$this->getRequestString($request).PHP_EOL;
        }

        if (isset($response)) {
            $debug .= 'RESPONSE: '.$this->getResponseString($response).PHP_EOL;
        }

        if ($time > 1) {
            $logger->error($debug);
        } else {
            $logger->info($debug);
        }
    }

自定义的Response.php

use Hyperf\HttpServer\Contract\ResponseInterface;
use Psr\Http\Message\ResponseInterface as PsrResponseInterface;
class Response {
	protected ResponseInterface $response;
	public function __construct(protected ContainerInterface $container)
    {
        $this->response = $container->get(ResponseInterface::class);
    }
	// 省略不重要部分
    protected function formatting(
        int $code,
        string $message,
        int $status = BusCode::SUCCESS,
        $data = [],
        array $errors = []
    ): PsrResponseInterface {
        $body = [
            'request_id' => Context::get(AppendRequestProcessor::LOG_REQUEST_ID_KEY),
            'status' => $status,
            'message' => $message,
        ];

        !empty($errors) && $body['debug'] = $errors;
        if (!empty($data)) {
            $body = isset($data['data']) ? array_merge($body, $data) : array_merge($body, ['data' => $data]);
        }

        $this->withAddedHeaders(['content-type' => 'application/json; charset=utf-8']);

        $response = $this->response->withStatus($code)->json($body);
        Context::set(PsrResponseInterface::class, $response);

        return $response;
    }

    public function withAddedHeaders(array $headers): Response
    {
        $config = config('response.headers');
        $headers = array_merge($config, $headers);
        $response = $this->response;
        foreach ($headers as $key => $value) {
            $response = $response->withHeader($key, $value);
        }
        Context::set(PsrResponseInterface::class, $response);

        $this->response = $response;

        return $this;
    }
}

Response类中的formatting是最终的输出方法, 在这里对当前响应内容进行上下文保存, 这时DebugDeferMiddleware中间件中才能获取到最终的响应内容.

不知道我这里处理是否合理. 但是也符合了您提出的方法的最终效果.

[huangdijia]

#5715

@gokure 3.0已经增加了请求周期事件。