Hyperf结合Redis异步队列任务async-queue实现后台操作日志写入

本文涉及的产品
云数据库 Redis 版,社区版 2GB
推荐场景:
搭建游戏排行榜
简介: Hyperf结合Redis异步队列任务async-queue实现后台操作日志写入
本文环境 Hyperf2.1,PHP7.3,Mysql5.7\
不懂的可以评论或联系我邮箱:owen@owenzhang.com\
著作权归OwenZhang所有。商业转载请联系OwenZhang获得授权,非商业转载请注明出处。

业务场景介绍

前天接到一个需求,后台管理系统,记录后台账号的操作记录信息。

由于是集团后台,这样操作者就很多,但操作日志却是很关键的信息,必须得写入数据库,这样多用户写入,我们就得用到异步队列进行消费,防止写入失败,如果队列进行消费指定参数后还是失败,就得写入日志进行钉钉消息推送,具体可以看我另外一篇文章:

lite-monitor 一款基于 shell 命令的监控系统 - owenzhang24的个人空间 - OSCHINA - 中文开源技术交流社区

需求产品原型图:

image.png

Hyperf & async-queue介绍

Hyperf 介绍

Hyperf 是基于 Swoole 4.5+ 实现的高性能、高灵活性的 PHP 协程框架,内置协程服务器及大量常用的组件,性能较传统基于 PHP-FPM 的框架有质的提升,提供超高性能的同时,也保持着极其灵活的可扩展性,标准组件均基于 PSR 标准 实现,基于强大的依赖注入设计,保证了绝大部分组件或类都是 可替换 与 可复用 的。

async-queue 介绍

async-queue是Redis 异步队列,异步队列区别于 RabbitMQ Kafka 等消息队列,它只提供一种 异步处理 和 异步延时处理 的能力,并 不能 严格地保证消息的持久化和 不支持 ACK 应答机制。

官方文档:
Redis 异步队列 (hyperf.wiki)

async-queue 安装

使用composer将 async-queue 安装到你的项目中:

composer require hyperf/async-queue

插件环境要求:
image.png
参考Packagist:
hyperf/async-queue - Packagist

async-queue 配置

配置文件位于 config/autoload/async_queue.php,如文件不存在可自行创建。

我的项目配置如下:

<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
return [
    'default' => [
        'driver' => Hyperf\AsyncQueue\Driver\RedisDriver::class,
        'channel' => 'plan_queue',//队列前缀
        'timeout' => 5,//pop 消息的超时时间
        'retry_seconds' => 5,//失败后重新尝试间隔
        'handle_timeout' => 5,//消息处理超时时间
        'processes' => 5, //增加异步队列进程数量,加快消费速度
    ],
];

其他配置可以参考官方文档

微信截图_20220120161605.png

代码实例

消费队列接口类

函数说明:

  • __construct() 任务执行失败后的重试次数,即最大执行次数为 $maxAttempts+1 次
  • handle() 执行任务日志写入数据库

代码实例:

<?php

declare(strict_types=1);

namespace App\Job;

use App\Model\HoutaiOperationLog;
use Hyperf\AsyncQueue\Job;
use Hyperf\Utils\ApplicationContext;

class OperationLogAddJob extends Job
{
    public $params;

    /**
     * 任务执行失败后的重试次数,即最大执行次数为 $maxAttempts+1 次
     *
     * @var int
     */
    protected $maxAttempts = 0;

    public function __construct($params)
    {
        $this->params = $params;
    }

    /**
     * 执行任务 日志写入数据库
     * @var int
     */
    public function handle()
    {
        $container = ApplicationContext::getContainer();
        $logger = $container->get(\Hyperf\Logger\LoggerFactory::class)->get('log', 'default');

        try {
            $insertData = [
                'operation_type' => $this->params['operation_type'],
                'operation_page' => $this->params['operation_page'],
                'content' => $this->params['content'],
                'status' => $this->params['status'],
                'ip' => $this->params['ip'],
                'created_id' => $this->params['created_id'],
                'app' => $this->params['app'],
                'created_at' => date('Y-m-d H:i:s'),
            ];

            return HoutaiOperationLog::query()->insert($insertData);
        } catch (\Exception $e) {
            $logger->error('后台操作日志添加失败:' . $e->getMessage());
        }

        return 'success';
    }
}

写入异步队列函数方法

操作日志添加队列函数方法

代码实例:

/**
 * Describe: 个人中心-操作日志添加队列
 * Route: get /admin/operation_log_list
 * @param int $operationType 操作类型,1登录,2登出,3编辑修改,4新增创建,5删除,6导出数据,7导入数据(导出和导入暂时不做)
 * @param string $operationPage 操作页面
 * @param string $content 操作内容
 * @param int $status 操作状态,1成功,2失败
 * Created by OwenZhang at 2022/01/17 10:14
 */
public function operationLogAdd(int $operationType, string $operationPage, string $content, int $status)
{
    try {
        $driverFactory = ApplicationContext::getContainer()->get(DriverFactory::class);
        $driver = $driverFactory->get('default');

        $params['operation_type'] = $operationType;
        $params['operation_page'] = $operationPage;
        $params['content'] = $content;
        $params['status'] = $status;
        $params['ip'] = Context::get('ip') ?? '';
        $params['created_id'] = Context::get('system_user_id') ?? 0;
        $params['app'] = Context::get('app') ?? 0;

        return $driver->push(new OperationLogAddJob($params));
    } catch (\Exception $e) {
        throw new BusinessException(9999, '操作日志添加失败:' . $e->getMessage());
    }
}

调用写入异步队列函数方法

具体业务类下写入

代码实例:

$this->operationLogService->operationLogAdd(operationLogService::TYPE_EDIT, '运营管理&配置-意见反馈', "【意见反馈】【{$statusName}】【ID{$ids}】", operationLogService::STATUS_SUCCESS);

Buy me a cup of coffee :)

觉得对你有帮助,就给我打赏吧,谢谢!

Buy me a cup of coffee :)

https://www.owenzhang.com/wechat_reward.png

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
2天前
|
NoSQL Java Redis
springboot搭建后台框架 (二)整合Redis
springboot搭建后台框架 (二)整合Redis
7 0
|
4天前
|
消息中间件 设计模式 Java
spdlog中的异步日志方案
spdlog中的异步日志方案
32 2
|
22天前
|
消息中间件 NoSQL Java
别再用 Redis List 实现消息队列了,Stream 专为队列而生
别再用 Redis List 实现消息队列了,Stream 专为队列而生
30 0
|
1月前
|
前端开发
muduo源码剖析之AsyncLogging异步日志类
AsyncLogging是muduo的日志,程序如果直接让文件写日志可能会发生阻塞,muduo前端设计了2个BufferPtr,分别是currentBuffer_和nextBuffer_,还有一个存放BufferPtr的vector(buffers_)。多个前端线程往currentBuffer_写数据,currentBuffer_写满了将其放入buffers_,通知后端线程读。前端线程将currentBuffer_和nextBuffer_替换继续写currentBuffer_。
15 0
|
1月前
|
Java Linux
异步日志方案log4cpp
异步日志方案log4cpp
16 0
|
1月前
|
缓存 前端开发 NoSQL
muduo异步日志库模块的实现
muduo异步日志库模块的实现
|
2月前
|
SQL 弹性计算 监控
构建多账号云环境的解决方案|多账号云上操作日志统一审计
操作审计(ActionTrail)是阿里云提供的云账号资源操作记录的查询和投递服务,可用于安全分析、资源变更追踪以及合规性审计等场景。企业在阿里云采用多账号的资源结构时,如何满对跨账号跨地域的云上操作日志进行统一归集留存和分析,是企业上云管云过程的必备环节。此次分享为您介绍如何使用操作审计产品进行中心化的审计,提升云上多账号操作的可控可见性,及时发现问题、响应问题,规避潜在风险。
218 0
|
2月前
|
开发工具 git
idea的Terminal终端操作git时, git log的注释乱码问题
最近工作比较清闲, 于是在自己的项目中测试: 假如git reset回滚到之前的版本, 后悔了. 应该如何回撤回回滚, 但是又被一些小问题拌住了...
47 0
|
2月前
|
Java
如何实现一个高效的二叉搜索树(BST)?请给出时间复杂度分析。 要求:设计一个二叉搜索树,支持插入、删除和查找操作。要求在平均情况下,这些操作的时间复杂度为O(log n)。同时,考虑树的平衡性,使得树的高度保持在对数级别。
如何实现一个高效的二叉搜索树(BST)?请给出时间复杂度分析。 要求:设计一个二叉搜索树,支持插入、删除和查找操作。要求在平均情况下,这些操作的时间复杂度为O(log n)。同时,考虑树的平衡性,使得树的高度保持在对数级别。
25 0
|
2月前
|
算法
【LeetCode刷题日志】232.用栈实现队列
【LeetCode刷题日志】232.用栈实现队列

热门文章

最新文章