Gradle+ASM实战——隐私方法问题彻底解决之AsmActualCombat开源库

AsmActualCombat

功能介绍

ASM全埋点功能

  • $AppStart事件:应用程序启动启动事件。
  • $AppEnd事件:应用程序退出事件。
  • $AppViewScreen事件:应用程序页面浏览事件
  • $AppClick 事件:应用程序控件(View)点击事件,如:ImageView,Button,Dialog等
  • 默认包含防止多次点击事件的处理
  • 可动态设置方法对点击事件处理之前进行拦截,目前只支持对setOnClickListener进行拦截

隐私方法调用处理

  • 对调用隐私方法的方法体替换成自己的方法(支持动态替换方法),如:设备id,Mac地址等

辅助功能

  • 可获取方法的耗时时间
  • 打印方法的参数和返回值
  • 打印方法的Frame
  • 可动态配置是否开启插件,默认是开启

怎样使用

ASM插件依赖
Add it in your root build.gradle at the end of repositories:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "io.github.peakmain:plugin:1.1.1"
  }
}
apply plugin: "com.peakmain.plugin"

拦截事件sdk的依赖

  • Step 1. Add the JitPack repository to your build file
    Add it in your root build.gradle at the end of repositories:
    allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }
  • Step 2. Add the dependency
    dependencies {
           implementation 'com.github.Peakmain:AsmActualCombat:1.1.1'
    }

使用文档

Application中初始化

  SensorsDataAPI.init(this);

动态设置是否开启插件

在gradle.properties中设置以下参数,false代表不关闭插件,true表示关闭插件,默认是false

peakmainPlugin.disableAppClick=false

数据全埋点接口上传

SensorsDataAPI.getInstance().setOnUploadSensorsDataListener { state: Int, data: String ->
    when (state) {
            //$AppStart事件
        SensorsDataConstants.APP_START_EVENT_STATE,
            //$AppEnd事件
        SensorsDataConstants.APP_END__EVENT_STATE,
            //$AppViewScreen事件
        SensorsDataConstants.APP_VIEW_SCREEN__EVENT_STATE,
            //$AppClick 事件
        SensorsDataConstants.APP_VIEW_CLICK__EVENT_STATE
        -> if (BuildConfig.DEBUG) {
            Log.e("TAG", "埋点\n$data")
        }
        else -> if (BuildConfig.DEBUG) {
            Log.e("TAG", data)
        }
    }
}

在要拦截的页面设置拦截事件

  • 需要在app.gradle中添加拦截包名前缀,比如我的项目前缀是com.peakmain
monitorPlugin {
     ...
    interceptPackageName = "com.peakmain"
}

目前只支持setOnClickListener事件拦截

 SensorsDataAPI.getInstance().setOnUserAgreementListener(new SensorsDataAPI.OnUserAgreementListener() {
           @Override
            public boolean onUserAgreement() {
            
        }
 })

完整的举例代码如下:

    private void setUserAgreementListener(Activity activity) {
        isAcceptUserPrivacy = (Boolean) PreferencesUtils.getInstance(this).getParam(Constants.HAS_ACCEPT_USER_PRIVACY, false);
        SensorsDataAPI.getInstance().setOnUserAgreementListener(new SensorsDataAPI.OnUserAgreementListener() {
            @Override
            public boolean onUserAgreement() {
                if (!isAcceptUserPrivacy) {
                    //没有同意
                    AlertDialog dialog = new AlertDialog.Builder(activity)
                            .setContentView(R.layout.dialog_user_agreement)
                            .setCancelable(false)//点击空白不可取消
                            .show();
                     //设置用户协议的拦截事件为NULL
                    SensorsDataAPI.getInstance().setOnUserAgreementListener(null);
                    dialog.setOnClickListener(R.id.stv_refuse, v -> {
                        //取消按钮的点击事件
                        dialog.dismiss();
                        setUserAgreementListener(activity);
                    });
                    dialog.setOnClickListener(R.id.stv_agreement, v -> {
                    //同意按钮的点击事件
                        com.peakmain.ui.utils.ToastUtils.showLong("同意了");
                        PreferencesUtils.getInstance(activity).saveParams(Constants.HAS_ACCEPT_USER_PRIVACY, true);
                        dialog.dismiss();
                      
                    });
                }
                return isAcceptUserPrivacy;
            }
        });

获取方法耗时时间和打印方法参数和返回值

在需要获取耗时时间的方法上方添加以下注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogMessage {
    /**
     * 是否打印方法耗时时间
     */
    boolean isLogTime() default false;

    /**
     *
     * 是否打印方法的参数和返回值
     */
    boolean isLogParametersReturnValue() default false;

}
获取方法耗时时间

如果想获取方法耗时时间,则需要设置注解参数isLogTime为true,如:

@LogMessage(isLogTime = true)
public String getMethodTime(long l) {
    return "getMethod";
}
image.png
打印方法参数和返回值

如果想打印方法参数和返回值,则需要设置注解参数isLogParametersReturnValue,如:

@LogMessage(isLogParametersReturnValue = true)
public String getMethodParametersReturnValue(String name) {
    return "treasure";
}
image.png
获取方法耗时的同时打印方法参数和返回值

也可支持获取方法耗时的同时打印方法参数和返回值

@LogMessage(isLogTime = true, isLogParametersReturnValue = true)
public String test(int a) {
    return "peakmain";
}
image.png

打印方法的Frame

  • 1、开启堆栈分析,默认是禁用,false表示开启,true表示禁用
monitorPlugin {
    disableStackMapFrame = false
}
  • 2、如果想打印方法的Frame,只需要在方法上添加注解@LogFrameInfo,如:
@LogFrameInfo
public String testLogMethodStackMapFrame(int a) {
    try {
        Thread.sleep(1000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return "peakmain";
}

替换方法体

默认支持替换的方法
image.png
白名单

如果想让某个类不被替换,可以在whiteList中添加,如:

monitorPlugin {
    whiteList = [
            "com.peakmain.asmactualcombat.utils.TestUtils",
            "com.peakmain.plugin"
    ]
}

必须写到具体某个类,只写到包名不可用,如:上面代码写到com.peakmain.asmactualcombat.utils并不能起到白名单作用

替换方法体
使用方式
  • 使用方式app.gradle中设置methodStatus为1
monitorPlugin {
    methodStatus = 1
}
自定义替换方法的返回值
SensorsDataAPI.getInstance().setOnReplaceMethodListener(new OnReplaceMethodListener() {
    @Override
    public String onReplaceMethodListener(int telephoneState, TelephonyManager manager, int slotIndex) {
        switch (telephoneState) {
            case SensorsDataConstants.GET_DEVICE_ID:
                LogUtils.e("替换GET_DEVICE_ID");
                break;
            case SensorsDataConstants.GET_MEID:
                LogUtils.e("替换GET_MEID");
                break;
            case SensorsDataConstants.GET_IMEI:
                LogUtils.e("替换GET_IMEI");
                break;
            case SensorsDataConstants.GET_SUBSCRIBER_ID:
                LogUtils.e("替换GET_SUBSCRIBER_ID");
                break;
            case SensorsDataConstants.GET_SIM_SERIAL_NUMBER:
                LogUtils.e("替换GET_SIM_SERIAL_NUMBER");
                break;
            default:
                break;
        }
        return "";
    }

    @Override
    public String onReplaceMethodListener(int wifiInfoState, WifiInfo wifiInfo) {
        switch (wifiInfoState) {
            case SensorsDataConstants.GET_MAC_ADDRESS:
                LogUtils.e("替换GET_MAC_ADDRESS");
                break;
            case SensorsDataConstants.GET_SSID:
                LogUtils.e("替换GET_SSID");
                break;
            case SensorsDataConstants.GET_BSSID:
                LogUtils.e("替换GET_SSIDGET_BSSID");
                break;
            case SensorsDataConstants.GET_IP_ADDRESS:
                LogUtils.e("替换GET_IP_ADDRESS");
                break;
            default:
                break;
        }
        return "";
    }

    @Override
    public WifiInfo onReplaceMethodListener(WifiManager wifiManager) {
        LogUtils.e("替换WifiManager");
        return null;
    }

    @Override
    public String onReplaceMethodListener(SubscriptionInfo subscriptionInfo) {
        LogUtils.e("替换SubscriptionInfo");
        return "";
    }

    @Override
    public List<PackageInfo> onReplaceMethodListener(PackageManager manager) {
        LogUtils.e("替换PackageManager");
        return new ArrayList<>();
    }

    @Override
    public String onReplaceMethodListener(ContentResolver resolver, String name) {
        LogUtils.e("替换ContentResolver");
        return "onReplaceMethodListener";
    }
});
验证替换方法体

为了验证,我APP引入了极光推送的

未使用前

自身的APP

image.png

image.png

极光
关于极光,大家可以看这几个类的相关方法

  • cn/jiguang/an/d的getConnectionInfo

  • cn/jiguang/ap/f的getConnectionInfo

  • cn/jiguang/l/b的getConnectionInfo

  • cn/jiguang/w/c的getDeviceId

  • cn/jiguang/f/a的getDeviceId

  • cn/jiguang/f/a的getConnectionInfo

  • cn/jiguang/f/a的getMacAddress

  • cn/jiguang/w/d的getDeviceId

  • 我就不带大家看所有的了,我们挑几个
    看cn/jiguang/f/a的getMacAddress和cn/jiguang/f/a的getDeviceId

  • 因为我们看不到源码,我们只能通过字节码去看


    image.png
image.png
使用替换后
  • 添加依赖,app的build.gradle
monitorPlugin {
    whiteList = [
            "com.peakmain.asmactualcombat.utils.TestUtils",
            "com.peakmain.plugin"
    ]
    methodStatus = 1//替换方法体
    disableStackMapFrame = false
}

自身App

image.png

image.png

可以发现白名单生效了

极光推送

image.png

image.png

关于我

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

推荐阅读更多精彩内容