无痕打点
打点一直是很多公司的痛点,侵入业务,与业务代码冗杂在一起,不能删除,只能不停增加,很多无用的僵尸代码就留在了业务中,而且一出问题就是重要事故,因为老板要看的数据不见了。
那么是不是可以设计一套不侵入业务的打点系统,基于AOP的概念设计打点,下面我就讲讲我是如何基于AOP实现这套打点系统的。
思考
一般打点事件都写在OnClickListener接口的onClick方法中,首先能想到的是写个OnClickListener的子类给大家用,把打点的数据也放到里面,处理过程封装,然后要求大家都要用这个基类,可行是可行的,然而我今天主要想说的不是这种方案。
在美团的技术博客中,提到过无痕埋点的方案,我主要基于这套方案进行学习。
http://tech.meituan.com/mt-mobile-analytics-practice.html?utm_source=tuicool&utm_medium=referral
AppCompatDelegate
首先想带大家看一下AppCompatActivity的源码,可以发现里面有个AppCompatDelegate对象,这个代理对象成为我们替换view的关键。
public AppCompatDelegate getDelegate() {
if (mDelegate == null) {
mDelegate = AppCompatDelegate.create(this, this);
}
return mDelegate;
}
private static AppCompatDelegate create(Context context, Window window,
AppCompatCallback callback) {
final int sdk = Build.VERSION.SDK_INT;
if (sdk >= 23) {
return new AppCompatDelegateImplV23(context, window, callback);
} else if (sdk >= 14) {
return new AppCompatDelegateImplV14(context, window, callback);
} else if (sdk >= 11) {
return new AppCompatDelegateImplV11(context, window, callback);
} else {
return new AppCompatDelegateImplV7(context, window, callback);
}
}
这四个类是包可见的类,依次继承关系,具体细节不讲,我主要分析如何实现view代理的。
public void setContentView(int resId) {
ensureSubDecor();
ViewGroup contentParent = (ViewGroup) mSubDecor.findViewById(android.R.id.content);
contentParent.removeAllViews();
LayoutInflater.from(mContext).inflate(resId, contentParent);
mOriginalWindowCallback.onContentChanged();
}
看起来也没什么异样,只是用LayoutInflater将view创建并添加到跟view中,其实真正的玄机出在LayoutInflater中。
在AppCompatActivity的onCreate方法中,先是这样一段代码:
final AppCompatDelegate delegate = getDelegate();
delegate.installViewFactory();
@Override
public void installViewFactory() {
LayoutInflater layoutInflater = LayoutInflater.from(mContext);
if (layoutInflater.getFactory() == null) {
LayoutInflaterCompat.setFactory(layoutInflater, this);
} else {
if (!(LayoutInflaterCompat.getFactory(layoutInflater)
instanceof AppCompatDelegateImplV7)) {
Log.i(TAG, "The Activity's LayoutInflater already has a Factory installed"
+ " so we can not install AppCompat's");
}
}
}
这里调用LayoutInflaterCompat.setFactory将this设置进去,this其实是LayoutInflaterFactory的接口,实现一个View onCreateView(View parent, String name, Context context, AttributeSet attrs);方法。
AppCompatDelegateImplV7中对这个方法的实现如下:
@Override
public final View onCreateView(View parent, String name,
Context context, AttributeSet attrs) {
final View view = callActivityOnCreateView(parent, name, context, attrs);
if (view != null) {
return view;
}
return createView(parent, name, context, attrs);
}
@Override
public View createView(View parent, final String name, @NonNull Context context,
@NonNull AttributeSet attrs) {
final boolean isPre21 = Build.VERSION.SDK_INT < 21;
if (mAppCompatViewInflater == null) {
mAppCompatViewInflater = new AppCompatViewInflater();
}
final boolean inheritContext = isPre21 && shouldInheritContext((ViewParent) parent);
return mAppCompatViewInflater.createView(parent, name, context, attrs, inheritContext, isPre21, true, isPre21);
}
public final View createView(View parent, final String name, @NonNull Context context,
@NonNull AttributeSet attrs, boolean inheritContext,
boolean readAndroidTheme, boolean readAppTheme, boolean wrapContext) {
final Context originalContext = context;
···
View view = null;
switch (name) {
case "TextView":
view = new AppCompatTextView(context, attrs);
break;
case "ImageView":
view = new AppCompatImageView(context, attrs);
break;
case "Button":
view = new AppCompatButton(context, attrs);
break;
case "EditText":
view = new AppCompatEditText(context, attrs);
break;
case "Spinner":
view = new AppCompatSpinner(context, attrs);
break;
case "ImageButton":
view = new AppCompatImageButton(context, attrs);
break;
case "CheckBox":
view = new AppCompatCheckBox(context, attrs);
break;
case "RadioButton":
view = new AppCompatRadioButton(context, attrs);
break;
case "CheckedTextView":
view = new AppCompatCheckedTextView(context, attrs);
break;
case "AutoCompleteTextView":
view = new AppCompatAutoCompleteTextView(context, attrs);
break;
case "MultiAutoCompleteTextView":
view = new AppCompatMultiAutoCompleteTextView(context, attrs);
break;
case "RatingBar":
view = new AppCompatRatingBar(context, attrs);
break;
case "SeekBar":
view = new AppCompatSeekBar(context, attrs);
break;
}
····
return view;
}
callActivityOnCreateView方法在AppCompatDelegateImplV14中被默认返回空,所以正常情况下,逻辑都会走到createView中,可以看到这大段的代码似乎通过name实现了view的替换,接下来我们只需要看刚才setFactory之后发生了什么,是不是使用了这个方法来创建view。
public static void setFactory(LayoutInflater inflater, LayoutInflaterFactory factory) {
IMPL.setFactory(inflater, factory);
}
static final LayoutInflaterCompatImpl IMPL;
static {
final int version = Build.VERSION.SDK_INT;
if (version >= 21) {
IMPL = new LayoutInflaterCompatImplV21();
} else if (version >= 11) {
IMPL = new LayoutInflaterCompatImplV11();
} else {
IMPL = new LayoutInflaterCompatImplBase();
}
}
// LayoutInflater
public void setFactory(Factory factory) {
mFactorySet = true;
if (mFactory == null) {
mFactory = factory;
} else {
mFactory = new FactoryMerger(factory, null, mFactory, mFactory2);
}
}
public void setFactory2(Factory2 factory) {
mFactorySet = true;
if (mFactory == null) {
mFactory = mFactory2 = factory;
} else {
mFactory = mFactory2 = new FactoryMerger(factory, factory, mFactory, mFactory2);
}
}
看源码可以知道,这个IMPL.setFactory(inflater, factory)在API11以下调用setFactory方法,在API11以上调用setFactory2方法。这里的写法我想大概是一些扩展及兼容性的考虑吧,也使用了反射相关,mFactory2是mFactory1的扩展,无法直接替换,便使用了这种兼容的方式,总之是非常复杂的。
接下来看inflate方法,任何一个xml定义的view的创建都会走到inflate生成,不管你是根activity的setContentView还是自己通过LayoutInflater创建的view,可以看到一个createViewFromTag内部方法,然后就看到了这段代码:
View view;
if (mFactory2 != null) {
view = mFactory2.onCreateView(parent, name, context, attrs);
} else if (mFactory != null) {
view = mFactory.onCreateView(name, context, attrs);
} else {
view = null;
}
可以看到view优先是通过factory进行创建,创建不出来,才自己进行解析的。
这样整个流程就走通了,这套是基于所有view的创建,部分进行了代理,将view的创建替换掉,基于这个特性我们可以这样来设计代码。
设计一个自己的AppCompatDelegate对象
public class DemoAppCompatDelegate {
public static AppCompatDelegate create(Activity activity,AppCompatCallback callback) {
return create(activity, activity.getWindow(), callback);
}
private static AppCompatDelegate create(Context context, Window window,
AppCompatCallback callback) {
final int sdk = Build.VERSION.SDK_INT;
if (sdk >= 23) {
return new DemoAppCompatDelegateImplV23(context, window, callback);
} else if (sdk >= 14) {
return new DemoAppCompatDelegateImplV14(context, window, callback);
} else if (sdk >= 11) {
return new AppCompatDelegateImplV11(context, window, callback);
} else {
return new AppCompatDelegateImplV7(context, window, callback);
}
}
}
class DemoAppCompatDelegateImplV14 extends AppCompatDelegateImplV14 {
DemoAppCompatDelegateImplV14(Context context, Window window, AppCompatCallback callback) {
super(context, window, callback);
}
@Override
View callActivityOnCreateView(View parent, String name, Context context, AttributeSet attrs) {
View view = DataViewFactory.createView(mWindow, parent, name, context, attrs);
if (view != null) {
return view;
}
return super.callActivityOnCreateView(parent, name, context, attrs);
}
}
DataViewFactory里主要实现view的替换,如下:
switch (name) {
case "TextView":
return new ADCompatTextView(context, attrs);
case "ImageView":
return new ADCompatImageView(context, attrs);
case "Button":
return new ADCompatButton(context, attrs);
case "LinearLayout":
return new ADLinearLayout(context, attrs);
case "RelativeLayout":
return new ADRelativeLayout(context, attrs);
case "FrameLayout":
return new ADFrameLayout(context, attrs);
}
return null;
拿ADTextView为例:
public class ADCompatTextView extends AppCompatTextView {
public ADCompatTextView(Context context) {
super(context);
}
public ADCompatTextView(Context context, AttributeSet attrs) {
super(context, attrs);
}
public ADCompatTextView(Context context, AttributeSet attrs, int defStyleAttr) {
super(context, attrs, defStyleAttr);
}
@Override
public boolean performClick() {
boolean b = super.performClick();
if (b) {
ViewBindHelper.click(this);
}
return b;
}
}
public static void click(View view) {
Map<String, Object> analyse = (Map<String, Object>) view.getTag(R.id.tag_analyse);
if (analyse != null) {
//TODO 打点代码
}
}
相当于我把这些基础的view替换掉,重写了performClick方法,在click的时候取出tag_analyse的数据进行打点。
当你在输出name时可以发现,对于自定义的view,它是输出全路径的,这就带来了一个问题,难道把所有的view都写个子类放在这里,显然也是不现实的,这时候就想到了ASM方法。
所以我写了个插件,将performClick的代码动态的添加到view中。
ASM实现AOP
private void addPerformClick(ClassWriter cw) {
MethodVisitor mw = cw.visitMethod(ACC_PUBLIC, "performClick", "()Z", null, null);
mw.visitVarInsn(ALOAD, 0);
mw.visitMethodInsn(INVOKESPECIAL, "android/view/View", "performClick", "()Z");
mw.visitVarInsn(ISTORE, 1);
mw.visitVarInsn(ILOAD, 1);
Label l1 = new Label();
mw.visitJumpInsn(IFEQ, l1);
mw.visitVarInsn(ALOAD, 0);
mw.visitMethodInsn(INVOKESTATIC, "com/example/demo/automation/ViewBindHelper", "click", "(Landroid/view/View;)V");
mw.visitLabel(l1);
mw.visitVarInsn(ILOAD, 1);
mw.visitInsn(IRETURN);
mw.visitMaxs(1, 2);
mw.visitEnd();
}
以上代码就实现了编译期向一个class文件动态添加一个重写的performClick方法,至于我是怎么把需要替换的class文件筛选出来的,大家可以参考Nuwa的插件代码,这里就不都贴出来了,太多。
接下来我写篇文章记录一下ASM的常用指令和简单应用。
view绑定数据
通过上述两种方法,基本实现了在所有的View中添加事件拦截的方法,那么还剩下怎么把数据绑定进view,这部分比较具体,我不可能把我们公司的数据设计贴出来,所以就简单讲一下思路。
1、首先需要一个定位标识,页面的任何一个view都需要一个坐标进行标识,阿里的spm即如此,它标识了某个页面某个模块某个view,至于这个标识规则如何定义,看业务情况。
2、接下来就需要将标识下发并实现与view的自动绑定,任何一个model,不管是模块model或页面model,一定会有个view跟它对应,可能是某个模块view或页面根view,这个model中可以给出一个映射关系,key用来在当前范围中查找到view,value即刚才提到的view标识,key在安卓这边可以通过id name的方式下发,甚至可以实现层级id,理论上任何一个有id的view都是可以被定位的。
实现了这套自动绑定数据,那么整个无痕打点的闭环就走通了,配置下发打点的方式理论上也是可以走通的,有很多可以想象的空间。