使用@LogRecordAnnotation注解搞定SpringBoot操作日志

源码仓库

https://github.com/mouzt/mzt-biz-log

直接使用@LogRecordAnnotation注解

直接使用@LogRecordAnnotation注解即可记录日志。

 /**
     * pefix：是拼接在 bizNo 上作为 log 的一个标识。避免 bizNo 都为整数 ID 的时候和其他的业务中的 ID 重复。比如订单 ID、用户 ID 等
     * bizNo：就是业务的 ID，比如订单ID，我们查询的时候可以根据 bizNo 查询和它相关的操作日志
     * success：方法调用成功后把 success 记录在日志的内容中
     * SpEL 表达式：其中用双大括号包围起来的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL表达式。Spring中支持的它都支持的。比如调用静态方法，三目表达式。SpEL 可以使用方法中的任何参数
     * category:类别  主要是为了对日志做分类，查询方便，支持更多的业务。
     * detail：如果一个操作修改了很多字段，但是success的日志模版里面防止过长不能把修改详情全部展示出来，这时候需要把修改的详情保存到 detail 字段， detail 是一个 String ，需要自己序列化。这里的 #order.toString() 是调用了 Order 的 toString() 方法。 如果保存 JSON，自己重写一下 Order 的 toString() 方法就可以。
     * operator：操作者
     * operatorId：操作者Id
     */
    @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
            category = "MANAGER",
            detail = "{{#order.toString()}}",
			operator = "{{#currentUser}}",
            success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = ORDER, bizNo = "{{#order.orderNo}}")
    @PostMapping("/createOrder")
    public boolean createOrder(Order order) {
        log.info("【创建订单】orderNo={}", order.getOrderNo());
        // db insert order
         System.out.println(1/0);
        return true;
    }

代码演示

依赖

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

启动类加上@EnableLogRecord注解

package com.lsh;

import com.mzt.logapi.starter.annotation.EnableLogRecord;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author ：LiuShihao
 * @date ：Created in 2021/2/22 10:32 上午
 * @desc ：
 * tenant是代表租户的标识，一般一个服务或者一个业务下的多个服务都写死一个 tenant 就可以
 */
@EnableLogRecord(tenant = "com.lsh.test")
@SpringBootApplication
public class MultiThreadApplication {
    public static void main(String[] args) {
        SpringApplication.run(MultiThreadApplication.class);
    }
}

实例类

package com.lsh.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.format.annotation.DateTimeFormat;

import java.util.Date;

/**
 * @author ：LiuShihao
 * @date ：Created in 2021/2/26 2:02 下午
 * @desc ：
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Order {
    private Long orderId;
    private String orderNo;
    private String purchaseName;
    private String productName;
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;
}

DefaultOperatorGetServiceImpl

这个类的作用是如何指定操作日志的操作人是什么？ 框架提供了两种方法：

第一种：手工在LogRecord的注解上指定。这种需要方法参数上有operator，
需要方法参数上有 operator 参数，或者通过 SpEL 调用静态方法获取当前用户。
第二种： 通过默认实现类来自动的获取操作人，由于在大部分web应用中当前的用户都是保存在一个线程上下文中的，所以每个注解都加一个operator获取操作人显得有些重复劳动，所以提供了一个扩展接口来获取操作人 框架提供了一个扩展接口，使用框架的业务可以 implements 这个接口自己实现获取当前用户的逻辑， 对于使用 Springboot 的只需要实现 IOperatorGetService 接口，然后把这个 Service 作为一个单例放到 Spring 的上下文中。
注意：使用了第二种方式，注解上不加 operator 参数也可以。

package com.lsh.server.impl;

import com.mzt.logapi.beans.Operator;
import com.mzt.logapi.service.IOperatorGetService;
import org.springframework.stereotype.Service;

/**
 * @author ：LiuShihao
 * @date ：Created in 2021/2/26 2:55 下午
 * @desc ：
 */
@Service
public class DefaultOperatorGetServiceImpl implements IOperatorGetService {
    @Override
    public Operator getUser() {
        Operator operator = new Operator();
        operator.setOperatorId("SYSTEM");
        return operator;
    }
}

Controller

	public static final String ORDER = "ORDER";

   /**
     * pefix：是拼接在 bizNo 上作为 log 的一个标识。避免 bizNo 都为整数 ID 的时候和其他的业务中的 ID 重复。比如订单 ID、用户 ID 等
     * bizNo：就是业务的 ID，比如订单ID，我们查询的时候可以根据 bizNo 查询和它相关的操作日志
     * success：方法调用成功后把 success 记录在日志的内容中
     * SpEL 表达式：其中用双大括号包围起来的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL表达式。Spring中支持的它都支持的。比如调用静态方法，三目表达式。SpEL 可以使用方法中的任何参数
     * category:类别  主要是为了对日志做分类，查询方便，支持更多的业务。
     * detail：如果一个操作修改了很多字段，但是success的日志模版里面防止过长不能把修改详情全部展示出来，这时候需要把修改的详情保存到 detail 字段， detail 是一个 String ，需要自己序列化。这里的 #order.toString() 是调用了 Order 的 toString() 方法。 如果保存 JSON，自己重写一下 Order 的 toString() 方法就可以。
     * operator：操作者
     * operatorId：操作者Id
     */
    @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
            category = "MANAGER",
            detail = "{{#order.toString()}}",
            operator = "{{#currentUser}}",
            success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = ORDER, bizNo = "{{#order.orderNo}}")
    @PostMapping("/createOrder")
    public boolean createOrder(Order order) {
        log.info("【创建订单】orderNo={}", order.getOrderNo());
        // db insert order
        // System.out.println(1/0);
        return true;
    }

测试

操作成功记录

【logRecord】log=LogRecord(id=null, tenant=com.lsh.test, bizKey=ORDER_12345, bizNo=12345, operator=SYSTEM, action=LiuShihao下了一个订单,购买商品「iPhone12ProMax128G银色」,下单结果:true, category=MANAGER, createTime=Fri Feb 26 15:13:20 CST 2021, detail=Order(orderId=1001, orderNo=12345, purchaseName=LiuShihao, productName=iPhone12ProMax128G银色, createTime=Fri Feb 26 02:11:00 CST 2021))

操作失败记录
期望记录失败的日志, 如果抛出异常则记录fail的日志，没有抛出记录 success 的日志。

【logRecord】log=LogRecord(id=null, tenant=com.lsh.test, bizKey=ORDER_12345, bizNo=12345, operator=SYSTEM, action=创建订单失败，失败原因：「/ by zero」, category=MANAGER, createTime=Fri Feb 26 15:15:20 CST 2021, detail=Order(orderId=1001, orderNo=12345, purchaseName=LiuShihao, productName=iPhone12ProMax128G银色, createTime=Fri Feb 26 02:11:00 CST 2021))