公共日志模块实现

背景:存在A系统和N系统。N系统是一个公共系统,目前暂时只接入A系统,将来还会接入B系统,C系统等。

image

N系统分成众多子项目,现在其中的基础模块需要为其他模块提供日志插入功能,除此之外还需要将日志接入外部的A,B等系统提供。为什么要记录2份日志呢?emmm,原因我就不描述了,因为对理解这个文章不是很有必要,总之是研发和产品一堆人沟通下来的结果。

一,设计思路:
基础模块提供一个切面,以及一个自定义的Annotation,其他模块在需要记录日志的接口加上这个Annotation。基础模块除了在自身保存一份日志,还需要为A系统等外部系统保存,考虑到拓展性,为外部系统保存日志的时候,采用工厂模式。

二,基础模块日志具体实现(这里仅描述对外提供的jar包):
1,annotation

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target( { ElementType.METHOD, ElementType.TYPE })
public @interface OperateLogAnnotation {

}

2,切面类

@Aspect
public class ControllerOperateLogAspect
{
         //调用外部系统的工厂类
    @Autowired
    private OperationLogFactory operationLogFactory;
    //省略其他。。。。。

    /**
     * 对有@LogOperation标记的方法,记录其执行参数及返回结果.
     */
    @Pointcut("@annotation(com.xxx.base.annotation.OperateLogAnnotation)")
    public void methodPointcut()
    {
    }

    @Around("methodPointcut()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable
    {
    
        Object obj = pjp.proceed();
        try
        {
                 //省略判断,只有调用成功才记录日志
                // 成功后记录操作日志,记录在基础模块的日志
                insertOperateLog();
                // 插入外部系统日志
                insertExternalOperationLog();
        }
        catch (Throwable e)
        {
            log.error("记录操作日志信息异常:", e);
        }
        return obj;
    }
  /**
   * 记录业务方日志
   */
    public void insertExternalOperationLog(String remark....) throws Throwable
    {
        //通过工厂获取具体的外部日志处理类
        OperationLogService operationLogService = operationLogFactory
                .getOperationLogService(remark);
        operationLogService.insertOperationLog();
    }

3,外部日志处理接口

public interface OperationLogService
{
    void insertOperationLog(....);

    String getRemark();
}

4,外部日志处理实现类(针对A系统的)

public class XXOperationLog implements OperationLogService
{
    @Autowired
    private ThreadPoolTaskExecutor operateLogThreadPool;

    public void insertOperationLog(....)
    {
          // 省略,使用线程池保存数据,不展开
        operateLogThreadPool
                .execute(new XXOperationLogTask(..));
    }

    @Override
    public String getRemark()
    {
        return "xxxx";//这里返回A系统的标识
    }

}

如果后续N系统还要继续接入其他系统就再接入新加一个实现类。

5,工厂类OperationLogFactory

public class OperationLogFactory
{

    @Autowired
    private List<OperationLogService> list;

    public OperationLogService getOperationLogService(String remark) throws Throwable
    {
        for (OperationLogService operationLogService : list)
        {
            if (operationLogService.getRemark().equals(remark))
            {
                return operationLogService;
            }
        }

        throw new NoSuchBeanDefinitionException("没找到对应业务方的日志实现类,业务方remark:" + remark);
    }
}

工厂类这里使用的是集合注入,这也是我无意间了解到的,是不是很方便?list可以拿到这个接口的所有实现类。

到这里基础模块的日志部分就完成了,然后就是N系统的其他模块(这个是日志记录发起者)的引用了。

三,其他模块(日志记录发起者)的引用

1,需要引入基础模块对外提供的jar包:
使用maven坐标引入的方式。这里采用的dubbo的调用方式,如果没了解过的同学,可以把这个jar包当成第三方的工具,通过这个jar包就可以使用第三方的服务。
2,注册相关的bean:
① 为切面类ControllerOperateLogAspect注册一个bean。
②为切面类ControllerOperateLogAspect中调用的基础模块日志功能的dubbo服务注册一个bean。
(不过这里采用的是引入配置文件的方式,就是在项目中import基础模块jar包中配置好的xml配置文件,配置文件已经配置好了需要的bean,调用者不需要具体配置那些bean)
3,在需要记录日志的接口上方加上注解@OperateLogAnnotation

好了,整个流程结束啦,可以看看发起的日志是否写入了基础服务
和A系统的数据库中。
终于写完了


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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 1.1 spring IoC容器和beans的简介 Spring 框架的最核心基础的功能是IoC(控制反转)容器,...
    simoscode阅读 6,709评论 2 22
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,801评论 6 342
  • 纪实生活 体悟人生 最近我在菜市场遇到了老表 这家伙很有意思 我不怕跟你说实话了 我们两老表这么多年了 都不知道这...
    木风恒阅读 250评论 0 0
  • 听说你病好了,我有些难过,再也没有关心你的理由了,世界的舞台那么大,谁能约束得住你? 想起你小病的时候,表现的很乖...
    一瓣荷开阅读 200评论 0 0