[Java知识库] 开源｜操作日志工具

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Java知识库 -> 开源｜操作日志工具 -> 正文阅读

[Java知识库]开源｜操作日志工具

摘要：业务系统中难免要记录敏感操作，可以通过硬编码或者简单注解实现，但是都不够优雅，今天分享一个自己写的日志工具。

这是参考美团的一篇文章所实现的日志工具，能够灵活地记录操作日志，并且具有较好的扩展性，欢迎尝鲜。下面是这个工具的介绍和使用教程。

代码仓库：https://github.com/elltor/oplog

预览效果图:

日志效果

oplog

oplog 一个便于使用的操作日志工具。

特性

便于使用。 提供 starter, 通过注解开启功能并自动配置。
灵活。 工具提供了自定义函数、具有表达式解析的日志模版和注解层面的日志持久化控制。
可扩展。 提供了自定义函数、自定义日志操作用户、自定义持久化日志方式。
性能。 通过异步和缓存的方式提升处理性能。

业务逻辑架构

业务逻辑

使用方法

前言

oplog-example 是一个演示模块，你可以通过这个项目快速了解工具的使用和功能。启动项目后点击链接 http://localhost:8080/swagger-ui/index.html 访问 swagger 文档就可以尝试功能了。

1. 开始使用

开启日志记录功能 :

@EnableLogRecord(tenant = "com.elltor.biz", mode = AdviceMode.PROXY)
@SpringBootApplication
public class Application {
    //.....
}

添加注解 @LogRecord 到你要记录日志的方法上。

被注解注释的方方法的入参和返回值将被作为日志模版的上下文。

@LogRecord(success = "查询了用户, 用户id : {#userid}", category = "user")
    public Object getUserByUserid(String userid) {
        return new Object();
    }

好了，到这里你就可以使用基本的功能了。

2. 自定义日志持久化方式

基础父类 AbstractLogRecordService 并且实现持久化方法 record(Record record) 。

@Component
@Slf4j
public class PersistenceLogServiceImpl extends AbstractLogRecordService {
    @Override
    public void record(Record record) {
        log.info("example 包中 : {}", record);
    }
}

3. 自定义日志操作用户

实现接口 IOperatorGetService :

@Component
public class LogRecordOperatorGetImpl implements IOperatorGetService {
    @Override
    public Operator getUser() {
        User user = ContextHolder.currentUser();
        Operator op = new Operator();
        op.setUsername(user.getUsername());
        op.setName(user.getName());
        return op;
    }
}

4. 自定义解析函数

注意:

自定义的解析函数必须是静态方法. 如下面的 userDetail 方法。
返回值总是 String 类型的。

实现接口 IParseFunction :

@Component
public class UserDetailFunction implements IParseFunction {
    
    @Component
    private UserDao userDao;
    
    @Override
    public Method functionMethod() {
        Method method = null;
        try{
            method = UserDetailFunction.class.getDeclaredMethod("userDetail", String.class);
        }catch (NoSuchMethodException e){
            e.printStackTrace();
        }
        return method;
    }
    // custom function
    static String userDetail(String userid){
        User u = userDao.getUserByUserid(userid);
        return u.getName()+" "+u.getSex()+" "+u.getAge();
    }
}