Java多线程实战-异步操作日志记录解决方案(AOP+注解+多线程)

news2024/12/25 23:45:45

🏷️个人主页：牵着猫散步的鼠鼠 

🏷️系列专栏：Java全栈-专栏

🏷️本系列源码仓库：多线程并发编程学习的多个代码片段(github)

🏷️个人学习笔记，若有缺误，欢迎评论区指正 

​

本章节案例源码：1321928757/Concurrent-MulThread-Demo: 多线程并发编程学习的多个代码片段，干货分享集合~~~ (github.com)

目录

前言

实现思路

自定义OperationLog注解

使用AOP切面拦截被注解标记的方法

获取请求信息构建OperationLogVo对象

编写线程池封装类，封装类工厂

使用线程池异步执行日志记录操作

使用日志注解，测试

异步日志记录的优缺点分析

优点

缺点

日志持久化方案分析

总结

前言

在现代分布式系统中,操作日志记录扮演着非常重要的角色。它不仅能够帮助我们追踪系统的运行状态,还可以提供关键的审计线索,对于系统的运维和问题排查都有着重要意义。传统的日志记录方式通常是在相关的业务逻辑代码中直接插入日志记录语句,这种方式虽然直观简单,但存在一些明显的缺陷:

  1. 日志记录代码和业务逻辑代码高度耦合,不利于代码的可维护性。
  2. 新增或修改日志记录需求时,需要修改多处代码,工作量较大。
  3. 由于日志记录操作通常需要进行IO操作,会对业务响应时间产生一定影响。

为了解决这些问题,我们可以考虑采用基于注解和AOP切面的异步日志记录解决方案。它能够有效地将日志记录代码和业务逻辑代码解耦,同时通过异步的方式避免日志记录阻塞主线程,从而提高系统的响应速度和吞吐量。

实现思路

自定义OperationLog注解

我们首先定义一个OperationLog注解,用于标记需要记录操作日志的方法。该注解可以包含一些属性,如操作描述、操作类型等,方便后续记录日志时获取相关信息。

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {
    /**
     * @return 操作描述
     */
    String value() default "";
}

使用AOP切面拦截被注解标记的方法

接下来,我们需要定义一个AOP切面,通过切点表达式拦截被OperationLog注解标记的方法。在切面的增强方法中,我们可以获取方法的元数据信息、请求参数等,并与HTTP请求信息一起构建出OperationLogVo对象。

@Aspect
@Component
@Slf4j
public class OperationLogAspect {

    @Pointcut("@annotation(com.luckysj.demo.annotation.OperationLog)")
    public void optLogPointCut() {}

    @Around("optLogPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) {
        // 环绕增强方法...
    }
}

AOP配合注解注解使用是一种很常见且使用的手段，像限流，鉴权之类与业务无关的操作，我们都可以通过这种方法来将这些辅助业务从主业务中拆开来，减少代码耦合度。

获取请求信息构建OperationLogVo对象

在切面的增强方法中,我们使用反射的方式获取目标方法的元数据信息,包括方法名、所在类名等。同时,我们还需要从当前线程绑定的RequestContextHolder中获取HttpServletRequest对象,以获取请求的URI、请求方法、IP地址等信息。将这些信息与操作描述等数据组合,即可构建出完整的OperationLogVo对象。

日志实体对象OperationLogVo：

@Data
@TableName("operation_log")
public class OperationLogVo {

    @TableId(type = IdType.AUTO)
    private Long logId;

    private String type;

    @TableField("request_uri")
    private String uri;

    private String name;

    @TableField("ip_address")
    private String ipAddress;

    private String method;

    private String params;

    private String data;

    @TableField("nick_name")
    private String nickname;

    private Integer userId;

    private Long times;

    private String errorMessage;

}

在AOP切面类中定义一个从织入点中获取数据组装OperationLogVo 实体的方法：

    private OperationLogVo recordLog(ProceedingJoinPoint joinPoint) {
        // 从切面织入点处通过反射机制获取织入点处的方法
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        // 获取切入点所在的方法
        Method method = signature.getMethod();
        // 获取操作
        OperationLog optLogger = method.getAnnotation(OperationLog.class);
        // 获取request
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
        // 日志保存到数据库
        OperationLogVo operationLogVo = new OperationLogVo();
        // 操作类型
        operationLogVo.setType(optLogger.value());
        // 请求URI
        operationLogVo.setUri(request.getRequestURI());
        // 获取请求的类名
        String className = joinPoint.getTarget().getClass().getName();
        // 获取请求的方法名
        String methodName = method.getName();
        methodName = className + "." + methodName;
        // 请求方法
        operationLogVo.setName(methodName);

        // 请求参数
        if (joinPoint.getArgs()[0] instanceof MultipartFile) {
            operationLogVo.setParams(((MultipartFile) joinPoint.getArgs()[0]).getOriginalFilename());
        } else {
            operationLogVo.setParams(JSON.toJSONString(joinPoint.getArgs()));
        }
        // 请求方式
        operationLogVo.setMethod(Objects.requireNonNull(request).getMethod());
        // 请求用户ID 先写死
        operationLogVo.setUserId(22);
//        operationLogVo.setUserId(SecurityUtils.getUserId());
        // 请求用户昵称 先写死
        operationLogVo.setNickname("woniu");
        // 操作ip地址
        String ip = request.getRemoteAddr();
        operationLogVo.setIpAddress(ip);
        return operationLogVo;
    }

 我们这里还需要一个方法来处理异常信息，将异常信息格式化为字符串，方便存储

// 将异常相关的全部信息(类名、描述、堆栈跟踪)格式化为一个字符串,方便存储到日志记录对象OperationLogVo的errorMessage属性中。
public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
    StringBuilder stringBuilder = new StringBuilder();
    for (StackTraceElement stet : elements) {
        stringBuilder.append(stet).append("\n");
    }
    return exceptionName + ":" + exceptionMessage + "\n" + stringBuilder;
}

编写线程池封装类，封装类工厂

AsyncManager类是一个单例类，内部维护了一个ScheduledExecutorService线程池executor。

我们封装了一些常用的方法：

public class AsyncManager {

    /**
     * 单例模式，确保类只有一个实例
     */
    private AsyncManager() {
    }

    /**
     * 饿汉式，在类加载的时候立刻进行实例化
     */
    private static final AsyncManager INSTANCE = new AsyncManager();

    public static AsyncManager getInstance() {
        return INSTANCE;
    }

    /**
     * 异步操作任务调度线程池
     */
    private final ScheduledExecutorService executor = SpringUtils.getBean("scheduledExecutorService");

    /**
     * 执行任务
     *
     * @param task 任务
     */
    public void execute(TimerTask task) {
        executor.schedule(task, 10, TimeUnit.MILLISECONDS);
    }

    /**
     * 停止任务线程池
     */
    public void shutdown() {
        ThreadUtils.shutdownAndAwaitTermination(executor);
    }

}

工厂类：

public class AsyncFactory {

    /**
     * 记录操作日志
     * @param operationLog 操作日志信息
     * @return 任务task
     */
    public static TimerTask recordOperation(OperationLogVo operationLog) {
        return new TimerTask() {
            @Override
            public void run() {
                // 找到日志服务bean，进行日志持久化操作
                SpringUtils.getBean(OperationLogService.class).saveOperationLog(operationLog);
            }
        };
    }


}

 这里的OperationLogService就是日志服务类，我们可以在里面进行日志信息的入库等，具体内容要根据你的实际情况来调整，我这里是存入到msql数据库中持久化，源码仓库会在文末贴出，这里就不细讲了。

使用线程池异步执行日志记录操作

为了避免日志记录操作阻塞主线程,影响业务响应时间,我们可以使用线程池异步执行日志记录操作。在切面的最后,我们将构建好的OperationLogVo对象提交到线程池中,由工作线程异步完成日志的存储操作。

@Around("optLogPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) {
        String methodName = joinPoint.getTarget().getClass().getSimpleName() + "." + joinPoint.getSignature().getName();
        OperationLogVo operationLogVo = null;
        try {
            operationLogVo = this.recordLog(joinPoint);
        } catch (IllegalStateException e) {
            log.error("no web request:{}", e.getMessage());
        }
        long startTime = System.currentTimeMillis();
        Object result = null;
        try {
            result = joinPoint.proceed();
            // 正常返回数据
            operationLogVo.setData(JSON.toJSONString(result));
        } catch (Throwable e) {
            log.info("method: {}, throws: {}", methodName, ExceptionUtils.getStackTrace(e));
            if (operationLogVo != null) {
                operationLogVo.setErrorMessage(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace()));
            }
        } finally {
            long endTime = System.currentTimeMillis();
            if (operationLogVo != null) {
                operationLogVo.setTimes(endTime - startTime);
                //异步记录操作日志
                AsyncManager.getInstance().execute(AsyncFactory.recordOperation(operationLogVo));
            }
        }
        return result;
    }

使用日志注解，测试

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;


    @PostMapping("/add")
    @OperationLog("添加用户")// 这里可以写上操作日志的描述
    public ResponseEntity<String> addUser(@RequestBody UserReq addReq) {
        return userService.addUser(addReq);
    }


}

启动项目后，我们尝试插入一个用户，可以看到日志已经记录到了库中

​

异步日志记录的优缺点分析

优点

  1. 提高响应速度和系统吞吐量：通过异步记录日志，可以避免因日志记录操作中的I/O操作而阻塞主线程，从而提高系统的响应速度和处理能力。
  2. 解耦日志记录与业务逻辑：异步记录机制使得日志记录的逻辑与业务逻辑分离，有助于保持代码的整洁和易于维护。
  3. 提高系统的健壮性：在面对大量日志写入操作时，异步机制可以平滑处理高峰，避免系统因同步写入日志而出现性能瓶颈。

缺点

  1. 可能丢失日志：在极端情况下，如系统突然崩溃，可能会丢失还未来得及持久化的日志。
  2. 日志顺序无法保证：由于是异步操作，无法完全保证日志按照发生顺序进行记录，尤其是在高并发场景下。
  3. 增加系统复杂性：引入异步日志记录机制，增加了系统的复杂性，需要额外的线程管理和错误处理机制。

日志持久化方案分析

日志数据的持久化是确保操作记录可追溯和审计的重要环节，本文章使用的持久化方案是关系型数据库，当然还有很多其他的方案，常见的日志持久化方案包括：

  1. 关系型数据库：将日志数据存储在关系型数据库中，如MySQL、PostgreSQL等。这种方案便于日志的查询、管理和维护，但在高并发场景下可能会成为瓶颈。

  2. 日志文件：直接将日志写入文件系统，这种方式简单高效，适用于大部分场景。但需要合理规划日志的切割、备份和清理策略，以避免文件过大或过多导致的问题。

  3. 消息队列（如Kafka）：将日志作为消息发送到Kafka等消息队列系统中，可以实现高吞吐量的日志处理。这种方案适用于日志量巨大且需要快速处理的场景，同时也便于实现日志数据的分布式处理和存储。

每种方案都有其适用场景和限制，实际选择时需要根据系统的具体需求和现有架构做出合理的决策。

总结

异步日志记录是一种提升系统性能和可维护性的有效手段，通过将日志记录操作异步化，不仅可以减少对业务处理流程的影响，还可以提高日志处理的灵活性和扩展性。然而，实现异步日志记录机制也伴随着一定的挑战，如日志的实时性、顺序性和丢失风险等问题。

在选择日志持久化方案时，应根据系统的实际需求考虑日志数据的安全性、查询效率、成本等因素，选择最适合的存储介质和技术方案。无论采取哪种方案，都应该注意日志系统的健壮性设计，确保日志数据的完整性和可靠性。

多线程编程系列的源码都放在我的github仓库啦，有需要的可以点点小star，感谢支持~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1520866.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

商家转账到零钱 场景模板怎么下载

商家转账到零钱 场景模板怎么下载

商家转账到零钱是什么&#xff1f; 【商家转账到零钱】功能整合了微信支付之前的【企业付款到零钱】【批量转账到零钱】功能&#xff0c;支持批量对外转账&#xff0c;对有批量对用户付款需求的应用场景更友好&#xff0c;操作便捷。如果你的应用场景是单付款场景的话&#xf…
阅读更多...
数据安全之认识数据库加密系统

数据安全之认识数据库加密系统

文章目录 一、什么是数据库加密系统二、数据库加密系统的工作原理三、数据库加密系统的核心功能四、数据库加密系统的特点和优势五、数据库加密系统的部署方式1、在线透明部署2、旁路代理模式 六、数据库加密系统的应用场景 数据库作为计算机信息系统的核心组成部分&#xff0c…
阅读更多...
使用vscode——配置vue3用户代码片段

使用vscode——配置vue3用户代码片段

一、 设置/配置用户代码片段 二、点击新建全局代码片段文件输入vue.json 三、配置代码片段、 {"Print to console": {"prefix": "vue3","body": ["<template>"," <div></div>","</te…
阅读更多...
JAVA22 FFM实战之HelloWorld

JAVA22 FFM实战之HelloWorld

前言 JDK22即将发布&#xff0c;Java Foreign Function & Memory API将会退出预览&#xff0c;是时候开始学习一波了。 FFM API介绍 FFM API由两大部分组成&#xff0c;一个是Foreign Function Interface&#xff0c;另一个是Memory API。前者是外部函数接口&#xff0c…
阅读更多...
数据结构 之 队列(Queue)

数据结构 之 队列(Queue)

​​​​​​​ &#x1f389;欢迎大家观看AUGENSTERN_dc的文章(o゜▽゜)o☆✨✨ &#x1f389;感谢各位读者在百忙之中抽出时间来垂阅我的文章&#xff0c;我会尽我所能向的大家分享我的知识和经验&#x1f4d6; &#x1f389;希望我们在一篇篇的文章中能够共同进步&#xff0…
阅读更多...
双指针算法_移动零_

双指针算法_移动零_

题目&#xff1a; 给定一个数组 num &#xff0c;编写一个函数将数组内部的数字0都移动到数组的末尾&#xff0c;同时保持非零元素的相对顺序&#xff01; 同时不能通过复制数组&#xff0c;开辟新的数组空间的情况下原地对数组进行操作 示例&#xff1a; 本题的原理&#x…
阅读更多...
掘根宝典之C++普通迭代器和反向迭代器详解

掘根宝典之C++普通迭代器和反向迭代器详解

简介 迭代器是一种用于遍历容器元素的对象。它提供了一种统一的访问方式&#xff0c;使程序员可以对容器中的元素进行逐个访问和操作&#xff0c;而不需要了解容器的内部实现细节。 C标准库里每个容器都定义了迭代器&#xff0c;这迭代器的名字就叫容器迭代器 迭代器的作用类…
阅读更多...
谷歌浏览器运行vue项目。 控制台打印cjs.js，如何解决

谷歌浏览器运行vue项目。 控制台打印cjs.js，如何解决

当浏览器运行vue项目。 控制台打印cjs.js&#xff0c;如何解决 &#xff1a;
阅读更多...
oracle基础-子查询 备份

oracle基础-子查询 备份

一、什么是子查询 子查询是在SQL语句内的另外一条select语句&#xff0c;也被称为内查询活着内select语句。在select、insert、update、delete命令中允许是一个表达式的地方都可以包含子查询&#xff0c;子查询也可以包含在另一个子查询中。 【例1.1】在Scott模式下&#xff0…
阅读更多...
Java项目企业设备管理系统

Java项目企业设备管理系统

java项目企业设备管理系统javaweb项目ssm框架项目 运行环境:idea/eclipse tomcat jdk mysql navicat 系统用户分为员工和管理员两类用户。两类用户都可以进行系统的登录&#xff0c;虽然进入的系统主页结构相似&#xff0c;但是在功能上有不同。员工的密码可以自己进入系统后…
阅读更多...
DirectShowPlayerService::doSetUrlSource: Unresolved error code 0x800c000d

DirectShowPlayerService::doSetUrlSource: Unresolved error code 0x800c000d

报出这个问题&#xff0c;应该是对给的url解析不正确&#xff0c;我给的是rtsp的视频流地址&#xff0c;应该是对该格式解析异常。 所以参考两篇文&#xff1a; QT无法播放视频&#xff1a;报错&#xff1a;DirectShowPlayerService::doRender: Unresolved error code 0x8004…
阅读更多...
2024年3月16日云仓酒庄广西发布会圆满举行

2024年3月16日云仓酒庄广西发布会圆满举行

原标题&#xff1a;云仓酒庄广西发布会圆满举行&#xff0c;致敬经销商团队共谋未来发展 2024年3月16日&#xff0c;备受瞩目的云仓酒庄广西发布会在广西南宁隆重举行。此次发布会旨在感谢广西地区经销商团队的长期支持&#xff0c;并共同推进未来发展蓝图。活动现场氛围热烈&…
阅读更多...
总要有一次，为自己疯狂

总要有一次，为自己疯狂

机会其实不多 最近一口气看了《飞驰人生》以及《飞驰人生2》&#xff0c;过去是以看喜剧的心态去看沈腾的电影&#xff0c;当如今二刷时发现这不就是生活吗&#xff0c;只不过用喜剧的外壳做了层包装。两部电影给我影响最深的就是最后的那段对白&#xff0c;“张弛&#xff0c…
阅读更多...
【大模型系列】统一图文理解与生成(BLIP/BLIPv2/InstructBLIP)

【大模型系列】统一图文理解与生成(BLIP/BLIPv2/InstructBLIP)

文章目录 1 BLIP(2022, Salesforce Research)1.1 简介1.2 数据角度1.3 模型角度1.4 BLIP预训练的目标 2 BLIP2(ICML2023, Salesforce)2.1 简介2.2 模型架构2.3 训练细节 3 InstructBLIP(2023, Salesforce)3.1 指令微调技术(Instruction-tuning)3.2 数据集准备3.3 Instruction-a…
阅读更多...
数据结构——动态顺序表

数据结构——动态顺序表

数据结构的动态顺序表有以下几个操作&#xff1a;创建&#xff0c;销毁&#xff0c;初始化&#xff0c;增删查改和打印以及内存空间不够时的扩容 本文的宏定义&#xff1a; #define SeqTypeData int 1.动态顺序表的创建 typedef struct SeqListInit{//动态顺序表的创建SeqT…
阅读更多...
双指针算法_复写零

双指针算法_复写零

题目&#xff1a; 给一个固定长度的数组arr&#xff0c;将数组中出现的每一个0都复写一遍&#xff0c;并且将其余元素都往右移动 且不要再超过数组长度的位置写入元素&#xff0c;在数组上直接修改 示例&#xff1a; 双数组模拟操作&#xff1a; 从示例来看&#xff0c;因为…
阅读更多...
【状态压缩DP】第十三届蓝桥杯省赛C++ B组《积木画》（C++）

【状态压缩DP】第十三届蓝桥杯省赛C++ B组《积木画》（C++）

【题目描述】 小明最近迷上了积木画&#xff0c;有这么两种类型的积木&#xff0c;分别为 I 型&#xff08;大小为 2 个单位面积&#xff09;和 L 型&#xff08;大小为 3 个单位面积&#xff09;&#xff1a; 同时&#xff0c;小明有一块面积大小为 2N 的画布&#xff0c;画布…
阅读更多...
模板进阶：非类型模板参数，特化

模板进阶：非类型模板参数，特化

一、非类型模板参数 非类型模板参数&#xff0c;就是用一个常量作为 类/函数 的模板参数&#xff0c;在 类/函数 中可以被当成常量使用。 template<class T, size_t N>// N 为一个非类型模板参数 class Stack { public:Stack(){_a new T[N];} protected:T* _a; };int m…
阅读更多...
腾讯云服务器入站规则端口开放使用指南(CentOS系统)

腾讯云服务器入站规则端口开放使用指南(CentOS系统)

第一步&#xff1a;开放安全组入站规则 来源处0.0.0.0/0是对IPv4开发&#xff0c;::/0是对IPv6开放&#xff1b; 协议端口按照提示填写即可。云服务器防火墙开放 第三步&#xff1a;本地防火墙开放 sudo firewall-cmd --zonepublic --add-port你的端口号/tcp --perma…
阅读更多...
RTT——stm32f103的can总线通信

RTT——stm32f103的can总线通信

1.创建工程 2.配置时钟和引脚 引脚配置使能CAN 时钟配置&#xff0c;采用外部高速时钟 生成MDK工程后复制相关初始化函数到RTT-studio中 将void HAL_CAN_MspInit(CAN_HandleTypeDef* canHandle)函数复制至broad.c文件中 将时钟配置函数复制到drv_clk.c中&#xff0c;只复制函数…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023