如何集成

集成 GioKit

GioKit 代码已托管在 Github 上，欢迎 star,fork。

info

Gradle插件版本： 3.2.1及以上
Android系统版本：Android 5.0 及以上, GioKit仅支持 AndroidX
请在 Android SDK 基础上使用 GioKit

添加依赖

在 project 级别的build.gradle文件中添加giokit-plugin依赖和 maven 仓库。

依赖

buildscript {
    repositories {
        // 添加maven仓库
        mavenCentral()
        
    }
    dependencies {
        // GioKit plugin
        classpath "com.growingio.giokit:giokit-plugin:1.4.0"
    }
}

allprojects {
    repositories {
        // 添加maven仓库
        mavenCentral()
    }
}

AGP7上依赖

plugins {
    //...
    id 'com.growingio.giokit' version "1.4.0" apply false //针对Cdp Sdk
    id 'com.growingio.giokit.saas' version "1.4.0" apply false  //针对SaaS Sdk
    //以上二者根据相应的 GrowingIO Android SDK 选择对应的插件，请不要一起使用！！
}

在 app 级别的build.gradle文件中添加com.growingio.giokit插件、giokit依赖。

CDP SDK

GrowingIO Android SDK 3.0及以上版本，请添加

apply plugin: 'com.growingio.giokit'

// 或者通过id依赖
plugins {
    //...
    id 'com.growingio.giokit'
}

SAAS SDK

GrowingIO Android SDK 2.x 版本，请添加

apply plugin: 'com.growingio.giokit.saas'

// 或者通过id依赖
plugins {
    //...
    id 'com.growingio.giokit.saas'
}

dependencies {
    ...
    // GioKit
    debugImplementation "com.growingio.giokit:giokit:1.4.0"
    releaseImplementation "com.growingio.giokit:giokit-no-op:1.4.0"
}

注意

为了避免在正式环境下出现不必要的错误，请务必只在 Debug 环境下使用 GioKit 工具。

初始化

请将 GioKit 的初始化代码放入Application的onCreate中。

java

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        GioKit.with(this).build();
    }
}

kotlin

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        GioKit.with(this).build()
    }
}

插件配置

为了满足用户的需求，我们在 Giokit 插件中添加了多项配置。

giokitExt {
    debugMode false
    enableRelease false
    // 统计该域值下所有埋点信息，如 com.growingio 表示统计 com.growingio 包名下的埋点代码
    trackFinder {
        domain = ["com.growingio.giokit.demo"]
        // 若用户自己封装了SDK customEvent 方法，可通过在此设置来查找封装类调用的代码
        // className "com.growingio.giokit.demo.AutotrackerUtils"
        // methodName "trackCustomEvent"
    }
}

1. debugMode 为true时，项目编译的时候会输出相应的 Debug 信息；
2. enableRelease 是否支持release打包。giokit 是只推荐在 debug 环境下使用，若一定要在release环境下使用，则需要打开此开关来使插件生效；
3. 为了方便统一查看用户的手动埋点信息，我们通过 trackFinder 配置来查找在应用中手动埋点调用的位置。默认查找域名为项目的ApplicationId