Gradle之自定义插件的三种形式（六）

最新推荐文章于 2024-04-28 12:39:26 发布

YolynHou

最新推荐文章于 2024-04-28 12:39:26 发布

阅读量383

点赞数

分类专栏： Gradle

本文链接：https://blog.csdn.net/qq_34088913/article/details/105946726

版权

Gradle 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

自定义Gradle插件主要有三种形式，分别是build.gradle中编写、buildSrc工程项目中编写、独立项目或独立module中编写。

1. 在build.gradle中编写自定义插件

对象插件是实现了org.gradle.api.plugins接口的插件，这个接口中只定义个一个简单的apply方法，想要实现自定义插件就需要去实现org.gradle.api.plugins接口。
Groovy、Java、Kotlin都可以作为实现插件的语言，在本文的示例中，使用Groovy作为实现语言。
在实际工作中我们很少会在build.gradle中编写自定义插件，这里是为了带大家写个最简单的例子，可以最快最直接的了解什么是自定义插件。

1.1 这里使用AS来编辑，新建一个项目，在module中的build.gradle中键入以下内容：

// Apply the plugin
apply plugin: GreetingPlugin

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('GreetingPluginTask') {
            doLast {
                println '自定义插件'
            }
        }
    }
}

在build.gradle中自定义了一个插件GreetingPlugin，在apply方法中创建一个名称为GreetingPluginTask的任务。在AS的Terminal中输入gradlew.bat GreetingPluginTask来执行GreetingPluginTask任务。

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle  GreetingPluginTask

> Task :app:GreetingPluginTask 
自定义插件


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

1.2 自定义插件扩展

再举一个简单的插件拓展例子，通过插件拓展来配置GreetingPluginTask的输出字符串，如下所示。
build.gradle

apply plugin: GreetingPlugin
greeting.message="自定义插件拓展"//2
class GreetingPluginPluginExtension{
    String message="from GreetingPlugin"
}
class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        def extension=project.extensions.create("greeting",GreetingPluginPluginExtension)//1
        project.task('GreetingPluginTask') {
            doLast {
                println extension.message
            }
        }
    }
}

GreetingPluginPluginExtension类中定义了message变量，GreetingPluginPluginExtension是一个Groovy Bean(类似于JavaBean)。注释1处用于添加拓展插件GreetingPluginPluginExtension到插件列表中，名称为greeting。注释2处设置GreetingPluginPluginExtension的message值。
Terminal中输入gradlew.bat GreetingPluginTask来执行GreetingPluginTask任务。

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle GreetingPluginTask

> Task :app:GreetingPluginTask 
自定义插件拓展


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

2. buildSrc工程项目

除了在build.gradle中编写的自定义插件，还可以将插件的源代码放在rootProjectDir/buildSrc/src/main/groovy目录中，Gradle会自动识别来完成编译和测试。Android Studio会找rootPrjectDir/buildSrc/src/main/groovy目录下的代码。

坑：当新建libraray module并命名为buildSrc后会提示Plugin with id'com.android.library' not found.

这是因为buildSrc是Android的保留名称，只能作为plugin插件使用，我们修改buildSrc的build.gradle文件后就不报错了。

具体流程如下：

2.1. 首先创建一个名为buildSrc的module，注意，名称必须为buildSrc

image

2.2. 然后将其它不需要的文件删除，新建需要的文件夹和文件，最后的目录结构如下图所示：

image

2.3. 新建对应的文件和文件夹之后，工程开始会不认这个buildSrc，我们修改build.gradle：

apply plugin: 'groovy'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

点击Sync Now，完了之后发现groovy文件夹变蓝色了

2.4. 在对应的包下面新建YolynPlugin.groovy，输入以下内容

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

class YolynPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task('yolynplugin') {
            doLast {
                println("this is YolynPlugin")
            }
        }
        println("welcome to YolynPlugin")
    }
}

2.5. 再在com.yolyn.plugin.properties文件中添加以下内容（注意这里properties的名称就是我们之后要引用这个插件时apply plugin：''引号填入的内容）

implementation-class=YolynPlugin

这里的YolynPlugin就是我们创建的YolynPlugin.groovy文件，一定要对应上，否则会报找不到的错误。

2.6. 在app的gradle中去引用这个插件

apply plugin:  'com.yolyn.plugin'

com.yolyn.plugin是我们之前创建的properties的名称

重新build一下

2.7. 在terminal中可以键入命令

gradle yolynplugin   
或者gradlew yolynplugin  
或者gradlew.bat yolynplugin

输出内容：

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle yolynplugin

> Configure project :app 
welcome to YolynPlugin

> Task :app:yolynplugin 
this is YolynPlugin


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

疑问1
这里有一个疑问，为什么先打印出welcome to YolynPlugin,是因为doLast吗，怎么解释？
疑问2
我们再创建一个插件叫OtherPlugin.groovy

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

class OtherPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task('otherplugin') {
            doLast {
                println("this is OtherPlugin")
            }
        }
        println("Welcome To OtherPlugin")
    }
}

然后同样地在gradle-plugins中创建properties，在app下面的build.gradle引用

在Terminal中输入gradle otherplugin

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin

> Configure project :app 
welcome to YolynPlugin
Welcome To OtherPlugin

> Task :app:otherplugin 
this is OtherPlugin


BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

发现YolynPlugin中的apply方法也执行了

疑问3
我们把两个Plugin中的doLast去掉
我们再在Terminal中输入gradle otherplugin

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin

> Configure project :app 
this is YolynPlugin
welcome to YolynPlugin
this is OtherPlugin
Welcome To OtherPlugin


BUILD SUCCESSFUL in 6s

发现全部都打印出来了，这是为什么？

对于疑问1:
我们看一下官方对Projec的task方法的介绍

Creates a Task with the given name and adds it to this project. Calling this method is equivalent to calling task(java.util.Map, String) with an empty options map.

After the task is added to the project, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details

If a task with the given name already exists in this project, an exception is thrown.

throws:
    InvalidUserDataException If a task with the given name already exists in this project.

Parameters:
    name - The name of the task to be created

Returns:
    The newly created task object

大致意思是会创建一个给定名字的task放到这个project里面，调用这个方法相当于调用这个task

再看一下Task的doLast方法：

Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.

这样就能解释了，确实是因为doLast将任务添加到project的tasks的list的最后了，所以才最后执行。具体还可以查看官方文档的Project，文档在gradle安装目录的docs里面可以找到。

==疑问二和疑问三是为什么？？？求解==

日后继续研究
再看第三种形式

3. 独立项目或独立Module

无论是在build.gradle中编写自定义插件，还是buildSrc项目中编写自定义插件，都只能在自己的项目中进行使用。如果想要分享给其他人或者自己用，可以在一个独立的项目中编写插件，这个项目会生成一个包含插件类的JAR文件，有了JAR文件就很容易进行分享了。

3.1 创建一个名为YolynPlugin的module

跟上面创建buildSrc一样，将其它文件删除，并创建相应的文件和文件夹，最终目录结构如下：

image

3.2 修改build.gradle

apply plugin:'groovy'
apply plugin: 'maven'
dependencies {
    //gradle sdk
    compile gradleApi()
    //groovy sdk
    compile localGroovy()
}

Sync Now

3.3 在com.example.yolynplugin下创建ModuleYolynPlugin.groovy（为了和上面的YolynPlugin区分）

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

class ModuleYolynPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task("moduleyolynplugin") {
            println("this is module yolynplugin")
        }
    }
}

3.4 在gradle-plugins文件夹下面创建com.example.yolynplugin.properties

implementation-class=ModuleYolynPlugin

3.5 将代码上传到仓库或者本地，这里是放到本地

在这个module的build.gradle追加下面内容

group='com.example.yolynplugin'
version='1.0.0'
//group和version在后面会用到
uploadArchives {
    repositories {
        mavenDeployer {
              //提交到远程服务器：
              // repository(url: "http://www.xxx.com/repos") {
              //    authentication(userName: "admin", password: "admin")
              // }
            repository(url:uri('../repo'))
        }
    }
}

上面各个参数的逻辑意义参考官方文档：
https://docs.gradle.org/current/dsl/index.html
这里直接将插件上传到了本项目的根目录，点击Build之后在Gradle窗口会看到uploadArchives

image

点击uploadArchives会在本地生成插件相关的文件，比如我的目录和文件如下图所示

image

图中的YolynPlugin-1.0.0.jar就是我们需要的插件jar包。

3.6 去app下面的module中引用

在build.gradle中追加下面内容

apply plugin: 'com.example.yolynplugin'//properties的名字
buildscript {
//repositories这个模块的内容告诉gradle去什么地址下载第三方的库。
    repositories{
        maven {
        url uri('../repo')
        }
    }
    dependencies{
                   //group:pluginName:version
        classpath 'com.example.yolynplugin:YolynPlugin:1.0.0'
    }
}

其中com.example.yolynplugin是group，YolynPlugin是自定义插件的名称，1.0.0是版本号

也可以这么写:

dependencies {
     classpath group: 'com.example.yolynplugin', name: 'YolynPlugin',
             version: '1.0.0'
 }

Sync Now

3.7 clean一下Project，然后make Project，在Terminal中输入：gradle moduleyolynplugin

D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle moduleyolynplugin

> Configure project :app 
welcome to YolynPlugin
Welcome To OtherPlugin
this is module yolynplugin


BUILD SUCCESSFUL in 8s

三个插件都成功运行

笔记来源于：
1.https://blog.csdn.net/huachao1001/article/details/51810328
2. http://liuwangshu.cn/application/gradle/6-custonplugin.html

YolynHou

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Gradle之自定义插件的三种形式（六）

自定义Gradle插件主要有三种形式，分别是build.gradle中编写、buildSrc工程项目中编写、独立项目或独立module中编写。1. 在build.gradle中编写自定义插件对象插件是实现了org.gradle.api.plugins接口的插件，这个接口中只定义个一个简单的apply方法，想要实现自定义插件就需要去实现org.gradle.api.plugins接口。Groo...
复制链接

扫一扫

专栏目录