Gradle 插件
使用插件的原因
简单的说,通过应用插件我们可以:
- 促进代码重用、减少功能类似代码编写、提升工作效率
- 促进项目更高程度的模块化、自动化、便捷化
- 可插拔式的的扩展项目的功能
插件的作用
在项目构建过程中做很多事情,把插件应用到项目中,通常可以完成:
1、可以添加任务【task】到项目中,从而帮助完成测试、编译、打包等。
2、可以添加依赖配置到项目中。
3、可以向项目中拓展新的扩展属性、方法等。
4、可以对项目进行一些约定,如应用 Java 插件后,约定src/main/java 目录是我们的源代码存在位置,编译时编译这个目录下的Java 源代码文件。
插件的分类和使用
脚本插件
脚本插件的本质就是一个脚本文件,使用脚本插件时通过apply from:将脚本加载进来就可以了,后面的脚本文件可以是本地的也可以是网络上的脚本文件,下面定义一段脚本,我们在 build.gradle 文件中使用它,具体如下:
//version.gradle文件 ext { company= "onenewcode" cfgs = [ compileSdkVersion : JavaVersion.VERSION_1_8 ] spring = [ version : '5.0.0' ] }
下面将将在构建文件中使用这个脚本文件,具体如下:
//build.gradle文件 //map作为参数 apply from: 'version.gradle' task taskVersion{ doLast{ println "公司名称为:${company},JDK版本是${cfgs.compileSdkVersion},版本号是${spring.version}" } }
上述代码的执行结果如下:
D:\repos\idearepos\root> gradle -q taskVersion 版本是2.0,版本号是1
意义:脚本文件模块化的基础,可按功能把我们的脚本进行拆分一个个公用、职责分明的文件,然后在主脚本文件引用, 比如:将很多共有的库版本号一起管理、应用构建版本一起管理等。
对象插件之内部插件[核心插件]
二进制插件[对象插件]就是实现了 org.gradle.api.Plugin 接口的插件,每个 Java Gradle 插件都有一个 plugin id。
可通过如下方式使用一个 Java 插件: apply plugin : ‘java’ //map具名参数方式或者:
//也可以使用闭包作为project.apply方法的一个参数apply{ apply{ plugin 'java' }
通过上述代码就将 Java 插件应用到我们的项目中了,对于 Gradle 自带的核心插件都有唯一的 plugin id,其中 java 是Java 插件的 plugin id,这个 plugin id 必须是唯一的,可使用应用包名来保证 plugin id 的唯一性。这里的 java 对应的具体类型是 org.gradle.api.plugins.JavaPlugin,所以可以使用如下方式使用 Java 插件:
//使用方式1:Map具名参数,全类名 apply plugin:org.gradle.api.plugins.JavaPlugin //org.gradle.api.plugins默认导入:使用方式2 apply plugin:JavaPlugin apply plugin: 'java' //核心插件,无需事先引入,使用方式3:插件的id
对象插件之第三方插件
如果是使用第三方发布的二进制插件,一般需要配置对应的仓库和类路径,
//使用传统的应用方式 buildscript { ext { springBootVersion = "2.3.3.RELEASE" } repositories { mavenLocal() maven { url 'http://maven.aliyun.com/nexus/content/groups/public' } jcenter() } // 此处先引入插件 dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") } } //再应用插件 apply plugin: 'org.springframework.boot' //社区插件,需要事先引入,不必写版本号
但是如果是第三方插件已经被托管在 https://plugins.gradle.org/ 网站上,就可以不用在 buildscript 里配置 classpath依赖了,直接使用新出的 plugins DSL 的方式引用,案例如下: 使 用 plugins DSL 方 式
plugins { id 'org.springframework.boot' version '2.4.1' }
注意:
- 如果使用老式插件方式buildscript{}要放在build.gradle 文件的最前面,而新式plugins{}没有该限制。
- 托管在网站gradle 插件官网的第三方插件有两种使用方式,一是传统的buildscript 方式,一种是 plugins DSL 方式 。
对象插件之用户自定义插件
interface GreetingPluginExtension { Property<String> getMessage() Property<String> getGreeter() } class GreetingPlugin implements Plugin<Project> { void apply(Project project) { def extension = project.extensions.create('greeting', GreetingPluginExtension) project.task('hello') { doLast { println "${extension.message.get()} from ${extension.greeter.get()}" } } } } apply plugin: GreetingPlugin // Configure the extension using a DSL block greeting { message = 'Hi' greeter = 'Gradle' }
我们直接执行 hello 任务./gradle hello 即可,这种方式实现的插件我们一般不使用,因为这种方式局限性太强,只能本Project,而其他的Project 不能使用。
buildSrc 项目
buildSrc 是Gradle 默认的插件目录,编译 Gradle 的时候会自动识别这个目录,将其中的代码编译为插件。
- 首先先建立一个名为 buildSrc 的 java Module,将 buildSrc 从 included modules 移除,重新构建,然后只保留 build.gradle和src/main 目录,其他全部删掉,或者直接创建一个gradle项目,注意名字一定是 buildSrc,不然会找不到插件。
- 然后修改Gradle 中的内容
apply plugin: 'groovy' // 必 须apply plugin: 'maven-publish' dependencies { implementation gradleApi() //必须implementation localGroovy() //必须 } repositories { google() jcenter() mavenCentral() //必须 } //把项目入口设置为src/main/groovy sourceSets { main { groovy { srcDir 'src/main/groovy' } } }
- 创建入口目录,在src/main 下创建代码入口目录:
Gradle笔记 八 Gradle 插件(二)https://developer.aliyun.com/article/1391977