Skip to main content

AGP 插件说明

Android Gradle Plugin 高版本说明及其使用方法

Growingio Sdk Gradle Plugin 在V3.4.0 重新开发后，实现了更多的功能：

  • 适配 AGP 8.0 Instrumentation API；
  • 兼容 AGP4.2及其更早版本的 Transform API；
  • 优化插件对脱糖的处理；
  • 兼容 AGP 7.0 及其以上 pluginManagement 的依赖方式；
  • 提供了完整的单元测试。
开源信息

Github 项目地址为 GrowingIO Android SDK Plugin，欢迎 star, fork。

如何集成​

这里只说明在 Android Gradle插件为7.0及以上版本时的集成方式，若是AGP7以下则按照 插件集成 集成即可

添加 Maven 仓库​

需要在 project 中的 settings.gradle 文件中添加Maven仓库

// 当AGP版本为7.0及以上添加
pluginManagement {
    repositories {
        // 添加maven仓库
        mavenCentral()
        //如果使用 SNAPSHOT 版本，则需要使用如下该仓库。
        maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
        gradlePluginPortal()
        google()
      
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        // 添加maven仓库
        mavenCentral()
        //如果使用 SNAPSHOT 版本，则需要使用如下该仓库。
        maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
        google()
    }
}

添加插件路径​

需要在 project 下的 build.gradle 下添加 Growingio 插件

plugins {
    id 'com.android.application' version '7.2.0' apply false

    ···
    // 添加GrowingIO 无埋点 SDK 插件
    id 'com.growingio.android.autotracker' version '3.5.4' apply false
}

使用插件​

在 app 级别的 build.gradle 文件中添加 com.growingio.android.autotracker 插件

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    // 使用 GrowingIO 无埋点 SDK 插件
    id 'com.growingio.android.autotracker'
}
...

插件配置说明​

为了满足插件在不同项目环境下能够正常使用，Growingio 插件提供了以下配置。（非必需情况下可以不用添加）

Extension参数类型是否必填默认值说明版本
logEnabledBoolean否false编译时是否输出log日志
skipDependencyCheckBoolean否false编译时检测当前project是否配置SDK依赖（模块中依赖时配置为true）
includePackagesArray<String>否null需要额外包含编译的包名
excludePackagesArray<String>否null需要跳过编译的包名

配置代码示例

plugins {
    ···
    // 使用 GrowingIO 无埋点 SDK 插件
    id 'com.growingio.android.autotracker'
}

growingAutotracker {
    logEnabled false
    includePackages "com.growingio.xxx1","com.growingio.xxx2"
    excludePackages "com.cpacm.xxx1"
}


dependencies {
  ···
}