Android使用AOP埋点实战
2019-11-08 本文已影响0人
neko_nia
背景
最近收到了一些运营需求，需要对一些数据进行埋点，刚刚收到需求的时候，只有一个方案那就是去所有的页面添加监听，增加想要添加的业务数据， 那庞大的工作量以及超强的耦合度，想想都头大。不禁的心疼起自己的头发。后面知道了原来可以面向切面编程。接下来就是我使用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常用的注解以及概念，这里讲到了相关概念，我就不搬过来了。
