0x00 QuickStart_zh

快速开始

前提条件

• 首先确认你的项目是否兼容java8，因为AndroidGodEye使用了java8的语法

android {
    compileOptions {
        sourceCompatibility 1.8
        targetCompatibility 1.8
    }
}

• 其次你的项目需要迁移至androidx，从版本3.1.3开始AndroidGodEye迁移到了androidx，如果你的项目没有使用androidx，那么只能使用3.1.2及以下版本，3.1.2版本的SDK使用参考 QuickStart_3.1.2_legacy_zh

STEP1 依赖引入

在需要的Module的build.gradle中添加

dependencies {
    // 核心模块，必须依赖
    implementation 'cn.hikyson.godeye:godeye-core:VERSION_NAME'
    // Debug包配置Debug看板
    debugImplementation 'cn.hikyson.godeye:godeye-monitor:VERSION_NAME'
    // From Version 3.4.0, godeye-monitor-no-op has been removed.
    // releaseImplementation 'cn.hikyson.godeye:godeye-monitor-no-op:VERSION_NAME'
    // 额外依赖，如果项目使用OkHttp作为网络请求可以用这个库完成网络监控
    implementation 'cn.hikyson.godeye:godeye-okhttp:VERSION_NAME'
    // 额外依赖，添加此依赖可以完成Crash监控，如果不依赖则无法监控Crash（安装了也不会生效）
    implementation 'cn.hikyson.godeye:godeye-xcrash:VERSION_NAME'
    // 额外依赖，添加此依赖可以监控内存泄漏，如果不依赖则无法监控（安装了也不会生效），如果你也依赖了LeakCanary则无法依赖这个库，否则你项目中的LeakCanary会失效
    debugImplementation 'cn.hikyson.godeye:godeye-leakcanary:VERSION_NAME'
}

VERSION_NAME参考 Github release

支持页面生命周期耗时检测和方法耗时检测MethodCanary

在Root Project的build.gradle中添加

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath "cn.hikyson.methodcanary:plugin:PLUGIN_VERSION_NAME"
    }
}

PLUGIN_VERSION_NAME参考 MethodCanary github release

在Application Module Project（'com.android.application'）的build.gradle中添加

apply plugin: 'cn.hikyson.methodcanary.plugin'
AndroidGodEye {
    enableMethodTracer true // 方法耗时检测，注意，生产包中关闭它，举例，这里可以这么写：!gradle.startParameter.taskNames.contains("assembleRelease")
    enableLifecycleTracer true // 页面生命周期检测
    instrumentationRuleFilePath 'AndroidGodEye-MethodCanary.js'
    instrumentationRuleIncludeClassNamePrefix(['cn/hikyson/godeyedemo'])
}

instrumentationRuleIncludeClassNamePrefix 指定你希望监控的方法包名

在项目根目录下新建js文件：AndroidGodEye-MethodCanary.js用于配置MethodCanary的插桩逻辑，内容样例如下：

function isInclude(classInfo,methodInfo){
    return classInfo.name.startsWith('cn/hikyson/godeye/sample')
}

如何配置AndroidGodEye-MethodCanary.js

Step2 修改AndroidGodEye的配置

你可以修改AndroidGodEye的一些配置

buildTypes {
        release {
            resValue("bool", "android_god_eye_manual_install", "false") // 是否手动安装，默认false
            resValue("bool", "android_god_eye_need_notification", "false") // 是否展示通知栏，默认false，生产环境请关闭
            resValue("integer", "android_god_eye_monitor_port", "5390") // Monitor端口，默认5390
            resValue("string", "android_god_eye_install_assets_path", "android-godeye-config/install.config") // 安装配置文件在assets中的路径
        }
        debug {
            resValue("bool", "android_god_eye_manual_install", "false")
            resValue("bool", "android_god_eye_need_notification", "true")
            resValue("integer", "android_god_eye_monitor_port", "5390")
            resValue("string", "android_god_eye_install_assets_path", "android-godeye-config/install.config")
        }
    }

然后在项目的assets目录中添加android-godeye-config/install.config文件，这个文件用于描述所有需要安装的模块配置，就像Sample项目中的：install.config

如果你想要自己手动安装，指定 android_god_eye_manual_install 为 true

STEP3 安装IDE插件

在AndroidStudio中安装AndroidGodEye插件，在AndroidStudio plugin中直接搜索AndroidGodEye即可，安装完之后会在工具栏中出现AndroidGodEye的icon，点击即可在浏览器中打开性能监控面板。

不安装插件，也可以使用脚本方式打开

端口冲突修改端口

完成，你现在可以在Debug看板中看到你的App的性能了

注：手机USB连接电脑，打开开发者选项，允许USB调试

3.4.0版本以下需要更多步骤 QuickStart_3.3.x