自定义Gradle插件

2023-05-30 本文已影响0人 SunnyDay_ab5f

一、什么是Gradle插件？

Gradle 和 Gradle 插件是两个完全不同的概念，Gradle 提供的是一套核心的构建机制，而 Gradle 插件则是运行在这套机制上的一些具体构建逻辑，例如我们常见的gradle插件就是：

plugins {
    id 'com.android.application'
}

'com.android.application'便是Android提供的用于构建APK的一个gradle插件。Gradle 插件打包了可重用的构建逻辑片段，可以在许多不同的项目和构建中使用。Gradle 允许您实现自己的插件，因此您可以重用您的构建逻辑，并与他人共享。

二、实现Gradle插件的3种方式

Build script脚本
把插件写在build.gradle文件中，一般用于简单的逻辑，只在该build.gradle文件中可见。
buildSrc项目
将插件源代码放在buildSrc/src/main/中，只对该项目可见。
独立项目
一个独立的java项目/模块，可以将文件包发布到仓库（Jcenter或本地仓库），对所有工程可见。

本文只对第三种方式的gradle插件进行说明，其他方式可以参考文章：Android Gradle插件开发基础

三、独立项目gradle插件的实现

（1）创建一个javalib

注意选择 java or kotlin library

image.png
这里我把这个javalib命名为test_plugin工程目录如下图：

image.png

（2）test_plugin中的build.gradle编写

1.使用java-gradle-plugin插件的方式

plugins {
    id 'maven-publish'
    id 'java-gradle-plugin'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}

gradlePlugin {
    plugins {
        standaloneGradlePlugins {
            id = 'test_plugin'
            implementationClass = 'com.example.test_plugin.MyPlugin'
        }
    }
}



publishing {
    repositories {
        maven {
            // $rootDir 表示你项目的根目录
            // 这里配置发布到的本地目录
            url = "$rootDir/repo"
        }
    }

    publications {
        maven(MavenPublication) {

            // 插件的组ID，建议设置为插件的包名
            groupId = 'com.example.test_plugin'
            // 插件的名字，后续在引用时会用到
            artifactId = 'MyPlugin'
            version = '1.0.0'
            // 组件类型
            from components.java
        }
    }
}

2.不适用java-gradle-plugin插件的方式

plugins {
    id 'maven-publish'
    id 'groovy'
}


java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}


dependencies {
    implementation gradleApi()
}

publishing {
    publications {
        maven(MavenPublication) {
            groupId = 'ccom.example.test_plugin'
            artifactId = 'MyPlugin'
            version = '1.0.0'
            from components.java
        }
    }

    repositories {
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url = layout.buildDirectory.dir('repo')
        }
    }
}

不使用java-gradle-plugin就必须添加 id 'groovy支持，依赖implementation gradleApi()并且需要在resources目录下创建META-INF目录，并在META-INF中创建test_plugin.properties文件。