refactor: 分离HTTP日志记录功能到专门的HttpLogMiddleware中间件
This commit is contained in:
u2nyakim
parent
07c625c7a7
commit
9d077cb93e
@ -4,6 +4,7 @@ declare (strict_types=1);
|
|||||||
namespace app;
|
namespace app;
|
||||||
|
|
||||||
use app\http\middleware\ContextMiddleware;
|
use app\http\middleware\ContextMiddleware;
|
||||||
|
use app\http\middleware\HttpLogMiddleware;
|
||||||
use think\Service;
|
use think\Service;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -13,6 +14,9 @@ class AppService extends Service
|
|||||||
{
|
{
|
||||||
public function register(): void
|
public function register(): void
|
||||||
{
|
{
|
||||||
|
// 上下文中间件放在最前面
|
||||||
$this->app->middleware->unshift(ContextMiddleware::class, 'route');
|
$this->app->middleware->unshift(ContextMiddleware::class, 'route');
|
||||||
|
// HTTP日志记录中间件
|
||||||
|
$this->app->middleware->add(HttpLogMiddleware::class, 'route');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
19
app/controller/h5/H5Controller.php
Normal file
19
app/controller/h5/H5Controller.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace app\controller;
|
||||||
|
|
||||||
|
use app\BaseController;
|
||||||
|
|
||||||
|
class H5Controller extends BaseController
|
||||||
|
{
|
||||||
|
// sb.domain.com/channel
|
||||||
|
public function index()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public function info()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -2,14 +2,11 @@
|
|||||||
|
|
||||||
namespace app\http\middleware;
|
namespace app\http\middleware;
|
||||||
|
|
||||||
use app\entity\SysRequestRecord;
|
|
||||||
use Closure;
|
use Closure;
|
||||||
use think\{exception\ValidateException, file\UploadedFile, middleware, Request, Response};
|
use think\{middleware, Request, Response};
|
||||||
|
|
||||||
class ContextMiddleware extends middleware
|
class ContextMiddleware extends middleware
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
||||||
public function handle(Request $request, Closure $next): Response
|
public function handle(Request $request, Closure $next): Response
|
||||||
{
|
{
|
||||||
/*
|
/*
|
||||||
@ -46,120 +43,4 @@ class ContextMiddleware extends middleware
|
|||||||
|
|
||||||
return $response;
|
return $response;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected $noHttpLog = [
|
|
||||||
'GET@/adminapi/system/request-record'
|
|
||||||
];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 结束
|
|
||||||
* @param Response $response
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function end(Response $response): void
|
|
||||||
{
|
|
||||||
$request = $this->app->request;
|
|
||||||
$log = (array)$this->app->config->get('admin.httpLog');
|
|
||||||
|
|
||||||
$logOpen = $log['open'] ?? false;
|
|
||||||
if (!$logOpen || in_array($request->method() . '@' . $request->pathinfo(),$this->noHttpLog)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
$request_start_time = $request->time(true);
|
|
||||||
$request_end_time = microtime(true);
|
|
||||||
$running_time = ($request_end_time - $request_start_time) * 1000;
|
|
||||||
|
|
||||||
$openRecordStartTime = $log['open_start_time'] ?? 0;
|
|
||||||
$openRecordEndTime = $log['open_end_time'] ?? 0;
|
|
||||||
if ($openRecordStartTime && $openRecordEndTime) {
|
|
||||||
if ($request_end_time < $openRecordStartTime || $openRecordEndTime < $request_end_time) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$rules = array_merge([
|
|
||||||
'include_methods' => [],
|
|
||||||
'include_responses' => [],
|
|
||||||
'include_codes' => [],
|
|
||||||
'exclude_codes' => [],
|
|
||||||
], $log['recordRules'] ?? []);
|
|
||||||
|
|
||||||
// 请求类型(GET/POST/PUT/DELETE)
|
|
||||||
$request_method = $request->method();
|
|
||||||
if (!in_array($request_method, $rules['include_methods'])) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// 返回类型(JSON/HTML/XML)
|
|
||||||
$response_type = get_class($response);
|
|
||||||
if (!in_array($response_type, $rules['include_responses'])) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// 返回状态码(Http Status Code)
|
|
||||||
$response_code = $response->getCode();
|
|
||||||
if (in_array($response_type, $rules['exclude_codes'])) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (count($rules['include_codes']) > 0) {
|
|
||||||
if (!in_array($response_type, $rules['include_codes'])) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$request_start_time = explode('.', $request_start_time);
|
|
||||||
$request_end_time = explode('.', $request_end_time);
|
|
||||||
$request_date = date('Y-m-d H:i:s', $request_start_time[0]);
|
|
||||||
$response_data = $response->getContent();
|
|
||||||
|
|
||||||
// 限制response_data记录长度
|
|
||||||
$response_max = $log['response_max'] ?? 0;
|
|
||||||
if ($response_max) {
|
|
||||||
$response_data = mb_substr($response_data, 0, $response_max, 'utf-8');
|
|
||||||
}
|
|
||||||
$request_body = $request->param();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// 对文件类型的数据做处理
|
|
||||||
$request_file = $request->file();
|
|
||||||
if ($request_file && count($request_file) > 0) {
|
|
||||||
/**
|
|
||||||
* @var UploadedFile $file
|
|
||||||
*/
|
|
||||||
foreach ($request->file() as $key => $file) {
|
|
||||||
$request_body[$key] = [
|
|
||||||
'md5' => $file->md5(),
|
|
||||||
'name' => $file->getOriginalName(),
|
|
||||||
'size' => $file->getSize(),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$route = $request->rule()->getRoute();
|
|
||||||
|
|
||||||
$client = \app\Request::getClient();
|
|
||||||
(new SysRequestRecord)->save([
|
|
||||||
'context_id' => $request->contextId,
|
|
||||||
'client_id' => $client->id,
|
|
||||||
'client_name' => $client->name,
|
|
||||||
'client_version' => $client->version,
|
|
||||||
'request_date' => $request_date,
|
|
||||||
'request_time' => $request_date . '.' . ($request_start_time[1] ?? 0),
|
|
||||||
'request_method' => $request_method,
|
|
||||||
'request_end_time' => date('Y-m-d H:i:s', $request_end_time[0]) . '.' . ($request_end_time[1] ?? 0),
|
|
||||||
'request_headers' => json_encode($request->header(), JSON_UNESCAPED_UNICODE),
|
|
||||||
'request_body' => json_encode($request_body, JSON_UNESCAPED_UNICODE),
|
|
||||||
'request_path' => $request->url(),
|
|
||||||
'request_domain' => $request->domain(),
|
|
||||||
'response_type' => $response_type,
|
|
||||||
'response_code' => $response_code,
|
|
||||||
'response_data' => $response_data,
|
|
||||||
'running_time' => (int)$running_time,
|
|
||||||
'running_memory_limit' => ini_get('memory_limit'),
|
|
||||||
'running_memory_usage' => memory_get_peak_usage(),
|
|
||||||
'request_ip' => $request->ip(),
|
|
||||||
'rule_name' => $request->rule()->getName(),
|
|
||||||
'rule_route' => is_array($route) ? implode('@', $route) : @json_encode($route),
|
|
||||||
]);
|
|
||||||
} catch (\Throwable $e) {
|
|
||||||
$this->app->log->error("[ContextMiddleware::end] 日志写入失败->{$e->getMessage()}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
1
app/http/middleware/H5Middleware.php
Normal file
1
app/http/middleware/H5Middleware.php
Normal file
@ -0,0 +1 @@
|
|||||||
|
<?php
|
||||||
137
app/http/middleware/HttpLogMiddleware.php
Normal file
137
app/http/middleware/HttpLogMiddleware.php
Normal file
@ -0,0 +1,137 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace app\http\middleware;
|
||||||
|
|
||||||
|
use app\entity\SysRequestRecord;
|
||||||
|
use Closure;
|
||||||
|
use think\{file\UploadedFile, middleware, Request, Response};
|
||||||
|
|
||||||
|
class HttpLogMiddleware extends middleware
|
||||||
|
{
|
||||||
|
protected $noHttpLog = [
|
||||||
|
'GET@/adminapi/system/request-record'
|
||||||
|
];
|
||||||
|
|
||||||
|
public function handle(Request $request, Closure $next): Response
|
||||||
|
{
|
||||||
|
$response = $next($request);
|
||||||
|
|
||||||
|
// 记录HTTP日志
|
||||||
|
$this->recordHttpLog($request, $response);
|
||||||
|
|
||||||
|
return $response;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 记录HTTP请求日志
|
||||||
|
* @param Request $request
|
||||||
|
* @param Response $response
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
protected function recordHttpLog(Request $request, Response $response): void
|
||||||
|
{
|
||||||
|
$log = (array)$this->app->config->get('admin.httpLog');
|
||||||
|
|
||||||
|
$logOpen = $log['open'] ?? false;
|
||||||
|
if (!$logOpen || in_array($request->method() . '@' . $request->pathinfo(), $this->noHttpLog)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$request_start_time = $request->time(true);
|
||||||
|
$request_end_time = microtime(true);
|
||||||
|
$running_time = ($request_end_time - $request_start_time) * 1000;
|
||||||
|
|
||||||
|
$openRecordStartTime = $log['open_start_time'] ?? 0;
|
||||||
|
$openRecordEndTime = $log['open_end_time'] ?? 0;
|
||||||
|
if ($openRecordStartTime && $openRecordEndTime) {
|
||||||
|
if ($request_end_time < $openRecordStartTime || $openRecordEndTime < $request_end_time) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$rules = array_merge([
|
||||||
|
'include_methods' => [],
|
||||||
|
'include_responses' => [],
|
||||||
|
'include_codes' => [],
|
||||||
|
'exclude_codes' => [],
|
||||||
|
], $log['recordRules'] ?? []);
|
||||||
|
|
||||||
|
// 请求类型(GET/POST/PUT/DELETE)
|
||||||
|
$request_method = $request->method();
|
||||||
|
if (!in_array($request_method, $rules['include_methods'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// 返回类型(JSON/HTML/XML)
|
||||||
|
$response_type = get_class($response);
|
||||||
|
if (!in_array($response_type, $rules['include_responses'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// 返回状态码(Http Status Code)
|
||||||
|
$response_code = $response->getCode();
|
||||||
|
if (in_array($response_type, $rules['exclude_codes'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (count($rules['include_codes']) > 0) {
|
||||||
|
if (!in_array($response_type, $rules['include_codes'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$request_start_time = explode('.', $request_start_time);
|
||||||
|
$request_end_time = explode('.', $request_end_time);
|
||||||
|
$request_date = date('Y-m-d H:i:s', $request_start_time[0]);
|
||||||
|
$response_data = $response->getContent();
|
||||||
|
|
||||||
|
// 限制response_data记录长度
|
||||||
|
$response_max = $log['response_max'] ?? 0;
|
||||||
|
if ($response_max) {
|
||||||
|
$response_data = mb_substr($response_data, 0, $response_max, 'utf-8');
|
||||||
|
}
|
||||||
|
$request_body = $request->param();
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 对文件类型的数据做处理
|
||||||
|
$request_file = $request->file();
|
||||||
|
if ($request_file && count($request_file) > 0) {
|
||||||
|
/**
|
||||||
|
* @var UploadedFile $file
|
||||||
|
*/
|
||||||
|
foreach ($request->file() as $key => $file) {
|
||||||
|
$request_body[$key] = [
|
||||||
|
'md5' => $file->md5(),
|
||||||
|
'name' => $file->getOriginalName(),
|
||||||
|
'size' => $file->getSize(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$route = $request->rule()->getRoute();
|
||||||
|
|
||||||
|
$client = \app\Request::getClient();
|
||||||
|
(new SysRequestRecord)->save([
|
||||||
|
'context_id' => $request->contextId ?? '',
|
||||||
|
'client_id' => $client->id,
|
||||||
|
'client_name' => $client->name,
|
||||||
|
'client_version' => $client->version,
|
||||||
|
'request_date' => $request_date,
|
||||||
|
'request_time' => $request_date . '.' . ($request_start_time[1] ?? 0),
|
||||||
|
'request_method' => $request_method,
|
||||||
|
'request_end_time' => date('Y-m-d H:i:s', $request_end_time[0]) . '.' . ($request_end_time[1] ?? 0),
|
||||||
|
'request_headers' => json_encode($request->header(), JSON_UNESCAPED_UNICODE),
|
||||||
|
'request_body' => json_encode($request_body, JSON_UNESCAPED_UNICODE),
|
||||||
|
'request_path' => $request->url(),
|
||||||
|
'request_domain' => $request->domain(),
|
||||||
|
'response_type' => $response_type,
|
||||||
|
'response_code' => $response_code,
|
||||||
|
'response_data' => $response_data,
|
||||||
|
'running_time' => (int)$running_time,
|
||||||
|
'running_memory_limit' => ini_get('memory_limit'),
|
||||||
|
'running_memory_usage' => memory_get_peak_usage(),
|
||||||
|
'request_ip' => $request->ip(),
|
||||||
|
'rule_name' => $request->rule()->getName(),
|
||||||
|
'rule_route' => is_array($route) ? implode('@', $route) : @json_encode($route),
|
||||||
|
]);
|
||||||
|
} catch (\Throwable $e) {
|
||||||
|
$this->app->log->error("[HttpLogMiddleware::recordHttpLog] 日志写入失败->{$e->getMessage()}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
route/h5.php
Normal file
1
route/h5.php
Normal file
@ -0,0 +1 @@
|
|||||||
|
<?php
|
||||||
Loading…
Reference in New Issue
Block a user