AOP实现的操作日志记录

需求

产品有个需求是记录用户在APP的操作,比如切换页签到主页:记录一条日志 function:“切换主页”,比如上传了一份文件记录:function:上传文件,type:MP4,size:34M等,最后统计操作的总数分析用户习惯。先不说这个统计有价值没,看下如何在android上如何实现。

简单实现:直接封装一个LogService类负责上传日志,在每个需要的地方组装日志数据,然后调用logservice.send(log),这种方法对功能代码有很大的破坏性,随着版本迭代会难以维护。

好点的办法就是开发者无感,将所有的日志记录放到一个地方处理,这种思想就是切面编程简称AOP。AOP是一种方法论,JAVA里面的OOP(面向对象编程),精髓是把功能或问题模块化,每个模块处理自己的家务事。但在现实世界中,并不是所有问题都能完美得划分到模块中。如果说,OOP如果是把问题划分到单个模块的话,那么AOP就是把涉及到众多模块的某一类问题进行统一管理。比如我们可以设计一个Aspects,管理某个软件中所有模块的日志输出的功能。

@Aspect实现切面记录操作日志

用到的开源库:https://github.com/uPhyca/gradle-android-aspectj-plugin

Project的build.gradle 配置:classpath 'com.uphyca.gradle:gradle-android-aspectj-plugin:0.9.14'
Moduler的build.gradle配置:apply plugin: 'com.uphyca.android-aspectj'

基本流程就是在某处定义一个空方法,方法参数是我们需要上传服务器的参数。比如某个界面CompInfoFragment

    private void collectLog(String function, boolean isSucc, long ppid, long finishOpenTime, long startOpenTime) {
    }

然后在需要记录的地方调用这个方法: 比如用户点击back键需要记录一条日志

接下来,我需要找到这个方法的位置,并获取方法里面的参数。定义一个日志类加上@Aspect注解,在里面定义一个切点,并且在这个切点前执行日志的记录:


image.png

1是定义切点:通过类名+方法名模糊匹配到之前定义的空方法
2是切点名称
3是切点时机:这里在这个切点(也就是空方法执行)前,插入我们的操作日志记录,注意这里的方法参数名称必须和空方法一致,并且不能是对象!不能是enum,只能是基本数据类型。
4是真正的错日志记录,获取到业务层传过来的参数,组装日志上传(后面再讲)。
在一个日志类里面可以定义多个切点:

@Aspect
public class AttrGroup {
    @Pointcut("execution(* *..CompInfoFragment.collectLog(..))")
    public void logForFunction(){};

    @Before("logForFunction() && args(function,isSucc,ppid,finishOpenTime,startOpenTime)")
    public void log(JoinPoint joinPoint,String function, boolean isSucc,long ppid,long finishOpenTime,long startOpenTime){
        collectLog(function,isSucc,ppid,finishOpenTime,startOpenTime);
    }

    @Pointcut("execution(* *..CompInformationActivity.collectLog(..))")
    public void logForFunction2(){};

    @Before("logForFunction2() && args(ppid,position,enterType)")
    public void log2(JoinPoint joinPoint,int ppid,int position,int enterType){
        collectLog2(ppid,position,enterType);
    }

    private void collectLog(String function, boolean isSucc,long ppid,long finishOpenTime,long startOpenTime) {
        List<Integer> ppids = new ArrayList<Integer>();
        List<SendLogInfoEvent.LogBean> extendInfos = new ArrayList<SendLogInfoEvent.LogBean>();
        SendLogInfoEvent.BVUserOperLog log = new SendLogInfoEvent.BVUserOperLog();
        log.function = function;
        //省略 日志的组装
        BVLogService.getInstance().addLog(log);
    }

    private void collectLog2(int ppid,int position,int enterType){
        List<Integer> ppids = new ArrayList<Integer>();
        List<SendLogInfoEvent.LogBean> extendInfos = new ArrayList<SendLogInfoEvent.LogBean>();
        SendLogInfoEvent.BVUserOperLog log = new SendLogInfoEvent.BVUserOperLog();
        //省略 日志的组装
        BVLogService.getInstance().addLog(log);
    }
}

这样在业务层只需要插入一个空方法,真正的日志记录全部封装到一个地方管理。同时,根据不同的业务把日志类分类,不要把所有的切点放到一个类:


image.png

每个类负责维护一个业务的日志记录。

日志记录类的封装

上面实现了对操作日志切点的捕捉,下面的工作就是上传这条日志。用户点击一次就上传一条显然不合理,为了提高效率可以开启工作线程收集日志,满5条一起上传。并且while循环10秒钟检测一次,有日志立刻上传。

public class LogService {
    private static LogService _instance = new LogService();
    private LogService.LogerSubmitter submitter;

    protected LogService() {
        this.init();
    }

    public static LogService getInstance() {
        return _instance;
    }

    public void init() {
        this.submitter = new LogService.LogerSubmitter();
        this.submitter.start();
    }

    public void addLog(BVUserOperLog info) {
        if(this.submitter != null) {
            this.submitter.addLog(info);
        }

    }

    public void clearAllLog() {
        if(this.submitter != null) {
            this.submitter.clearLog();
        }

    }

    public void destory() {
        if(this.submitter != null) {
            this.submitter.notifyExit();
            this.submitter = null;
        }

    }

    public interface IAddOperLog {
        @POST("rs/log/addOperLog")
        @ServerName("pdscommon")
        Call<ResponseBody> addOperLog(@Body List<BVUserOperLog> var1);
    }

    private class LogerSubmitter extends Thread {
        protected boolean exitFlag = false;
        protected Event event = new Event();
        protected Queue<BVUserOperLog> queue = new ConcurrentLinkedQueue();
        private static final long COMMIT_PERIOD = 10000L;
        private static final int MAX_LOG_SIZE = 5;

        public LogerSubmitter() {
        }

        public void addLog(BVUserOperLog info) {
            this.queue.add(info);
            if(this.queue.size() >= 5) {
                this.event.event_notifyAll();
            }

        }

        public void clearLog() {
            this.queue.clear();
        }

        public void notifyExit() {
            this.exitFlag = true;
            this.event.event_notifyAll();
        }

        public void run() {
            while(true) {
                if(!this.exitFlag) {
                    ArrayList lst = new ArrayList();

                    while(!this.queue.isEmpty()) {
                        lst.add(this.queue.poll());
                    }

                    this.sendLogNow(lst);
                    if(!this.exitFlag) {
                        this.event.event_wait(10000L);
                        continue;
                    }
                }

                return;
            }
        }

        protected void sendLogNow(List<BVUserOperLog> lst) {
            if(lst != null && !lst.isEmpty()) {
                Method m = LbRestMethod.getMethod(LogService.IAddOperLog.class, "addOperLog", List.class);
                LbRestMethodProxy.callMethodV2(LogService.IAddOperLog.class, lst, m);
            }
        }

        protected MethodResponse callMethodLog(Class<?> service, Object methodParam, Method method) {
            LbRestMethod rm = LbRestMethodProxy.MakeLbRestMethod(method, new LbExceptionHandler());
            MethodResponse res = rm.run(service, methodParam, method);
            return res;
        }
    }
}

至于BVUserOperLog 日志实体怎么定义,根据需求和 服务端约定吧。

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

推荐阅读更多精彩内容