Android Gradle 开发与应用 (六) : 创建buildSrc插件和使用命令行创建Gradle插件

柔光的暖阳◎ 2024-04-25 20:26 70阅读 0赞

### 1. 前言 ###

[前文][Link 1]中，我们介绍了在`Android`中，如何基于`Gradle 8.2`，创建`Gradle`插件。这篇文章，我们以`buildSrc`的方式来创建`Gradle`插件。此外，还介绍一种用`Cmd`命令行的方式，来创建独立的`Gradle`插件的方式。

#### 1.1 本文环境 ####

*  `Android Studio` 版本 : `Android Studio Iguana | 2023.2.1`
 *  `Gralde`版本 : `gradle 8.4`

### 2. buildSrc插件 ###

`buildSrc`是一个特殊的源代码集，通常用于存放项目内部使用的自定义Gradle插件和任务。它的主要优势在于它会自动被`Gradle`识别并编译，然后`Android Studio`自动会将其添加到构建脚本的`classpath`中，因此无需手动添加或配置。这使得在项目的多个模块之间共享构建逻辑变得非常方便。此外，由于`buildSrc`是项目的一部分，因此它可以直接访问和使用项目中的其他代码和资源。

> 不用把`buildSrc`看成一个特别奇怪的东西，这个玩意儿就是个普通的`java`项目，它运行完后，会生成一个`jar`包 (`buildSrc/build/libs/buildSrc.jar`)，然后它会自动添加到整个项目的`build.gradle.kts`脚本的`classpath`里面。

#### 2.1 buildSrc插件和独立Gradle插件的区别 ####

相比之下，单独的`Gradle`插件通常作为独立的项目来开发，并通过二进制形式（如`jar包`）发布到仓库中，供其他项目使用。这种插件通常具有更广泛的适用性，因为它们设计用于多个项目之间的复用。然而，开发这种插件需要更多的配置和发布步骤，并且它们不会直接访问到使用它们的项目的内部代码和资源。

#### 2.2 新建buildSrc目录 ####

在项目的根目录下，新建`buildSrc`文件夹，并添加如下的项目结构

![在这里插入图片描述][1a2d763ae280d0fe3901335c35ae8edb.png_pic_center]

`buildSrc`目录下的`build.gradle`中写下如下的内容

plugins {
        
        id 'java-gradle-plugin'
    }
    
    gradlePlugin {
        
        plugins {
        
            greeting {
        
                id = 'com.heiko.buildsrc.plugin' //这里是插件的ID
                implementationClass = 'com.heiko.buildsrc.MyPlugin' //这里是包名+类名
            }
        }
    }

这里需要注意  
`Plugin`用`java`语言编写，那么包名的上一级为`java`文件夹，`plugin`用`java-gradle-plugin`

plugins {
        
        id 'java-gradle-plugin'
    }

`Plugin`用`groovy`语言编写，那么包名的上一级为`groovy`文件夹`plugin`用`groovy`

plugins {
        
    	id 'groovy'
    }

`Plugin`用`kotlin`语言编写，那么包名的上一级为`kotlin`文件夹，`plugin`用`org.gradle.kotlin.kotlin-dsl`

plugins {
        
    	id("org.gradle.kotlin.kotlin-dsl") version "4.1.2"
    }
    
    使用 kotlin-dsl 插件的时候，需要mavenCentral仓库
    repositories {
        
        mavenCentral()
    }

#### 2.3 依赖插件 ####

我们`Sync`下项目，`Android Studio`自动会将其添加到构建脚本的`classpath`中。  
接着我们只需要在`app`的`build.gradle`中，去应用这个插件就可以使用了。

plugins {
        
        //省略了其他插件...
        
        //应用我们自定义的com.heiko.buildsrc.plugin插件
        id("com.heiko.buildsrc.plugin") apply true
    }

#### 2.4 查看日志 ####

再次`Sync`下项目，可以看到如下日志，就表明我们配置`buildSrc`插件成功了 !

//...省略了其他日志 ...
    > Configure project :app
    这是我的第一个Gradle插件:MyPlugin.apply!
    
    > Task :prepareKotlinBuildScriptModel UP-TO-DATE
    greeting config
    
    //...省略了其他日志 ...
    
    BUILD SUCCESSFUL in 14s
    4 actionable tasks: 2 executed, 2 up-to-date

### 3.使用build.gradle.kts来新建buildSrc插件 ###

使用`build.gradle.kts`和使用`build.gradle`基本是一样的，只需要将`build.gradle`修改为`build.gradle.kts`，然后将里面的代码从`Groovy`修改为`Kotlin`即可

plugins {
        
        //Plugin用Java语言编写时需添加
        `java-gradle-plugin` //等同于 id("java-gradle-plugin") apply true
    
        //Plugin用Groovy语言编写时需添加
        `groovy` //等同于 id("groovy") apply true
    
        //Plugin用Kotlin语言编写时需添加
        `kotlin-dsl` //等同于 id("org.gradle.kotlin.kotlin-dsl") version "4.1.2"
        // 也可以用 id("org.jetbrains.kotlin.jvm") version "1.9.10" apply true (不建议，这个只有Kotlin的语法，而没有Kotlin DSL的语法)
    
    }
    
    //使用 kotlin-dsl / org.jetbrains.kotlin.jvm 的时候，需要mavenCentral仓库
    repositories {
        
        mavenCentral()
    }
    
    
    gradlePlugin {
        
        plugins {
        
            create("greeting") {
        
                id = "com.heiko.buildsrc.plugin"
                //Java插件主类
                //implementationClass = "com.heiko.buildsrc.MyPlugin"
                //Groovy插件主类
                //implementationClass = "com.heiko.buildsrc.MyPluginGroovy"
                //Kotlin插件主类
                implementationClass = "com.heiko.buildsrc.MyPluginKotlin"
            }
        }
    }

### 4. 更方便的新建插件的方式 : 命令行 ###

除了在`Android Studio`中手动新建插件，我们还可以通过命令行来新建插件。

#### 4.1 新建文件夹 ####

首先需要新建一个文件夹，在文件夹里复制好如下内容，`gralde文件夹`、`gradlew`、`gradlew.bat`，这三个直接从一个现成的`Android`项目中复制过来就行。  
![在这里插入图片描述][f3facad9f7474705bbb8e5bd1390d544.png]

#### 4.2 运行命令行 ####

打开`cmd`，进入该文件夹，然后执行如下命令，下述命令选其一即可。

##### 4.2.1 创建使用Java的插件 #####

gradlew init --type java-gradle-plugin

##### 4.2.2 创建使用Groovy的插件 #####

gradlew init --type groovy-gradle-plugin

##### 4.2.3 创建使用Kotlin的插件 #####

gradlew init --type kotlin-gradle-plugin

#### 4.3 完成选项 ####

执行命令后，会有几个问题选项，我们按需进行选择，最终看到`BUILD SUCCESSFUL`，就表示新建插件成功了  
![在这里插入图片描述][b205663070cf42b6a3ed360564bad9a8.png]  
生成后的文件如下

![在这里插入图片描述][f11cb1f31509439e9b6cefb3647aa575.png]  
这样子就很快的完成了一个`Gradle`独立插件的新建了。

### 5. Android Gradle系列文章 ###

[Android Gradle 开发与应用 (一) : Gradle基础-氦客-CSDN博客][Android Gradle _ _ _ Gradle_-_-CSDN]  
[Android Gradle开发与应用 (二) : Groovy基础语法-CSDN博客][Android Gradle_ _ _ Groovy_-CSDN]  
[Android Gradle开发与应用 (三) : Groovy语法概念与闭包-CSDN博客][Android Gradle_ _ _ Groovy_-CSDN 1]  
[Android Gradle开发与应用 (四) : Gradle构建与生命周期-CSDN博客][Android Gradle_ _ _ Gradle_-CSDN]  
[Android Gradle开发与应用 (五): 基于Gradle 8.2，创建Gradle插件-CSDN博客][Link 1]  
[Android Gradle 开发与应用 (六) : 创建buildSrc插件和使用命令行创建Gradle插件-CSDN博客][Android Gradle _ _ _ _buildSrc_Gradle_-CSDN]

### 6. 参考文章 ###

[Using Plugins (gradle.org)][Using Plugins _gradle.org]  
[Gradle用户手册 - Gradle8.1.1中文文档 - API参考文档 - 全栈行动派 (qzxdp.cn)][Gradle_ - Gradle8.1.1_ - API_ - _ _qzxdp.cn]  
[编写 Gradle 插件 | Android Studio | Android Developers (google.cn)][Gradle _ _ Android Studio _ Android Developers _google.cn]  
[Android Gradle8.0版本新建Gradle插件 - 掘金 (juejin.cn)][Android Gradle8.0_Gradle_ - _ _juejin.cn]  
[Gradle基础到进阶 - yechaoa的专栏 - 掘金 (juejin.cn)][Gradle_ - yechaoa_ - _ _juejin.cn]  
[【Gradle-8】Gradle插件开发指南 - 掘金 (juejin.cn)][Gradle-8_Gradle_ - _ _juejin.cn]  
[【Gradle-9】Gradle插件发布指南 - 掘金 (juejin.cn)][Gradle-9_Gradle_ - _ _juejin.cn]  
[Gradle自定义插件实践与总结 - 掘金 (juejin.cn)][Gradle_ - _ _juejin.cn]  
[创建Gradle插件记录 - 掘金 (juejin.cn)][Gradle_ - _ _juejin.cn 1]  
[配置 build | Android Studio | Android Developers (google.cn)][build _ Android Studio _ Android Developers _google.cn]

[Link 1]: https://blog.csdn.net/EthanCo/article/details/135605620
[1a2d763ae280d0fe3901335c35ae8edb.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/abcd8a903a5c4ace825d3ea019ea5e36.png
[f3facad9f7474705bbb8e5bd1390d544.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/b8d5fa738e41465d922994718aab79e5.png
[b205663070cf42b6a3ed360564bad9a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/edaa4319ef61453a8ca22fafda5dd3e0.png
[f11cb1f31509439e9b6cefb3647aa575.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/80b1528cdf4444248062ef5ed34c1c93.png
[Android Gradle _ _ _ Gradle_-_-CSDN]: https://blog.csdn.net/EthanCo/article/details/136163403
[Android Gradle_ _ _ Groovy_-CSDN]: https://blog.csdn.net/EthanCo/article/details/136171921
[Android Gradle_ _ _ Groovy_-CSDN 1]: https://blog.csdn.net/EthanCo/article/details/136174612
[Android Gradle_ _ _ Gradle_-CSDN]: https://blog.csdn.net/EthanCo/article/details/136182914
[Android Gradle _ _ _ _buildSrc_Gradle_-CSDN]: https://blog.csdn.net/EthanCo/article/details/136601282
[Using Plugins _gradle.org]: https://docs.gradle.org/current/userguide/plugins.html#sec:plugin_markers
[Gradle_ - Gradle8.1.1_ - API_ - _ _qzxdp.cn]: https://doc.qzxdp.cn/gradle/8.1.1/userguide/userguide.html
[Gradle _ _ Android Studio _ Android Developers _google.cn]: https://developer.android.google.cn/build/extend-agp?hl=zh-cn
[Android Gradle8.0_Gradle_ - _ _juejin.cn]: https://juejin.cn/post/7311562052510072868?searchId=20240115161021D6EF7084E2D01103FFB8
[Gradle_ - yechaoa_ - _ _juejin.cn]: https://juejin.cn/column/7123935861976072199
[Gradle-8_Gradle_ - _ _juejin.cn]: https://juejin.cn/post/7267091810380136508?searchId=20240115161021D6EF7084E2D01103FFB8#heading-6
[Gradle-9_Gradle_ - _ _juejin.cn]: https://juejin.cn/post/7280062870669246525?searchId=20240115161021D6EF7084E2D01103FFB8#heading-13
[Gradle_ - _ _juejin.cn]: https://juejin.cn/post/7292952125193256995?searchId=20240115161021D6EF7084E2D01103FFB8
[Gradle_ - _ _juejin.cn 1]: https://juejin.cn/post/7302712860806610971?searchId=20240115161021D6EF7084E2D01103FFB8
[build _ Android Studio _ Android Developers _google.cn]: https://developer.android.google.cn/build?hl=zh-cn