基于Spring Aop+SpEL优雅地记录操作日志

不爱总结的麦穗

已于 2024-08-15 15:15:17 修改

阅读量825

点赞数 3

文章标签： java 后端 spring boot

于 2024-04-02 16:28:37 首次发布

本文链接：https://blog.csdn.net/Tan_xiong/article/details/137274218

版权

本文介绍了如何利用Spring AOP和SpEL优雅地记录操作日志，通过AOP拦截和自定义函数实现日志与业务解耦。文中详细讲解了注解定义、模板解析、自定义函数的使用以及日志持久化的实现过程。

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

关注公众号不爱总结的麦穗将不定期推送技术好文

在我们工作的日常开发中，我们经常会遇到需要记录用户的操作日志（如上图所示）的需求，这个需求本身不是很难，但是如何让操作日志不和业务逻辑耦合？:❓ 如何优雅的记录操作日志？这就是本文分享的主要内容：优雅的记录操作日志。

与业务系统解耦，相信很多小伙伴已经想到了Spring AOP，没错，本文分享的方案就是使用 AOP 生成动态的操作日志。（ps：如果有小伙伴对Spring AOP有疑问，可以先去看看这篇文章彻底搞懂Spring AOP）

基于Spring AOP+SpEL 生成动态的操作日志

这里先给出本文实现的一个效果，然后再看是怎么实现这样功能的

从图上看，通过 SpEL（Spring Expression Language，Spring表达式语言）表达式实现了动态模板，SpEL表达式引用方法上的参数，可以让变量填充到模板中达到动态的操作日志文本内容。

这里说明一下，正常情况下像业务单号这类数据应该是从入参或者其它地方获取，写固定是为了演示方便，操作人也是不应该从入参中获取，而是从登陆信息里获取，这里作者就偷懒了…

代码实现

AOP拦截

定义注解@LogRecordAnnotation

@Target({
   ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface LogRecordAnnotation {
   

    //操作是否成功
    boolean succeed() default true;

    //操作人
    String operator() default "";

    //业务单号
    String bizNo() default "";

    //操作日志的种类
    String category() default "";

    //扩展参数，记录操作日志的修改详情
    String detail() default "";

    //记录日志的条件
    String condition() default "";
}

注解中的参数，应该满足大部分的使用场景，在需要记录操作日志的方法上加上该注解，以便后续进行拦截处理。

切面增强逻辑LogRecordAspect

@Slf4j
@Aspect
@Component
public class LogRecordAspect {
   

    @Pointcut("@annotation(com.tx.operating.annotation.LogRecordAnnotation)")
    private void method() {
   
    }