爽！一个注解，搞定 SpringBoot 操作日志

最新推荐文章于 2024-08-17 14:14:17 发布

有故事的程序员

最新推荐文章于 2024-08-17 14:14:17 发布

阅读量983

点赞数

分类专栏： spring 文章标签：数据库 java spring python redis

本文链接：https://blog.csdn.net/m0_52987358/article/details/113990972

版权

本文介绍了一个SpringBoot日志记录组件，通过一个@EnableLogRecord注解即可开启操作日志功能。支持自定义日志模板、异常处理、操作人获取、日志分类以及自定义转换函数等功能，方便对系统操作进行详细记录和查询。

摘要由CSDN通过智能技术生成

来源：blog.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.1</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);
    }
}

日志埋点

普通的记录日志
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”
2. 期望记录失败的日志, 如果抛出异常则记录fail的日志，没有抛出记录 success 的日志

 @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{
   {#_errorMsg}}」",
            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;
    }

其中的 #_errorMsg 是取的方法抛出异常后的异常的 errorMessage。
3. 日志支持种类
比如一个订单的操作日志，有些操作日志是用户自己操作的，有些操作是系统运营人员做了修改产生的操作日志，我们系统不希望把运营的操作日志暴露给用户看到，但是运营期望可以看到用户的日志以及运营自己操作的日志，这些操作日志的bizNo都是订单号，所以为了扩展添加了类型字段,主要是为了对日志做分类，查询方便，支持更多的业务。

@LogRecordAnnotation(
fail = “创建订单失败，失败原因：「{ {#_errorMsg}}」”,
category = “MANAGER”,
success &#