Android使用AOP埋点实战

背景

最近收到了一些运营需求，需要对一些数据进行埋点，刚刚收到需求的时候，只有一个方案那就是去所有的页面添加监听，增加想要添加的业务数据， 那庞大的工作量以及超强的耦合度，想想都头大。不禁的心疼起自己的头发。后面知道了原来可以面向切面编程。接下来就是我使用aspectj的实战。

实战指项目配置

  • 第一步 项目的build.gradle的dependencies中加入
classpath 'org.aspectj:aspectjtools:1.8.9'
classpath 'org.aspectj:aspectjweaver:1.8.9'
  • 第二步 在APP的build.gradle的dependencies中引入以下代码
 implementation 'org.aspectj:aspectjrt:1.8.9'
  • 第三步在app的build.gradle的android的目录下加入
import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main

final def log = project.logger

android.applicationVariants.all { variant ->
//    if (!variant.buildType.isDebuggable()) {
//        log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
//        return
//    }// 这段代码会导致在release下失效 

    JavaCompile javaCompile = variant.javaCompiler
    javaCompile.doLast {
        String[] args = ["-showWeaveInfo",
                         "-1.8",
                         "-inpath", javaCompile.destinationDir.toString(),
                         "-aspectpath", javaCompile.classpath.asPath,
                         "-d", javaCompile.destinationDir.toString(),
                         "-classpath", javaCompile.classpath.asPath,
                         "-bootclasspath", project.android.bootClasspath.join(File.pathSeparator)]
        log.debug "ajc args: " + Arrays.toString(args)

        MessageHandler handler = new MessageHandler(true)
        new Main().run(args, handler)
        for (IMessage message : handler.getMessages(null, true)) {
            switch (message.getKind()) {
                case IMessage.ABORT:
                case IMessage.ERROR:
                case IMessage.FAIL:
                    log.error message.message, message.thrown
                    break
                case IMessage.WARNING:
                    log.warn message.message, message.thrown
                    break
                case IMessage.INFO:
                    log.info message.message, message.thrown
                    break
                case IMessage.DEBUG:
                    log.debug message.message, message.thrown
                    break
            }
        }
    }

上面那一段是在网上看别人的文章搬过来的，当时有个bug就是 ，正式包切面代码怎么都注入不成功，后面才发现了这段代码。注释掉下面这段代码之后就成功了。

if (!variant.buildType.isDebuggable()) {
       log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
       return
    }

到这里AOP的配置就完成了 。接下来我将贴出我根据需求所完成的相关业务代码

1. 统计页面停留时长。

这里的统计使用了极光推送的统计 ，官方文档就是需要每个页面的开始以及结束的生命周期里加上两句话 ，我们的项目反正有100多个页面，如果每个页面都去加的话，那工作量 额... 不好说。我们还是看看切面真么实现页面监听吧
实现代码

@Aspect
public class TraceAspect {

    private static final String TAG = "aop_page_trace";

    @After("execution(* android.app.Activity.onResume(..)) )")
    public void onActivityMethodBefore(JoinPoint joinPoint) throws Throwable {

        Signature signature = joinPoint.getSignature();
        System.out.println (TAG + " 切面的点执行开始  context==" + (Context) joinPoint.getThis()) ;
        System.out.println (TAG + "切面的点执行开始类名" + signature.getDeclaringType().getCanonicalName());
        JAnalyticsInterface.onPageStart((Context) joinPoint.getThis(), signature.getDeclaringType().getCanonicalName());

    }

    @After("execution(* android.app.Activity.onPause(..)) ")
    public void onActivityMethodDestory(JoinPoint joinPoint) throws Throwable {
        Signature signature = joinPoint.getSignature();
        JAnalyticsInterface.onPageEnd((Context) joinPoint.getThis(), signature.getDeclaringType().getCanonicalName());
        System.out.println (TAG +" 切面的点执行销毁  context==" + (Context) joinPoint.getThis());
        System.out.println (TAG +"切面的点执行销毁类名" + signature.getDeclaringType().getCanonicalName());
    }

execution 一般指定方法的执行,在往后因为没有注解和访问权限的限制，所以这里什么也没写，返回值用代替，说明可以用任何返回值，android.app.Activity.on代表函数名称的全路径，后面的一个型号代表on后面可以接任何东西，后面的(..)代表其参数可以为任何值。
@After指在jPoint()之后执行，我为了不影响之前代码的执行所以一般都用这个通配符。

2. 按钮点击 或者页面跳转的的相关埋点

我先说一下思路。 我这里借助到了注解，第一步自定义注解，第二步在需要埋点的地方引用当前注解。第三步在切面检查引用注解的地方找到切点，第四步，再切点处加入自己想要的逻辑代码
自定义注解的代码如下

/***
点击的注解
 2019-10-30
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface ClickAnnotate {

    int type() default 0; //我根据需求定义了一个type参数 进行标记，以便于找到切点后 进行业务判断

监听点击或跳转的切面代码如下

@Aspect
public class ClickAspect {

    private static final String TAG = "aop_click";
    private String intention = IntentionAty.class.getCanonicalName();

    @Pointcut("execution(@com.aoptest.annotation.ClickAnnotate * *(..))")
    public void clickP() {
    }

    @After("clickP()")
    public void insertCodeBlock(JoinPoint joinPoint) throws Throwable {

        MethodSignature methodSignature = ((MethodSignature) joinPoint.getSignature());
        Method method = methodSignature.getMethod();
        if (method.isAnnotationPresent(ClickAnnotate.class)) {
            ClickAnnotate  clickAnnotate = method.getAnnotation(ClickAnnotate.class);

            int type = clickAnnotate.type();
            switch (type) {
                case Constants.AOP_HOME_MENNU://这个常量是自定义的
                    String menCode = "";
                    if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
                        if (joinPoint.getArgs()[0] instanceof String) {
                            menCode = (String) joinPoint.getArgs()[0];
                        }
                    }//joinPoint.getArgs() 就是你切入方法的地方的参数 ，一定要注意数组越界问题
                    if (TextUtils.isEmpty(menCode)) return;
                    switch (menCode) {
                        case "MENU_HOME_HYGL":
                            Log.i(TAG, "insertCodeBlock: 点击了会员管理");
          
                            break;
                        case "MENU_HOME_YXDD":
                            Log.i(TAG, "insertCodeBlock: 点击了意向订单");
         
                            break;
                    }
                    break;

            }

        }
    }
}

到这里，切面需要做的事情就完成了，接下来就是只需要调用注解，表明需要切入代码的地方就行了。

/**
     * 
     * @param menuCode 菜单对应的编码 
     */
  @ClickAnnotate(type = Constants.AOP_HOME_MENNU)//这里的常量和上面的切面对应
    private void setMenuJump(String menuCode) {
        Class<?> className = null;
     if (menuCode.equals("MENU_HOME_YXDD")) {
            className = IntentionAty.class;
        }  

        if (className != null) {
            startActivity(new Intent(mContext, className));
        }
    }

根据以上步骤调用之后，切面就会检查调用@ClickAnnotate注解的所有方法，找到切点，然后就注入相关代码。我这里考虑到复用，所以在注解里面定义了一个type用于区分。

总结

在项目中。如果使用了混淆的话，一定要注意注解不要被混淆了，否则会导致切面不执行的。经过这个需求之后，我发现AOP真的是好香香喔， AOP 大大降低了代码的耦合度，挺高了代码的可维护性。关于AOP相关注解以及表达式的写法可以参考 AOP常用的注解以及概念，这里讲到了相关概念，我就不搬过来了。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,519评论 5赞 468
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,842评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,544评论 0赞 330
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,742评论 1赞 271
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,646评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,027评论 1赞 275
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,513评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,169评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,324评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,996评论 3赞 315
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,591评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2赞 345
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2赞 341