Android自定义Gradle插件的详细过程

1. 创建 Android Library Module

首先，我们需要创建一个 Android Library Module，作为我们自定义 Gradle 插件的代码库。

右键点击项目 -> New -> New Module -> Android Library -> Next 。确保将“Generate Layout Files”选项清除，因为我们不需要生成任何 XML 布局文件。然后，按照提示输入必要的信息，包括 Library Name 和 Minimum SDK Version。

创建完毕后，我们需要将生成的代码库添加到项目的 build.gradle 文件中：

dependencies {
    implementation project(':mylibrary')
}

1. 创建自定义 Gradle 插件

在代码库的根目录下，创建一个 build.gradle 文件，并添加以下内容：

plugins {
    id 'groovy'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation gradleApi()
    implementation localGroovy()
}

apply plugin: 'maven'

group = 'com.example'
version = '1.0.0-SNAPSHOT'

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: "file:///path/to/local/maven/repo/")
        }
    }
}

这些代码会启用 Groovy 插件，并提供了必要的依赖项和插件控制。我们还为插件指定了一个版本号（在此为 1.0.0-SNAPSHOT）和一个 Maven Group ID（在此为 com.example）。最后，我们定义了一个 maven 部署任务，以便为插件生成 Maven POM 和部署到本地 Maven 存储库。

1. 创建插件类

我们需要创建一个 Groovy 类来实现我们的自定义 Gradle 插件。在代码库的 src/main/groovy 目录下创建一个新的 Groovy 文件，并添加以下内容：

class MyPlugin implements Plugin<Project> {
    void apply(Project project) {
        // 插件逻辑代码
    }
}

这个类实现了 Plugin 接口，并实现了 apply 方法，apply 方法包含我们的插件逻辑代码。现在可以使用此类来扩展 Gradle 构建流程。

1. 注册插件

在 build.gradle 文件的顶部添加以下内容，为我们的插件提供一个唯一的 ID：

plugins {
    id 'com.example.myplugin' version '1.0.0-SNAPSHOT'
}

apply plugin: 'com.example.myplugin'

现在，我们的插件已经注册，并可以在构建中使用。

1. 将插件发布到 Maven 存储库

请确保已通过 Maven 部署任务将插件发布到本地 Maven 存储库。如果需要将插件部署到远程 Maven 存储库，则需要使用其他部署任务。

1. 使用自定义 Gradle 插件

现在，我们可以在我们的项目中使用我们的自定义 Gradle 插件。假设我们的插件实现了一个任务，该任务通过 Gradle 属性配置。我们可以通过以下方式在 build.gradle 文件中定义任务：

myTask {
    myProperty = 'some value'
}

这将调用我们自定义的 myTask 任务，并将 myProperty 属性设置为“some value”。

示例1：

下面是一个示例的自定义 Gradle 插件，用于自动化生成 buildConfigField 组件：

1. 创建一个 ~/.gradle/gradle.properties 文件，添加以下内容：

buildReleaseConfig.propsFile='config.properties'

2.在 build.gradle 的项目根目录中添加以下 Gradle 插件：

plugins {
  id 'java'
}

group 'com.example'
version '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    compile `com.android.tools.build:gradle:3.4.2`
    testCompile group: `junit:junit:4.12`
    implementation group: `org.apache.commons:commons-io:1.3.2`
}

task buildConfigFieldPlugin(type: BuildConfigFieldPluginTask) {
    propsFile rootProject.ext.buildReleaseConfig.propsFile
}

3.创建一个 buildSrc 目录，并在其中创建 BuildConfigFieldPluginTask 类：

class BuildConfigFieldPluginTask implements Plugin<Project> {
    void apply(Project project) {
        project.task('buildConfigField') << {
            Properties props = new Properties()
            props.load(new FileInputStream(rootProject.ext.buildReleaseConfig.propsFile))
            project.android.buildTypes.each { buildType ->
                buildType.buildConfigField 'String', 'API_URL', props.url
                buildType.buildConfigField 'String', 'API_KEY', props.key
            }
        }
  }
}

示例2：

这是一个将 Android Manifest 中的版本信息设置为 Gradle 构建的版本信息的示例：

1.创建一个 MyPlugin 类：

class MyPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.afterEvaluate {
            def versionName = project.version.toString()
            android {
                defaultConfig {
                    versionName versionName
                }
            }
            task('setVersionName') << {
                def manifestFile = new File(project.rootProject.file("app/src/main/AndroidManifest.xml"))
                def manifest = new XmlParser().parse(manifestFile)
                manifest.@versionName = versionName
                new XmlNodePrinter(new PrintWriter(new FileOutputStream(manifestFile))).print(manifest)
            }
            assemble.dependsOn setVersionName
        }
    }
}

2.创建 build.gradle 文件，并将我们的插件应用于构建：

plugins {
    id 'com.example.myplugin' version '1.0.0-SNAPSHOT'
}

apply plugin: 'com.example.myplugin'

3.定义版本号：

version '1.0.0-SNAPSHOT'

4.在设备上打开应用程序，查看 Android Manifest 文件是否已被更新，以显示与 Gradle 构建版本相同的版本信息。