README.md

Operation Log

基于 spring aop 操作日志记录工具 支持自定义方法处理

快速开始

添加依赖

<dependency>
    <groupId>cn.hangsman.operationlog</groupId>
    <artifactId>operation-log-spring-boot-starter</artifactId>
    <version>1.0.1</version>
</dependency>

启用注解

@SpringBootApplication
@EnableOperationLog
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

添加 OperationLog 注解

1. 基础用法

@OperationLog(
        category = "创建订单",
        fail = "订单创建失败：{#_errorMsg}",
        content = "创建了一个订单 订单id： {#order.orderID}")
public Order createOrder(Order order) {
    return new Order();
}

2. 使用变量

可以通过 #变量名 的方式使用方法的入参

• #_ret 方法返回值
• #_errorMsg 方法抛出的异常信息

@OperationLog(
        fail = "订单创建失败：{#_errorMsg}",
        content = "创建了一个订单 订单id： {#order.orderID}",
        detail = "{#_ret.toString()}")
public Order createOrder(Order order) {
    return new Order();
}

日志记录

实现 OperationLogRecorder 并注入到容器中

public interface OperationLogRecorder {
    void record(OperationLog operationLog);
}

自定义表达式方法

实现 SpelFunction 来创建一个spel表达式方法

@Service
public class JsonSpelFunction implements SpelFunction {
    @Override
    public Object apply(Object value) {
        return JsonUtil.toJson(value);
    }

    @Override
    public String functionName() {
        return "json";
    }
}

在模板中通过 $方法名称(变量) 来使用

@OperationLog(detail = "{#_ret != null ? $json(#_ret) : null}")
public Order createOrder(Order order)

前置处理

格式为 变量名={spel函数}

之后在其他模板中可以使用 #变量名 获取函数返回值

@OperationLog(
        before = {"oldName={$oldNameFun(#user.id)}"},
        content = "将用户名从 {#oldName} 修改为 {#user.username}")
public User updateName(User user)

额外字段

某些情况下可能现有参数不能满足业务，可以通过使用additional字段来添加额外的操作信息

格式为：key={spel表达式}

@OperationLog(additional = {"type={#user.enable ? '启用' : '禁用'}"})
public User updateUser(User user)

支持

如果您喜欢该项目，请给项目点亮⭐️，感谢！