利用Spring AOP切面和RabbitMQ消息队列实现高效的接口日志调用统计功能

总体的思想是:在需要日志统计的接口上加上自定义的注解(@OpLog),通过切面的方式获得接口调用时的参数信息,调用方信息等,同时为了不影响业务,采用MQ消息队列的方式执行日志入库的操作

0. 定义实体类

@Table(name = "op_log")
@Entity
@Data
@EqualsAndHashCode(callSuper = false)
public class OpLogEntity extends BaseEntity {
    /**
     * 接口名称
     */
    private String opApiName;
    /**
     * 方法签名
     */
    private String opMethodSignature;
    /**
     * 方法入参
     */
    private String opMethodArgs;
    /**
     * http方法 POST/GET/HEAD/FETCH/DELETE等
     */
    private String opHttpMethod;
    /**
     * http路径, 从controller的requestMapping到方法的requestMapping
     */
    private String opHttpPath;
    /**
     * url
     */
    private String opHttpUrl;
    /**
     * 日志记录时间(接口被调用时间)
     */
    private Date opStartTime;
    /**
     * 接口执行总时长(毫秒ms)
     */
    private Long opExecuteDuration;
    /**
     * 接口调用方id
     */
    private String opCallerId;
    /**
     * 接口调用方名字
     */
    private String opCallerName;
    /**
     * 接口调用方token
     */
    private String opCallerToken;
    /**
     * 接口调用方手机号
     */
    private String opCallerPhone;
    /**
     * 接口调用方ip
     */
    private String opCallerIp;
    /**
     * 接口执行结果: 1-正常返回,0-抛出异常
     */
    private String opResultFlag;
    /**
     * 业务执行结果
     */
    private String opBusinessFlag;
    /**
     * 接口执行抛出异常时的堆栈信息
     */
    private String opResultThrow;
}

1. 定义注解

// OpLog.java
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface OpLog {
    String apiName();
}

2. Aspect切面处理类

// OpLogAspect.java 已做简化
@Aspect
@Component
public class OpLogAspect {
    private static Logger logger = LoggerFactory.getLogger(OpLogAspect.class);
    
    @Autowired
    private RabbitMqSender rabbitMqSender;
    
    private volatile JoinPoint joinPoint;
    private long startTime;
    private OpLogVO opLogVO;
    
    @Pointcut(value = "@annotation(com.example.aop.OpLog)")
    public void opLogPointCut() {
    }
    
    // 在before时通过attributes 、signature等对象获取接口信息保存到opLogVO中
    @Before(value = "opLogPointCut()")
    public void logBefore(JoinPoint joinPoint) {
        try {
            this.joinPoint = joinPoint;
            RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
            DateTime now = DateUtil.date();
            startTime = now.toTimestamp().getTime();
            opLogVO = new OpLogVO();
            opLogVO.setOpStartTime(now.toJdkDate());
            Signature signature = joinPoint.getSignature();
            if (signature instanceof MethodSignature) {
                String apiName = ((MethodSignature) signature).getMethod().getAnnotation(OpLog.class).apiName();
                opLogVO.setOpApiName(apiName);
                setMethodAndPath(joinPoint, (MethodSignature) signature);
                setMethodArgs(joinPoint, (MethodSignature) signature);
            }
            opLogVO.setOpMethodSignature(signature.toString());
            if (attributes instanceof ServletRequestAttributes) {
                HttpServletRequest servletRequest = ((ServletRequestAttributes) attributes).getRequest();
                opLogVO.setOpHttpUrl(servletRequest.getRequestURL().toString());
                opLogVO.setOpCallerIp(getIpAddress(servletRequest));
            }
        } catch (Exception e) {
            logger.error("切面处理操作日志异常!logBefore-", e);
        }
    }
    
    // AfterReturning表示接口正常返回,将保存了信息的OpLogVO对象发送到MQ队列
    @AfterReturning(value = "opLogPointCut()", returning = "returnValue")
    public void logAfterReturning(JoinPoint joinPoint, Object returnValue) {
        if (this.joinPoint == joinPoint) {
            try {
                long executeDuration = System.currentTimeMillis() - startTime;
                opLogVO.setOpExecuteDuration(executeDuration);
                opLogVO.setOpResultFlag("1");
                // rabbitMqSender是对RabbitMQ的简单封装,最终调用的RabbitTemplate.convertAndSend(String routingKey, Object object)方法
                rabbitMqSender.send(RabbitConfigCommon.OP_LOG_MQ, JSONUtil.toJsonStr(opLogVO));
            } catch (Exception e) {
                logger.error("切面处理操作日志异常!logAfterReturning-", e);
            }
        }
    }
    
    // AfterThrowing表示接口出现异常,将异常堆栈保存到OpLogVO对象发送到MQ队列
    @AfterThrowing(value = "opLogPointCut()", throwing = "throwValue")
    public void logAfterThrowing(JoinPoint joinPoint, Throwable throwValue) {
        if (this.joinPoint == joinPoint) {
            try {
                long executeDuration = System.currentTimeMillis() - startTime;
                opLogVO.setOpExecuteDuration(executeDuration);
                opLogVO.setOpResultFlag("0");
                // import cn.hutool.core.exceptions.ExceptionUtil;
                String stacktrace = ExceptionUtil.stacktraceToString(throwValue);
                opLogVO.setOpResultThrow(StrUtil.sub(stacktrace, 0, 450));
                rabbitMqSender.send(RabbitConfigCommon.OP_LOG_MQ, JSONUtil.toJsonStr(opLogVO));
            } catch (Exception e) {
                logger.error("切面处理操作日志异常!logAfterThrowing-", e);
            }
        }
    }
}

3. RabbitMQ消费者

// RabbitMqReceiver.java
@Component
public class RabbitMqReceiver {
    // OpLogBusi即保存opLogVO到数据库的Business,此处不再展开说明
    @Autowired
    private OpLogBusi opLogBusi;
    
     @RabbitListener(bindings = @QueueBinding(value = @Queue(value = RabbitConfigCommon.OP_LOG_MQ, durable = "true"),
            exchange = @Exchange(value = "ALL"),
            key = RabbitConfigCommon.OP_LOG_MQ))
    public void consumeSaveOpLogMessage(String opLogVO) {
        // opLogBusi.saveOpLog() --> opLogService.save() --> opLogDao.save()
        opLogBusi.saveOpLog(JSONUtil.toBean(opLogVO, OpLogVO.class));
    }
}

4. 使用

    // PersonController.java
    只需在方法上加上@OpLog注解即可
    @OpLog(apiName = "查询个人信息")
    @RequestMapping(value = "/getPersonInfo",method = RequestMethod.POST)
    public ResultBean<StaticData> getPersonInfo(@RequestBody QueryPersonInfo queryPersonInfo) {
        
    }

5. 总结

@OpLog() → Aspect切面 → 分析获取接口调用信息 → 发送到MQ队列 → 接收并消费消息 → 保存到数据库

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,776评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,527评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,361评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,430评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,511评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,544评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,561评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,315评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,763评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,070评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,235评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,911评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,554评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,173评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,424评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,106评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,103评论 2 352

推荐阅读更多精彩内容