编写一个Android Gradle插件

已于 2022-05-26 23:00:25 修改
阅读量518 收藏 1
点赞数
分类专栏： 工利其器 安卓&Maven&Gradle 文章标签： Android
于 2022-05-26 22:59:38 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hanly_jiang/article/details/124994589
版权

gradle有三种编写插件的方式，我们这里使用在项目中的buildSrc模块中编写插件的方式，自定义了一个应用于Android项目的根据flavor过滤so库的gradle插件；

概述

自定义gradle插件有如下三种方式（🔗链接）：

  1. 在buildscript中直接编写；
  2. 在buildSrc项目中编写插件代码；
  3. 在独立的项目中编写插件代码；

这里我们将使用buildSrc方式实现一个gradle插件。

新建 buildSrc module

gradle会在项目中寻找名称为buildSrc模块，将其加载为gradle的插件代码目录。所以我们直接通过菜单新建一个名为 buildSrc 的java/kotlin模块。

然后在build.gradle中添加相关的plugin(java-gradle-plugin)及依赖：

plugins {
    id 'java'
    id 'java-gradle-plugin'
    id "org.jetbrains.kotlin.jvm" version '1.3.61'
}

group = "io.github.hanlyjiang.gradle"
version = "0.0.2"

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
    // 添加android相关build tools依赖，以便使用 android gradle 相关的API
    compile 'com.android.tools.build:gradle:3.2.0'
}

编写插件

需求简介

  • **应用场景：**我们的产品中集成了两种VPN SDK，但是具体到每个项目上面，都只会落地到具体的一种，这个时候需要排除对应的SDK的SO库以减小APP包大小，不同的地区的打包配置通过flavor来进行区分配置，即每个地区会对应不同的flavor；

  • 需求提取： 这里实际上我们需要的是能够根据flavor，在打包过程中移除指定的so文件；

  • 实现思路：

    • flavor配置方式：在flavor中配置一个buildConfigField字段，用于指定我们的flavor需要的配置

      // 配置VPN类型
buildConfigField "String", "VPN_TYPE", "\"$VpnType.SANG_FOR\""

    • 插件配置：我们使用一个so_exclude配置来指定具体的exclude规则，包含两个字段。

      • buildConfigFieldKey 用于指定之前在flavor中定义的配置；
      • configMap 为一个配置表，指定上面的字段可取的值，即对应值应该exclude的so文件列表；
      so_exclude {
    /**
     * 使用VPN_TYPE 来设置so过滤的规则
     */
    buildConfigFieldKey = "VPN_TYPE"
    configMap = [
            (VpnType.H3C_iNode.name()): [
                    // 新华三过滤深信服的
                    "lib/armeabi-v7a/libauth_forward.so",
                    "lib/armeabi-v7a/libhttps.so",
                    "lib/armeabi-v7a/libpkcs12cert.so",
                    "lib/armeabi-v7a/libsvpnservice.so"
            ],
            (VpnType.SANG_FOR.name()) : [
                    // 深信服过滤新华三的
                    "lib/armeabi-v7a/libies.so",
            ],
            (VpnType.NONE.name())     : [
                    // 如配置成 NONE，则过滤掉所有的VPN的
                    // 深信服的so
                    "lib/armeabi-v7a/libauth_forward.so",
                    "lib/armeabi-v7a/libhttps.so",
                    "lib/armeabi-v7a/libpkcs12cert.so",
                    "lib/armeabi-v7a/libsvpnservice.so",
                    // inode的so
                    "lib/armeabi-v7a/libies.so",
            ]
    ]
}

定义插件及使用插件简介

  • 插件需要继承 org.gradle.api.Plugin，可在Plugin对构建流程进行自定义（如：创建任务，定义任务关系，修改已有任务动作等）
  • 插件如果需要能够读取一些配置，可通过 project.extensions.create 来从build.gradle中提取
  • 如需在自己的 android代码模块中使用插件，通过 apply plugin: 插件类引用即可

插件实现

  • 插件的实现如下：
    • 读取 so_exclude 配置，存储到 extension（类型为 FlavorSoExcludePluginExtension ）中
    • 读取 android 的配置，找到 AppExtension类型的配置，也就是应用了 apply application 的模块的配置，我们的项目中只有一个app模块应用此配置-即我们的apk模块；
    • 遍历所有变体，获取对应变体的 so_exclude 对应的配置字段的值，建立flavor到配置值的映射表；
    • 修改 packageApplication 任务，让其在执行之前即删除待打包临时目录中的对应so文件；
package io.github.hanlyjiang.gradle.plugin.soexclude

import com.android.build.gradle.AppExtension
import com.android.build.gradle.api.ApkVariantOutput
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.logging.LogLevel
import org.gradle.api.logging.Logger
import org.gradle.api.logging.Logging
import java.io.File

/**
 * so 插件的 gradle 配置实体
 */
open class FlavorSoExcludePluginExtension {

    /**
     * so 过滤配置表
     */
    var configMap: Map<String, List<String>>? = null

    /**
     * 配置字段的名称
     */
    var buildConfigFieldKey: String = FlavorSoExcludePlugin.DEFAULT_CONFIG_KEY
}

/**
 * flavor so 打包过滤配置
 *
 * ## 用法说明：
 *
 * 1. 在build.gradle 中引入插件 <code>apply plugin: FlavorSoExcludePlugin</code>;
 * 2. 添加 so_exclude 配置段：
 *
 * ```groovy
 * so_exclude {
 *   buildConfigFieldKey = "VPN_TYPE"
 *   configMap = [
 *       (VpnType.H3C_iNode.name()): [
 *           "lib/armeabi-v7a/libauth_forward.so",
 *           "lib/armeabi-v7a/libhttps.so",
 *           "lib/armeabi-v7a/libpkcs12cert.so",
 *           "lib/armeabi-v7a/libsvpnservice.so"
 *      ],
 *      (VpnType.SANG_FOR.name()) : [
 *           "lib/armeabi-v7a/libies.so",
 *       ],
 *       (VpnType.NONE.name())     : [
 *               // 深信服的so
 *               "lib/armeabi-v7a/libauth_forward.so",
 *               "lib/armeabi-v7a/libhttps.so",
 *               "lib/armeabi-v7a/libpkcs12cert.so",
 *               "lib/armeabi-v7a/libsvpnservice.so",
 *               // inode的so
 *               "lib/armeabi-v7a/libies.so",
 *        ]
 *   ]
 *}
 *```
 * 3. 在flavor的配置中添加 buildConfigField 配置，如：
 * ```
 * buildConfigField "String", "VPN_TYPE", "\"$VpnType.H3C_iNode\""
 * ```
 * 其中字段的名称为 之前 so_exclude 中配置的 `buildConfigFieldKey` 字段，对应的值为 configMap 中的 key ，如此配置后，打包时就会将configMap对应key中的so列表过滤掉
 * @author hanlyjiang 09/20/20 2:42 PM
 * @version 1.0
 */
class FlavorSoExcludePlugin : Plugin<Project> {
    companion object {
        const val PLUGIN_NAME = "FlavorSoExcludePlugin"
        const val DEFAULT_CONFIG_KEY = "SO_EXCLUDE"
        const val DEBUG = false

        private val logger: Logger = Logging.getLogger(FlavorSoExcludePlugin::class.java)

        fun logInfo(msg: String) {
            logger.log(LogLevel.LIFECYCLE, "<- $PLUGIN_NAME: $msg ->")
        }

        fun logDebug(msg: String) {
            if (DEBUG) {
                logInfo(msg)
            }
        }
    }

    lateinit var extension: FlavorSoExcludePluginExtension

    override fun apply(project: Project) {
        // 添加自己的配置
        extension = project.extensions.create("so_exclude", FlavorSoExcludePluginExtension::class.java)

        // 创建一个打印配置的任务，用于定义
        val task = project.tasks.create("printConfig")
        task.group = "soExclude-plugin"
        task.doLast {
            logInfo("-- 配置字段：buildConfigFieldKey= " + extension.buildConfigFieldKey)
            logInfo("-- 当前配置：")
            extension.configMap?.run {
                this.keys.forEach { key ->
                    logInfo("-- config: $key -- ")
                    get(key)?.forEach {
                        logInfo("values: $it")
                    }
                    logInfo("------------------ ")
                }
            }
        }
		// 获取android的配置
        val androidExtensions = project.extensions.getByName("android")
        logInfo("" + androidExtensions.javaClass)
        if (androidExtensions is AppExtension) { 
            // applicatoin类型的就进行任务处理
            initPackageOptions(project, androidExtensions)
        }
    }


    /**
     * vpn 配置
     */
    private var configMap: MutableMap<String, String> = HashMap()

    private fun initPackageOptions(project: Project, android: AppExtension) {
        project.afterEvaluate {
            android.productFlavors.all {
                val flavorName = it.name
                logDebug("--productFlavors : ${it.name}")
                var soExcludeConfig = ""
                it.buildConfigFields[extension.buildConfigFieldKey]?.run {
                    soExcludeConfig = value.replace("\"", "")
                }
                logDebug("--productFlavors : $flavorName, soExcludeConfig: $soExcludeConfig")
                configMap[flavorName] = soExcludeConfig
            }
            android.applicationVariants.all { variant ->
                logDebug("app variant flavorName: ${variant.flavorName}")
                val flavorName = variant.flavorName
                val configKey = configMap[flavorName]
                variant.outputs.forEach { output ->
                    if (output is ApkVariantOutput) {
                        //核心逻辑：修改packageApplication任务，在生成apk包之前，删除打包临时目录中的so文件即可避免打包so到apk中
                        output.packageApplication.doFirst {
                            output.packageApplication.jniFolders.all {
                                // jniFolder 目录为最后打包apk时，用于存放so文件的临时目录
                                logInfo("变体名称: ${variant.flavorName} , configKey: ${configKey}, jniFolders: " + it.absoluteFile)
                                handleExclude(it, configKey);
                                true
                            }
                        }
                    }
                }
            }
        }
    }

    private fun handleExclude(jniFolder: File?, configKey: String?) {
        extension.configMap?.run {
            val soExcludeList: List<String>? = get(configKey)
            soExcludeList?.run {
                deleteJniSoFiles(jniFolder, *(soExcludeList.toTypedArray()))
            }
        }

    }

    private fun deleteJniSoFiles(jniFolder: File?, vararg files: String) {
        for (item in files) {
            val file = File(jniFolder, item)
            if (file.exists()) {
                val deleteResult = file.delete()
                logInfo("删除so文件 $item : ${if (deleteResult) "成功" else "失败"}")
            }
        }
    }

}

使用枚举进行配置

我们在buildSrc中定义一个枚举类，用于约定可以配置的值，即可以清晰定义配置值避免配置时直接写字符串容易出错，又可以支持代码自动补全方便配置。

package io.github.hanlyjiang.gradle.plugin.vpn

/**
 * VPN 类型
 */
enum class VpnType {
    /**
     * 深信服
     */
    SANG_FOR,

    /**
     * 新华三
     */
    H3C_iNode,

    /**
     * 不使用VPN
     */
    NONE,
}
/**
 * VPN 类型
 */
enum class VpnType {
    /**
     * 深信服
     */
    SANG_FOR,

    /**
     * 新华三
     */
    H3C_iNode,

    /**
     * 不使用VPN
     */
    NONE,
}

使用插件

  1. 通过 apply plugin 引入插件，直接使用插件类名称即可；
  2. 枚举配置使用，在gradle配置中导入对应的枚举类，然后直接使用即可：

具体配置如下：

// app/build.gradle
import io.github.hanlyjiang.gradle.plugin.soexclude.FlavorSoExcludePlugin
import io.github.hanlyjiang.gradle.plugin.vpn.VpnType

apply plugin: 'com.android.application'
// 应用插件
apply plugin: FlavorSoExcludePlugin

so_exclude {
    /**
     * 使用VPN_TYPE 来设置so过滤的规则
     */
    buildConfigFieldKey = "VPN_TYPE"
    configMap = [
            (VpnType.H3C_iNode.name()): [
                    // 新华三过滤深信服的
                    "lib/armeabi-v7a/libauth_forward.so",
                    "lib/armeabi-v7a/libhttps.so",
                    "lib/armeabi-v7a/libpkcs12cert.so",
                    "lib/armeabi-v7a/libsvpnservice.so"
            ],
            (VpnType.SANG_FOR.name()) : [
                    // 深信服过滤新华三的
                    "lib/armeabi-v7a/libies.so",
            ],
            (VpnType.NONE.name())     : [
                    // 如配置成 NONE，则过滤掉所有的VPN的
                    // 深信服的so
                    "lib/armeabi-v7a/libauth_forward.so",
                    "lib/armeabi-v7a/libhttps.so",
                    "lib/armeabi-v7a/libpkcs12cert.so",
                    "lib/armeabi-v7a/libsvpnservice.so",
                    // inode的so
                    "lib/armeabi-v7a/libies.so",
            ]
    ]
}

android {
    defaultConfig {
        // 配置VPN类型
        buildConfigField "String", "VPN_TYPE", "\"$VpnType.SANG_FOR\""
    }
    productFlavors {
        // ...
    }
}

参考文档

HanlyJiang
关注
专栏目录
【Android gradle】自定义一个android gradle插件，并发布到私有Artifactory仓库
梦否
12-09 1645
最近工作部分内容涉及到gradle插件的编写，在粗浅了解和编码之余来简单梳理下编写一个gradle插件的相关用法。这里编写的插件还是发布到在前面两篇博客中的仓库中。gradleTask。
配置 build --- Android Gradle 插件 ---了解Android构建系统
半夏微凉科技
05-15 722
Android 构建系统会编译应用资源和源代码，然后将它们打包成 APK 或 Android App Bundle 文件，供您测试、部署、签名和分发。 Android Studio 使用高级构建工具包 Gradle 来自动执行和管理构建流程，同时也允许您自行指定灵活的 build 配置。每项 build 配置均可定义各自的一组代码和资源，同时重复利用所有应用版本共用的部分。Android Gradle 插件与该构建工具包搭配使用，提供专用于构建和测试 Android 应用的流程和可配置设置。
Android开发自定义Gradle插件
Tiger的专栏
06-11 1234
目录 1.在自己的module（例如：app）中build.gradle中定义插件 2.创建当前项目的插件 3.创建通用插件，发布到maven 3.1.创建module 3.2利用mavenDeployer发布插件 3.3定义plugin应用 在android studio中gradle作为主要的构建工具，其核心工作任务在于执行一系列的Task，而plugin在gradle构建过程又扮演着举足轻重的角色，有时为了完成相应的构建任务必须通过引入相应的插件来辅助，这些插件中定义了构建Projec.
com android build gradle libraryplugin,Android自定义Aop的Gradle Plugin
weixin_29051811的博客
05-28 475
[上一篇文章]中讲解了如何在Android使用AOP，会发现在Gradle配置aop会比较麻烦，每个module使用了aop都需要配置。接下来看如何简化配置。 1、创建Module 首先，需要建立一个Android Library，命名为aop-plugin，如图： 2、删除文件 由于plugin是由groovy进行创建的，需要删除红色框内的文件 3、更改gradle 把module里面的bui...
Gradle Android Plugin 使用指南
最新发布
gitblog_00335的博客
09-04 797
Gradle Android Plugin 使用指南 gradle-android-pluginAndroid plugin for the Gradle build system.项目地址:https://gitcode.com/gh_mirrors/gr/gradle-android-plugin 1. 项目目录结构及介绍 GitHub上的gradle-android-plugin是一个早...
Android Plugin源码与Gradle构建（一）
Running&H的博客
09-13 297
一、前言 现在Android开发最常用的IDE就是Android Studio了。在Android Studio中使用了Gradle构建功能，这使得模块之间的管理、依赖都非常的方便清晰。 同时，国内比较火热的Android插件化、热更新等都涉及到了Gradle插件的知识，熟练的掌握Gradle，可以让我们更加清楚的了解Android的构建过程，改造构建过程以达到某些功能需求。从这个角度来说，And...
Error:'com.android.build.gradle.BasePlugin' does not implement the Plugin interface
仙桃小园
08-16 2938
解决：Error:’com.android.build.gradle.BasePlugin’ does not implement the Plugin interface
android 资产管理源码_【Android 修炼手册】Android Gradle Plugin 插件主要流程
weixin_39609071的博客
11-20 202
预备知识理解 gradle 的基本开发了解 gradle task 和 plugin 使用及开发了解 android gradle plugin 的使用看完本文可以达到什么程度了解 android gradle plugin 的构建流程了解 android gradle plugin 的主要 task 的实现学会 hook android 构建流程，添加自己想要的功能阅读前准备工作1.项目添加 a...
AndroidStudio自定义Gradle插件
12-26
总结，自定义Gradle插件是Android Studio项目构建过程中的一个重要环节，它提供了高度的灵活性和定制性。通过理解Gradle插件的工作原理和Android Studio的相关API，开发者可以有效地提升构建效率，优化项目结构，...
Android Gradle （一）Gradle的Android插件入门
Android进阶三部曲 - 刘望舒
04-05 2935
相关文章 Gradle核心思想（一）为什么现在要用Gradle？ Gradle核心思想（二）Gradle入门前奏 Gradle核心思想（三）Groovy快速入门指南 Gradle核心思想（四）看似无用，实则重要的Gradle Wrapper Gradle核心思想（五）通俗易懂的Gradle插件讲解 Gradle核心思想（六）自定义Gradle插件的三种方式 前言 在Gradle核心思想这个系列中...
com android build gradle libraryplugin,build.gradle
weixin_42122838的博客
05-28 235
buildscript {repositories {maven { url '../../prebuilts/gradle-plugin' }maven { url '../../prebuilts/tools/common/m2/repository' }maven { url '../../prebuilts/tools/common/m2/internal' }}dependencies ...
android 自定义plugin,android开发中自定义gradle plugin
weixin_39646412的博客
05-25 507
在android studio中gradle作为主要的构建工具，其核心工作任务在于执行一系列的Task。而plugin在gradle构建过程又扮演着举足轻重的角色，有时为了完成相应的构建任务必须通过引入相应的插件来辅助，这些插件中定义了构建Project需要的一系列Task，并且负责执行相应的Task，比如构建android应用'com.android.application',构建Library...
android studio 本地加载 gradle Plugins
kuangben2000的博客
05-02 2256
(1) android studio 本地加载 gradle Plugins (2) Android studio build.gradle 基本设置配置 https://blog.csdn.net/weimingjue/article/details/84965391 ps：博主的这套配置让你的项目可以在任意电脑使用as打开无需额外文件、无需额外配置哦，当然as的版本是不能差距太大...
Unable to find method'com.android.build.gradle.api.BaseVariant.getOutputs()Ljava/util/List' 构建错误解决办法
星留影的刹那间
08-19 7848
最近在做项目的时候，突然IDE来了个提示Gradle升级，升级之后就出现了如下的build构建错误提示信息，弄了许久才解决问题，所以想在这里总结一下，也能做个解决问题的参考 Unable to find method'com.android.build.gradle.api.BaseVariant.getOutputs()Ljava/util/List' Possible cau...
解决Android Studio中Plugin version和Gradle version不匹配的问题
热门推荐
博来品
07-03 2万+
AS编译提示： A problem occurred evaluating project ':app'. > Failed to apply plugin [id 'com.android.application'] > Minimum supported Gradle version is 3.3. Current version is 3.0. 解决办法参考。
【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 主要流程分析
weixin_33842328的博客
05-15 207
预备知识 理解 gradle 的基本开发 了解 gradle task 和 plugin 使用及开发 了解 android gradle plugin 的使用 看完本文可以达到什么程度 了解 android gradle plugin 的构建流程 了解 android gradle plugin 的主要 task 的实现 学会 hook android 构建流程，添加自己想要的功能 阅读前...
Unable to find method 'com.android.build.gradle.api.BaseVariant.get异常解决
jia_you1的博客
07-01 1372
butterknife已经升级到8.8.1版本了，说实话确实是好用，不然也不会一直在使用它，最近一直打算写一个及时通讯的项目。顺便熟悉一下升级后的Android studio。和平常创建项目一样的步骤，果然真的是每一次升级都是一段血泪史，一点也不出意外的报错。 我能怎么办，我也很绝望。 好了反正是经过各种排查确认，最后确定了根源，也就是最后的罪魁祸首，butterknife。马上去Gi...
com android build gradle libraryplugin,android开发里跳过的坑-AS导入NDK工程提示错误 No such property: sdkHandler for...
weixin_39797532的博客
05-28 223
接到一个NDK工程需要调试，导入后发现总是提示错误Error:(37, 1) A problem occurred evaluating project ‘:libuvccamera‘.> No such property: sdkHandler for class: com.android.build.gradle.LibraryPlugin百度上各种说法，有说要降低gadle版本，有说要...
Android Studio自定义Gradle插件实战教程
本篇教程详细介绍了如何为Android Studio编写自定义Gradle插件。随着Android Studio作为安卓开发的主要IDE被广泛采用，理解并掌握如何创建自己的Gradle插件变得尤为重要。Gradle作为Android Studio背后的构建工具，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值