为Android Studio编写自定义Gradle插件的教程

自定义Gradle插件可以让我们在构建过程中实现更多的定制化和灵活性。本文将讲解如何为Android Studio编写自定义Gradle插件的教程。本文将分为以下几个章节：

1. 前置知识要求
2. 创建Gradle插件项目
3. 编写Gradle插件代码
4. 发布和使用自定义Gradle插件

1. 前置知识要求

在开始撰写自定义的Gradle插件之前，需要掌握以下几个方面的知识：

1. Gradle的基础知识：任务(Task)、插件(Plugins)、依赖(Dependency)和脚本文件(Script)等。
2. Groovy的基础知识：Groovy是一种基于JVM的脚本语言，它是Gradle的默认脚本语言，因此需要对其语法和基本概念有一定的了解。

2. 创建Gradle插件项目

创建Gradle插件项目有多种方式，这里我们介绍一种使用Android Studio创建Gradle插件的步骤：

1. 打开Android Studio，从菜单中选择“File” > “New” > “New Project”。
2. 在新建项目对话框中，选择“Empty Project”，然后点击“Next”。
3. 输入项目名称和存储路径等基本信息，然后点击“Finish”即可创建项目。
4. 在项目的根目录下，创建新的目录plugin，然后在该目录中创建新的模块gradle_plugin，用于存放我们的自定义Gradle插件代码和配置。
5. 在gradle_plugin模块的build.gradle文件中，添加以下插件和依赖：

plugins {
    id 'groovy'
    id 'java-gradle-plugin'
}

dependencies {
    implementation gradleApi()
    implementation localGroovy()
}

这里使用java-gradle-plugin插件，而不是被废弃的gradle-plugin插件。

3. 编写Gradle插件代码

在gradle_plugin模块的src/main/groovy目录下，创建新的Groovy类MyPlugin，该类必须继承自org.gradle.api.Plugin接口，并实现apply()方法作为插件的入口点。

package com.example.gradle_plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class MyPlugin implements Plugin<Project> {
    void apply(Project project) {
        println("自定义Gradle插件已被应用")
    }
}

这里的apply()方法在插件被应用时会自动执行，并打印一条消息。

接下来，我们需要在项目的根目录的settings.gradle文件中，包含我们的Gradle插件目录作为一个子项目：

include ':plugin:gradle_plugin'

最后，在项目的根目录中的build.gradle文件中，将我们的自定义Gradle插件加入到构建脚本中:

buildscript {
    dependencies {
        classpath project(':plugin:gradle_plugin')
    }
}

apply plugin: 'com.example.gradle_plugin.MyPlugin'

这里的buildscript块指定了依赖项，将我们的插件项目作为classpath加入到构建脚本中。

4. 发布和使用自定义Gradle插件

只有在Gradle插件被成功发布后，才能在其他项目中使用。下面我们介绍如何发布和使用我们的Gradle插件：

1. 在gradle_plugin模块的根目录下，创建新的文件夹repo，用于存储发布的插件，同时我们需要在build.gradle文件中添加以下代码用于打包和发布插件：

apply plugin: 'maven-publish'

publishing {
    publications {
        maven(MavenPublication) {
            groupId ‘com.example.gradleplugin’
            artifactId ‘gradleplugin’
            version ‘1.0.0’

            from components.java
        }
    }

    repositories {
        maven {
            url ‘file://${project.projectDir}/repo’
        }
    }
}

这里采用的是把插件发布到本地Maven仓库的方式，该插件的groupId为com.example.gradleplugin，artifactId为gradleplugin，version为1.0.0。

1. 在命令行中输入gradlew publish命令，完成插件的发布。

2. 要在其他项目中使用自定义的Gradle插件，可以在该项目的build.gradle文件中添加以下代码：

buildscript {
    repositories {
        mavenLocal()
    }

    dependencies {
        classpath 'com.example.gradleplugin:gradleplugin:1.0.0'
    }
}

apply plugin: 'com.example.gradle_plugin.MyPlugin'

这里我们在repositories代码块中添加了本地Maven仓库(mavenLocal())，并在dependencies块中引用了自定义的Gradle插件(com.example.gradleplugin:gradleplugin:1.0.0)。

示例：

示例1：自动生成版本号

package com.example.gradle_plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class VersionPlugin implements Plugin<Project> {
    void apply(Project project) {

        project.plugins.withId('com.android.library') {
            def versionName = getVersionName()
            def versionCode = getVersionCode()

            project.android.defaultConfig.versionName versionName
            project.android.defaultConfig.versionCode versionCode
        }
    }

    def getVersionName() {
        def gitBranch = "git symbolic-ref -q --short HEAD".execute().text.trim()
        def gitSHA = "git rev-parse --short HEAD".execute().text.trim()

        return "${gitBranch}-${gitSHA}"
    }

    def getVersionCode() {
        def gitLog = "git log --pretty=format:'%h'".execute()

        return gitLog.text.readLines().size()
    }
}

该自定义插件会自动在编译时，在版本名和版本号中注入git分支名与git提交hash以及环境提交总次数。

示例2：自动生成应用Icon

package com.example.gradle_plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class IconPlugin implements Plugin<Project> {
    void apply(Project project) {
        def iconResPath = project.file('src/main/res/mipmap')
        def appName = project.name
        def iconFile = new File("${iconResPath}/ic_launcher.png")

        project.plugins.withId("com.android.application") {
            task generateIcon(type:Exec) {
                def iconText = """
                <svg xmlns="http://www.w3.org/2000/svg"
                    width="1024" height="1024">
                  <rect x="0" y="0"
                        width="1024" height="1024"
                        fill="#F26925">
                  </rect>
                  <rect x="412" y="412"
                        width="200" height="200"
                        fill="#FFFFFF">
                  </rect>
                  <text x="512" y="660" fill="black"
                        style="text-anchor:middle;
                               font-size:176px;
                               font-family:sans-serif;
                               font-weight:bold;">
                    ${appName}
                  </text>
                </svg>
                """

                exec {
                    commandLine "bash", "-c",
                                "echo '${iconText}' > ${iconFile} && " +
                                "inkscape --without-gui --export-width=1024 --export-height=1024 --export-png=${iconFile} ${iconFile}"
                }
            }

            preBuild.dependsOn generateIcon
        }
    }
}

该自定义插件会根据项目的名称自动生成图标，并替换为原有图标。使用的技术为Inkscape。