当前位置：首页 > news >正文

网站建设系统设计莆田建设网站建站

news 2025/9/17 20:51:45

网站建设系统设计,莆田建设网站建站,软文发布公司,wordpress比较好的建议操作留痕功能实现与探讨背景接手了一个单体应用项目，看系统介绍，说实现了【高性能的操作日志留痕】功能，就有点好奇它是怎么设计的，是阻塞队列还是怎样的线程池。结果我打开代码一看，真的是笑洗个人了。它是做了一…

操作留痕功能实现与探讨

背景

接手了一个单体应用项目，看系统介绍，说实现了【高性能的操作日志留痕】功能，就有点好奇它是怎么设计的，是阻塞队列还是怎样的线程池。结果我打开代码一看，真的是笑洗个人了。它是做了一个接口给前端去调用，代码和多线程一分钱关系都没有，直接是调用到接口，拼装了一下内容就入库了。这玩意哪里高性能了，url远程调用性能高？同步代码高？倒不是说这种方案完全不可取，文末会分析一下这适用于什么场景和优化建议。

最常用操作留痕设计

基于后端去实现操作留痕都会不可避免地对原代码有侵入性，但是我们要想出入侵性最低的方案——基于注解去实现。这么一来我们只需要在方法上加上一个注解和一些参数的设置，就可以完成操作日留痕功能的嵌入了。

操作留痕相对于主业务来说，它并不是重要的部分，所以我们没必要去等待操作留痕功能入库完成后再返回数据。操作留痕对于用户来说是无感的，应该用异步去实现。

编码实现

1.罗列操作留痕需要记录什么信息，哪些信息是可以自动获取的，哪些是要Hard Code的

package org.example.springboot.job.domain;import lombok.Data;import java.util.Date;@Data
public class OptLogRecord {private Long id;    		// 主键private String userName; 	// 操作人员private String userId;		// 用户idprivate String optFunc;     // 菜单功能模块private String menuTitle;    // 具体的菜单private String optButton;     // 按钮private String status;      // 操作结果private Date optTime;       // 操作时间private String optReturn;   // 返回结果}

以上是最基本的操作留痕信息，进阶考虑的话，可以有：请求参数、操作ip、操作地点、请求url、失败后的错误信息等。

其中，功能模块、菜单、按钮这些业务类的信息是我们程序中无法区分的。当然，如果你能维护非常完美的方法名与业务信息的匹配枚举的话，那么我们可以通过切点获取方法名再映射出对应的业务信息。嗯，确实不错，就是有点麻烦。在这里我就使用Hard Code的方式去实现了。有需要的可以自己去实现方法名与业务信息的映射关系。

2.创建注解

package org.example.springboot.job.annotation;import java.lang.annotation.*;@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OptLog {String optFunc() default "";	// 功能模块String menuTitle() default "";	// 菜单标题String optButton() default "";	// 按钮}

3.对使用了注解的方法进行切面织入

导入依赖

<dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><version>1.9.6</version>
</dependency>

创建切面类

@Aspect
@Component
public class OptLogAspect {}

以下代码内容均为OptLogAspect中的内容，为了方便步骤讲解，拎出来说明

指明该切面指向的切点为OptLog

    @Pointcut("@annotation(org.example.springboot.job.annotation.OptLog)")public void optLogPointCut() {}

我们需要在使用注解的方法执行完成之后再记录他操作的信息

    // 这个result是使用了注解的方法的返回值@AfterReturning(pointcut = "optLogPointCut()", returning = "result")public void doAfterReturning(JoinPoint joinPoint, Object result) {handleOptLog(joinPoint, result, "SUCCESS");}

这个handleOptLog方法还没实现，别急

如果出现了异常呢，那肯定是操作失败了，我们也要记录操作失败的信息

    @AfterThrowing(value = "optLogPointCut()")public void doAfterThrowing (final JoinPoint joinPoint) {handleOptLog(joinPoint, null, "FAILED");}

实现handleOptLog方法

    protected void handleOptLog(final JoinPoint joinPoint, Object result, String status) {MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();OptLog optLog = methodSignature == null ? null : methodSignature.getMethod().getAnnotation(OptLog.class);if (optLog == null) return;// TODO:获取当前用户 根据自己系统方式去获取用户OptLogRecord record = new OptLogRecord();// TODO: 设置用户名与用户id略过record.setStatus(status);    // 根据不同的切面来区分是否操作成功record.setOptReturn(result.toString());record.setOptTime(new Date());// 读取使用注解时的参数record.setOptFunc(optLog.optFunc());record.setMenuTitle(optLog.menuTitle());record.setOptButton(optLog.optButton());// 异步保存数据库TimerTask task = new TimerTask() {@Overridepublic void run() {// insert语句保存到数据库System.out.println("insert：" + record.toString());}};ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();executorService.schedule(task, 10, TimeUnit.MILLISECONDS);}

这里的异步日志是使用定时任务线程去完成，延时10ms执行，不影响原本的方法执行效率。

注解使用示范

    @GetMapping("/test")@OptLog(optFunc = "系统管理", menuTitle = "菜单管理", optButton = "添加菜单")public String testCall() throws InterruptedException {Thread.sleep(1000);log.info("hello");AtomicInteger integer = new AtomicInteger();return "test";}