第十一章 日志采集

前言

web系统中都会有记录操作日志的需求，通常我们会写入本地文件或者第三方存储，然后再做分析查询；今天我们做一个简单的操作日志采集功能，实现方式是通过切面来获取操作信息，然后写入数据库。

一、定义日志实体和注解

考虑到后面很多模块都会用到这个日志组件，我们新建一个base-log来统一封装。
[图片上传失败...(image-106090-1677483882996)]

日志实体（SysLog）属性有请求方式，请求链接，ip，操作人等信息

Oplog注解就是用来做标记用的，哪个方法需要记录操作日志，就加上这个注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Oplog {

    String value() default "";
}

二、配置切面

1、类用@Aspect这个注解标记，把当前类标识为一个切面；

2、@Around标记在方法上，表示环绕通知；他会扫描被oplog标记的方法；

3、组装日志，SysLogUtil工具类

4、异步发送日志，通过Spring事件来实现

@Aspect
@AllArgsConstructor
public class SysLogAspect {
    private final ApplicationEventPublisher publisher;

    @SneakyThrows
    @Around("@annotation(oplog)")
    public Object around(ProceedingJoinPoint proceedingJoinPoint, Oplog oplog) {
        SysLog logVo = SysLogUtil.AssembleSysLog();
        logVo.setTitle(oplog.value());
        Long startTime = System.currentTimeMillis();
        Object obj = proceedingJoinPoint.proceed();
        Long endTime = System.currentTimeMillis();
        //计算执行时间
        logVo.setTime(endTime - startTime);
        //异步发送日志
        publisher.publishEvent(new SysLogEvent(JSONUtil.toJsonStr(logVo)));
        return obj;
    }
}

5、统一配置，初始化日志组件

@Order
@Slf4j
@Configuration
public class LogAutoConfiguration {
    @Bean
    public SysLogAspect sysLogAspect(ApplicationEventPublisher publisher) {
        log.info("日志组件初始化");
        return new SysLogAspect(publisher);
    }
}

其他子系统引入日志组件的时候会自动初始化

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.ailot.cloud.base.log.LogAutoConfiguration

三、异步写入日志

在需要写入日志的模块新建一个监听器，用来接收异步事件；这种做法其实很不友好 ，缺点就是如果多个子系统需要记录日志，那就需要在每个子系统都添加监听器，这个我们后面在优化，目前留个坑；

@Component
@AllArgsConstructor
public class SysLogListener {
    private final SysLogService sysLogService;

    @Async
    @EventListener(SysLogEvent.class)
    public void saveSysLog(SysLogEvent event) {
        SysLog sysLog = event.getSysLog();
        sysLogService.save(sysLog);
    }
}

四、测试

image.png

image.png

image.png

当前版本tag：1.0.10
代码仓库

五、 体验地址

后台数据库只给了部分权限，报错属于正常！
想学的老铁给点点关注吧！！！
欢迎留言交流！！！

我是阿咕噜，一个从互联网慢慢上岸的程序员，如果喜欢我的文章，记得帮忙点个赞哟，谢谢！