log-record正式版本发布：自定义函数、手动传递上下文、本地监听支持

前言

之前写了两篇文章，来介绍我的log-record开源项目（优雅记录操作日志）是如何诞生的。

前文：

萌新写开源01 | 如何使用注解优雅的记录操作日志

萌新写开源02 | 如何提交自己的项目到Maven公共仓库

这两周我又迭代了几个版本，正式把自定义函数，手动传递上下文，本地监听等基础功能做了支持，并且重新给项目编了个易于人类阅读的文档。

这算是正儿八经的一次介绍了，现在该库已经正式可以在Maven仓库拉取了。

大家有兴趣的话，建议多多使用体验一下，给我一些反馈或者Pr，我会加油好好迭代项目。

仓库地址：

https://github.com/qqxx6661/logRecord

项目背景

大家一定见过下图的操作日志：

在代码层面，如何优雅的实现上面的日志记录呢？

你可能会一下子想到最简单的方式，通过封装一个操作日志记录类（例如LogUtil）。使用一个用户修改配送地址的操作举例：

代码语言：javascript复制

String template = "用户%s修改了订单的配送地址：从“%s”修改到“%s”"
LogUtil.log(orderNo, String.format(tempalte, "小明", "金灿灿小区", "银盏盏小区"),  "小明")

这种方式会导致业务逻辑被记录日志的代码侵入，对于代码的可读性和可维护性来说是一个灾难。

这个方式显然不优雅，让我们试试使用注解：

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "20211102001", msg = "用户 小明 修改了订单的配送地址：从 金灿灿小区 修改到 银盏盏小区")
public Response<T> function(Request request) {
  // 业务执行逻辑
}

可以看到，这样日志的记录被放到了注解，对业务代码没有了侵入。但是新的问题来了，我们该如何把订单ID，用户信息，数据库里的旧地址，函数入参的新地址传递给注解呢？

Spring的SpEL表达式（Spring Expression Language）可以帮助我们，通过引入SpEL表达式，我们可以获取函数的入参。这样我们就可以对上面的注解进行修改：

订单ID：#request.orderId
新地址"银盏盏小区"：#request.newAddress

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "#request.orderId", msg = "'用户 小明 修改了订单的配送地址：从 金灿灿小区 修改到'   #request.newAddress")
public Response<T> function(Request request) {
  // 业务执行逻辑
}

这样依赖，订单ID和地址的新值就可以通过解析入参动态获取了，但是事情还没有结束，我们的用户信息，以及老的配送地址，是需要业务代码去获取的，入参里并不会包含这些数据。

解决方案也不是没有，我们创建一个日志上下文LogRecordContext，让用户手动传递代码中计算出来的值，再交给SpEL解析。

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "#request.orderId", msg = "'用户'   #userName   '修改了订单的配送地址：从'   #oldAddress   '修改到'   #request.newAddress")
public Response<T> function(Request request) {
  // 业务执行逻辑
  ...
  // 手动传递日志上下文：用户信息 地址旧值
  LogRecordContext.putVariables("userName", queryUserName(request.getUserId()));
  LogRecordContext.putVariables("oldAddress", queryOldAddress(request.getOrderId()));
}

什么？你说这不就又侵入了业务逻辑了么？

确实是的，虽然能用，但是对于有“强迫症”的同学，这样的实现还是不够优雅，接下来我们用自定义函数，解决这个问题。

SpEL支持在表达式中传入用户自定义函数，我们将queryUserName和queryOldAddress这两个函数传递给SpEL，SpEL在解析表达式时，会自动执行对应函数。

最终，我们的注解变成了这样，并且最终记录了日志：

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "#request.orderId", msg = "'用户'   #queryUserName(#request.userId)   '修改了订单的配送地址：从'   #oldAddress   '修改到'   #queryOldAddress(#request.orderId)")
public Response<T> function(Request request) {
  // 业务执行逻辑
}

用户小明修改了订单的配送地址：从金灿灿小区修改到银盏盏小区

项目介绍

本仓库帮助你通过注解优雅地聚合项目中的操作日志，对业务代码无侵入。

此外，你可以方便地将所有日志推送到下列数据管道：

本地监听处理
发送至RabbitMQ
发送至RocketMQ

日志内包含：

代码语言：javascript复制

logId：生成的UUID
bizId：业务唯一ID
bizType：业务类型
exception：函数执行失败时写入异常信息
operateDate：操作执行时间
success：函数是否执行成功
msg：注解中传递的msg（支持JSON）
tag：用户自定义标签
returnStr: 方法执行成功后的返回值（JSON化）

本项目特点：

方便接入：使用Spring Boot Starter实现，用户直接在pom.xml引入依赖，快速接入
SpEL解析：直接写表达式解析入参
自定义上下文：支持手动传递键值对，通过SpEL进行解析
自定义函数：支持注册自定义函数，通过SpEL进行解析

使用方法

接入方式

只需要简单的三步：

第一步： SpringBoot项目中引入依赖（最新版本号请查阅Maven公共仓库）

代码语言：javascript复制

<dependency>
    <groupId>cn.monitor4all</groupId>
    <artifactId>log-record-starter</artifactId>
    <version>1.0.4</version>
</dependency>

第二步： 添加数据源配置

支持推送日志数据至：

本地应用监听
RabbitMQ
RocketMQ

1. 本地应用监听

若只需要在同一应用内处理日志信息，只需要继承抽象类CustomLogListener，便可对日志进行处理。

代码语言：javascript复制

@Slf4j
@Component
public class TestCustomLogListener extends CustomLogListener {

    @Override
    public void createLog(LogDTO logDTO) throws Exception {
        log.info("TestCustomLogListener 本地接收到日志 [{}]", logDTO);
    }
}

2. RabbitMQ

配置好RabbitMQ的发送者

代码语言：javascript复制

log-record.data-pipeline=rabbitMq
log-record.rabbit-mq-properties.host=localhost
log-record.rabbit-mq-properties.port=5672
log-record.rabbit-mq-properties.username=admin
log-record.rabbit-mq-properties.password=xxxxxx
log-record.rabbit-mq-properties.queue-name=logRecord
log-record.rabbit-mq-properties.routing-key=
log-record.rabbit-mq-properties.exchange-name=logRecord

3. RocketMQ

配置好RocketMQ的发送者

代码语言：javascript复制

log-record.data-pipeline=rocketMq
log-record.rocket-mq-properties.topic=logRecord
log-record.rocket-mq-properties.tag=
log-record.rocket-mq-properties.group-name=logRecord
log-record.rocket-mq-properties.namesrv-addr=localhost:9876

第三步： 在你自己的项目中，在需要记录日志的方法上，添加@OperationLog注解。

代码语言：javascript复制

@OperationLog(bizType = "orderCreate", bizId = "#request.orderId", msg = "#request")
public Response<BaseResult> function(Request request) {
  // 业务执行逻辑
}

（必填）bizType：业务类型
（必填）bizId：唯一业务ID（支持SpEL表达式）
（非必填）msg：需要传递的其他数据（支持SpEL表达式）
（非必填）tag：自定义标签

自定义传递上下文

直接引入类LogRecordContext，放入键值对。

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "#request.orderId", msg = "'用户'   #userName   '修改了订单的配送地址：从'   #oldAddress   '修改到'   #request.newAddress")
public Response<T> function(Request request) {
  // 业务执行逻辑
  ...
  // 手动传递日志上下文：用户信息 地址旧值
  LogRecordContext.putVariables("userName", queryUserName(request.getUserId()));
  LogRecordContext.putVariables("oldAddress", queryOldAddress(request.getOrderId()));
}

自定义函数

将@LogRecordFunc注解申明在需要注册到SpEL的自定义函数上。

注意，需要在类上也声明@LogRecordFunc，否则无法找到该函数。

代码语言：javascript复制

@LogRecordFunc
public class MyFuction {

    private static TestService testService;

    @LogRecordFunc
    public static String testFunc(String str) {
        if (testService == null) {
            testService = SpringContextUtils.getBean(TestService.class);
        }
        return testService.testServiceFunc2(str);
    }
}

代码语言：javascript复制

@OperationLog(bizType = "addressChange", bizId = "#request.orderId", msg = "'用户'   #queryUserName(#request.userId)   '修改了订单的配送地址：从'   #oldAddress   '修改到'   #queryOldAddress(#request.orderId)")
public Response<T> function(Request request) {
  // 业务执行逻辑
}

重复注解

代码语言：javascript复制

@OperationLog(bizId = "#testClass.testId", bizType = "testType1", msg = "#testFunc(#testClass.testId)")
@OperationLog(bizId = "#testClass.testId", bizType = "testType2", msg = "#testFunc(#testClass.testId)")
@OperationLog(bizId = "#testClass.testId", bizType = "testType3", msg = "'用户将旧值'   #old   '更改为新值'   #testClass.testStr")

我们还加上了重复注解的支持，可以在一个方法上同时加多个@OperationLog，下图是最终使用效果：

实现原理

由于采用的是SpringBoot Starter方式，会自动扫描到依赖包中的类，并自动通过Spring进行配置和管理。

该注解通过在切面中解析SpEL参数，将数据发往数据源。发送的消息体如下：

方法处理正常发送消息体：

代码语言：javascript复制

[LogDTO(logId=3771ff1e-e5ff-4251-a534-31dab5b666b3, bizId=str, bizType=testType1, exception=null, operateDate=Sat Nov 06 20:08:54 CST 2021, success=true, msg={"testList":["1","2","3"],"testStr":"str"}, tag=operation)]

方法处理异常发送消息体：

代码语言：javascript复制

[LogDTO(logId=d162b2db-2346-4144-8cd4-aea900e4682b, bizId=str, bizType=testType1, exception=testError, operateDate=Sat Nov 06 20:09:24 CST 2021, success=false, msg={"testList":["1","2","3"],"testStr":"str"}, tag=operation)]