简介

用于Android客户端无埋点数据采集的Gradle插件。

Gradle Plugin for Codelessly Data Acquisition on Android Platform.

本插件基于开源项目HiBeaver^_^

开发环境

• 语言：Groovy
• 字节码操作库：ASM5.0
• 工具：Android Studio 2.2(Mac)
• Gradle：1.5+

使用

使用本插件，您可能需要做些自定义的配置，比如在ReWriterConfig中配置注入代码的类名及待注入的方法映射

例如

public static String sAgentClassName = 'com/codelessda/demo/PluginAgent'

sInterfaceMethods.put('onClick(Landroid/view/View;)V', new MethodCell(
                'onClick',
                '(Landroid/view/View;)V',
                'android/view/View$OnClickListener',
                'onClick',
                '(Landroid/view/View;)V',
                1, 1,
                [Opcodes.ALOAD]))

上述代码表明当一个Activity或Fragment实现了View$OnClickListener接口时，使用本插件遍历到该Activity或Fragment字节码中的onClick(View v)时，向该方法中插入com.codelessda.demo.PluginAgent.onClick(v)。com.codelessda.demo.PluginAgent中的onClick(View v)方法即是您想要注入到点击事件响应onClick中的代码。

1. 本地插件集成

app的build.grade中添加

// 直接引用buildsrc的插件类
apply plugin: com.codelessda.plugin.InjectPluginImpl

2. 自定义参数

app的build.grade中添加如下代码，各配置项的含义请参考英文注释

codelessdaConfig {
    //this will determine the name of this plugin transform, no practical use.
    pluginName = 'myPluginTest'
    //turn this on to make it print help content, default value is true
    showHelp = true
    //this flag will decide whether the log of the modifying process be printed or not, default value is false
    keepQuiet = false
    //this is a kit feature of the plugin, set it true to see the time consume of this build
    watchTimeConsume = false

    //this is the most important part, 3rd party JAR packages that want our plugin to inject;
    //our plugin will inject package defined in 'AndroidManifest.xml' and 'butterknife.internal.butterknife.internal.DebouncingOnClickListener' by default.
    //structure is like ['butterknife.internal','com.a.c'], type is HashSet<String>.
    //You can also specify the name of the class;
    //example: ['com.xxx.xxx.BaseFragment']
    targetPackages = []
}

3. 远程插件集成

这一步需要您修改好ReWriterConfig后，发布插件到远程仓库，然后在app中引用远程插件。具体步骤请参考CodelessDA-Gradle-Plugin-Repo

AOP在无埋点中的应用

1. 目标方法在Fragment中声明

目标方法：

• onResume()V
• onPause()V
• setUserVisibleHint(Z)V
• onHiddenChanged(Z)V

具体实现：

• 对app中指定包进行扫描，筛选出所有父类为android/app/Fragment或android/support/v4/app/Fragment的类。
• 对这些Fragment子类的onResumed，onPaused，onHiddenChanged，setFragmentUserVisibleHint方法的字节码进行修改，添加数据采集代码。

目标效果：

public class BaseFragment extends Fragment {
    public BaseFragment() {
    }

    public void onResume() {
        super.onResume();
        PluginAgent.onFragmentResume(this);
    }

    public void onHiddenChanged(boolean var1) {
        super.onHiddenChanged(var1);
        PluginAgent.onFragmentHiddenChanged(this);
    }

    public void onPause() {
        super.onPause();
        PluginAgent.onFragmentPause(this);
    }

    public void setUserVisibleHint(boolean var1) {
        super.setUserVisibleHint(var1);
        PluginAgent.setFragmentUserVisibleHint(this, var1);
    }
}

2. 目标方法在接口中声明

目标方法：

• onClick(Landroid/view/View;)V
• onClick(Landroid/content/DialogInterface;I)V
• onItemClick(Landroid/widget/AdapterView;Landroid/view/View;IJ)V
• onItemSelected(Landroid/widget/AdapterView;Landroid/view/View;IJ)V
• onGroupClick(Landroid/widget/ExpandableListView;Landroid/view/View;IJ)Z
• onChildClick(Landroid/widget/ExpandableListView;Landroid/view/View;IIJ)Z
• onRatingChanged(Landroid/widget/RatingBar;FZ)V
• onStopTrackingTouch(Landroid/widget/SeekBar;)V
• onCheckedChanged(Landroid/widget/CompoundButton;Z)V
• onCheckedChanged(Landroid/widget/RadioGroup;I)V
• ...

具体实现：

• 对app中指定包进行扫描，筛选出实现了目标接口的类，在目标方法中添加数据采集代码。

例如，筛选出实现了android/view/View$OnClickListener接口的类，然后在onClick(Landroid/view/View;)V方法中注入采集数据的代码。

目标效果：

public class MainActivity extends AppCompatActivity implements OnClickListener, android.content.DialogInterface.OnClickListener, OnItemClickListener, OnItemSelectedListener, OnRatingBarChangeListener, OnSeekBarChangeListener, OnCheckedChangeListener, android.widget.RadioGroup.OnCheckedChangeListener, OnGroupClickListener, OnChildClickListener {
    public MainActivity() {
    }

    protected void onCreate(Bundle var1) {
        super.onCreate(var1);
        this.setContentView(2130968603);
    }

    public void onClick(View var1) {
        PluginAgent.onClick(var1);
    }

    public void onClick(DialogInterface var1, int var2) {
        PluginAgent.onClick(this, var1, var2);
    }

    public void onItemClick(AdapterView<?> var1, View var2, int var3, long var4) {
        PluginAgent.onItemClick(this, var1, var2, var3, var4);
    }

    public void onItemSelected(AdapterView<?> var1, View var2, int var3, long var4) {
        PluginAgent.onItemSelected(this, var1, var2, var3, var4);
    }

    public void onNothingSelected(AdapterView<?> var1) {
    }

    public void onCheckedChanged(CompoundButton var1, boolean var2) {
        PluginAgent.onCheckedChanged(this, var1, var2);
    }

    public boolean onChildClick(ExpandableListView var1, View var2, int var3, int var4, long var5) {
        PluginAgent.onChildClick(this, var1, var2, var3, var4, var5);
        return false;
    }

    public boolean onGroupClick(ExpandableListView var1, View var2, int var3, long var4) {
        PluginAgent.onGroupClick(this, var1, var2, var3, var4);
        return false;
    }

    public void onCheckedChanged(RadioGroup var1, int var2) {
        PluginAgent.onCheckedChanged(this, var1, var2);
    }

    public void onRatingChanged(RatingBar var1, float var2, boolean var3) {
        PluginAgent.onRatingChanged(this, var1, var2, var3);
    }

    public void onProgressChanged(SeekBar var1, int var2, boolean var3) {
    }

    public void onStartTrackingTouch(SeekBar var1) {
    }

    public void onStopTrackingTouch(SeekBar var1) {
        PluginAgent.onStopTrackingTouch(this, var1);
    }
}

ASM语法实战

目标方法对应的ASM字节码操作