一个 Java 注解，搞定 SpringBoot 操作日志，附源码！

作者： mztBang

原文：csdn.net/weixin_43954303/article/details/113781801

此组件解决的问题是：
「谁」在「什么时间」对「什么」做了「什么事」

本组件目前针对 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean

使用方式

基本使用

maven 依赖添加 SDK 依赖

        <dependency>
            <groupId>io.github.mouzt</groupId>
            <artifactId>bizlog-sdk</artifactId>
            <version>1.0.4</version>
        </dependency>

SpringBoot 入口打开开关, 添加 @EnableLogRecord 注解

tenant 是代表租户的标识，一般一个服务或者一个业务下的多个服务都写死一个 tenant 就可以

         
 

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@EnableTransactionManagement
@EnableLogRecord(tenant = "com.mzt.test")
public class Main {

    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
    }


}
 

日志埋点

1. 普通的记录日志

• pefix：是拼接在 bizNo 上作为 log 的一个标识。避免 bizNo 都为整数 ID 的时候和其他的业务中的 ID 重复。比如订单 ID、用户 ID 等
• bizNo：就是业务的 ID，比如订单 ID，我们查询的时候可以根据 bizNo 查询和它相关的操作日志
• success：方法调用成功后把 success 记录在日志的内容中

• SpEL 表达式：其中用双大括号包围起来的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL 表达式。Spring 中支持的它都支持的。比如调用静态方法，三目表达式。SpEL 可以使用方法中的任何参数

         
 

  @LogRecordAnnotation(success = "{{#order.purchaseName下了一个订单,购买商品「{{#order.productName」,下单结果:{{#_ret",
              prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo")
  public boolean createOrder(Order order) {
      log.info("【创建订单】orderNo={", order.getOrderNo());
      // db insert order
      return true;
  }

}}}}}}}}}
 

此时会打印操作日志 “张三下了一个订单, 购买商品「超值优惠红烧肉套餐」, 下单结果: true”