Hyperf框架中实现Redis命令执行事件监听的技术方案

在Hyperf框架开发过程中，开发者经常需要监控Redis命令的执行情况，以便进行性能分析、调试或审计。本文将详细介绍在Hyperf中实现Redis命令执行事件监听的几种技术方案。

方案一：使用AOP切面实现

AOP(面向切面编程)是Hyperf框架提供的一种强大功能，可以在不修改原有代码的情况下，对方法调用进行拦截和处理。

实现步骤

1. 创建Redis切面类

<?php

declare(strict_types=1);

namespace App\Aspect;

use Hyperf\Di\Annotation\Aspect;
use Hyperf\Di\Aop\AbstractAspect;
use Hyperf\Di\Aop\ProceedingJoinPoint;
use Hyperf\Redis\Redis;

#[Aspect]
class RedisCommandAspect extends AbstractAspect
{
    public array $classes = [
        Redis::class . '::__call',
    ];

    public function process(ProceedingJoinPoint $proceedingJoinPoint)
    {
        $start = microtime(true);
        
        // 获取执行的Redis命令和参数
        $command = $proceedingJoinPoint->arguments['keys']['name'];
        $arguments = $proceedingJoinPoint->arguments['keys']['arguments'];
        
        try {
            $result = $proceedingJoinPoint->process();
            
            // 记录执行成功的日志
            $this->logRedisCommand($command, $arguments, microtime(true) - $start);
            
            return $result;
        } catch (\Throwable $e) {
            // 记录执行失败的日志
            $this->logRedisError($command, $arguments, $e);
            throw $e;
        }
    }
    
    protected function logRedisCommand($command, $arguments, $executionTime)
    {
        // 实现你的日志记录逻辑
    }
    
    protected function logRedisError($command, $arguments, $exception)
    {
        // 实现错误日志记录逻辑
    }
}

2. 在config/autoload/aspects.php中注册切面

return [
    App\Aspect\RedisCommandAspect::class,
];

方案二：使用Sentry链路追踪

对于需要更专业监控的场景，可以使用Sentry提供的Redis追踪功能。

1. 安装依赖

composer require friendsofhyperf/sentry

2. Sentry会自动通过AOP记录所有Redis命令的执行情况，包括：

• 执行的命令
• 参数
• 执行时间
• 是否成功
• 错误信息(如果失败)

方案三：自定义事件监听器

Hyperf的事件系统也可以用来实现Redis命令监听。

1. 定义Redis命令执行事件

<?php

declare(strict_types=1);

namespace App\Event;

class RedisCommandExecuted
{
    public function __construct(
        public string $command,
        public array $arguments,
        public mixed $result,
        public float $executionTime,
        public ?\Throwable $exception = null
    ) {}
}

2. 创建事件监听器

<?php

declare(strict_types=1);

namespace App\Listener;

use App\Event\RedisCommandExecuted;
use Hyperf\Event\Annotation\Listener;
use Hyperf\Event\Contract\ListenerInterface;

#[Listener]
class RedisCommandListener implements ListenerInterface
{
    public function listen(): array
    {
        return [
            RedisCommandExecuted::class,
        ];
    }

    public function process(object $event): void
    {
        if ($event instanceof RedisCommandExecuted) {
            // 处理事件，记录日志或发送到监控系统
        }
    }
}

3. 在Redis代理类中触发事件

// 在调用Redis命令的地方
$start = microtime(true);
try {
    $result = $redis->{$command}(...$arguments);
    $event = new RedisCommandExecuted($command, $arguments, $result, microtime(true) - $start);
} catch (\Throwable $e) {
    $event = new RedisCommandExecuted($command, $arguments, null, microtime(true) - $start, $e);
    throw $e;
} finally {
    event($event);
}

方案对比

方案	优点	缺点	适用场景
AOP切面	无侵入性，全局生效	需要理解AOP概念	简单的日志记录
Sentry	功能全面，专业监控	需要额外依赖	生产环境监控
事件监听	灵活可控	需要手动触发事件	需要精细控制的场景

最佳实践建议

1. 开发环境：可以使用AOP切面方案，简单快速地查看Redis命令执行情况
2. 测试环境：建议使用Sentry，可以获取更全面的性能数据
3. 生产环境：推荐Sentry+自定义事件监听组合，既保证监控全面性，又能实现业务特定的审计需求

通过以上方案，开发者可以灵活选择适合自己项目需求的Redis命令监控方式，提高系统的可观测性和可维护性。