【Gradle：新一代构建工具】学习笔记 3 Gradle进阶说明 3.16 Gradle脚本插件、内部插件和第三方插件

小鱼儿 2024-03-23 15:38 21阅读 0赞

### 【Gradle：新一代构建工具】学习笔记 ###

#### 文章目录 ####

*   *  【Gradle：新一代构建工具】学习笔记
     *   *  3 Gradle进阶说明
         *   *  3.16 Gradle脚本插件、内部插件和第三方插件
             *   *  3.16.1 第一种：脚本插件
                 *  3.16.2 第二种：对象插件之内部插件【核心插件】
                 *  3.16.3 第二种：对象插件之第三方插件

[【【尚硅谷】Gradle教程入门到进阶（从gradle安装到项目实战）】 ][Gradle_gradle_]

![在这里插入图片描述][d67c39937f9d43b989eb897062b247a0.png_pic_center]

#### 3 Gradle进阶说明 ####

##### 3.16 Gradle脚本插件、内部插件和第三方插件 #####

![在这里插入图片描述][93f0053b9c7d4f52a0ff673bd42f080e.png_pic_center]

###### 3.16.1 第一种：脚本插件 ######

脚本插件的本质就是**一个脚本文件**，使用脚本插件时通过 `apply from:`将脚本加载进来就可以了，后面的脚本文件可以是 本地的也可以是网络上的脚本文件，

下面定义一段脚本，我们在 build.gradle 文件中使用它，具体如下：

//version.gradle文件
    ext {
        
        company= "尚硅谷" 
        cfgs = [
        	compileSdkVersion : JavaVersion.VERSION_1_8
        ]
        spring = [
        	version : '5.0.0' 
        ]
    }

![在这里插入图片描述][80451996ba4345738427fdb27bb19aac.png_pic_center]

下面将将在构建文件中使用这个脚本文件，具体如下：

//build.gradle文件
    //map作为参数
    apply from: 'version.gradle' 
    
    task taskVersion{
        
        doLast{
        
        	println "公司名称为：${company},JDK版本是${cfgs.compileSdkVersion},版本号是${spring.version}" }
    }

上述代码的执行结果如下：

![在这里插入图片描述][a19a418d18ad47d19a914c51d672432a.png_pic_center]

这就是脚本插件。

**意义：脚本文件模块化的基础，可按功能把我们的脚本进行拆分**一个个公用、职责分明的文件，然后在主脚本文件引用， 比如：将很多共有的库版本号一起管理、应用构建版本一起管理等

###### 3.16.2 第二种：对象插件之内部插件【核心插件】 ######

![在这里插入图片描述][e633cb3ea9a54702a1aa0c13a75087c2.png_pic_center]

二进制插件\[对象插件\]就是实现了 `org.gradle.api.Plugin` 接口的插件，每个 Java Gradle 插件都有一个 `plugin id`。

可通过如下方式使用一个 Java 插件：

apply plugin : 'java' //map具名参数方式

或者：

//也可以使用闭包作为project.apply方法的一个参数
    apply{
        
        plugin 'java' 
    }

官方文档：[https://docs.gradle.org/current/userguide/java\_plugin.html][https_docs.gradle.org_current_userguide_java_plugin.html]

![在这里插入图片描述][6da826989c49498a8b6fcf563b7fb1bf.png_pic_center]

通过上述代码就将 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

Gradle 中提供的二进制插件【核心插件】,可参考: https://docs.gradle.org/current/userguide/plugin\_reference.html

![在这里插入图片描述][795f4865818445a9a8ac833f4d37b029.png_pic_center]

###### 3.16.3 第二种：对象插件之第三方插件 ######

如果是使用第三方发布的二进制插件，一般需要配置对应的仓库和类路径,

//使用传统的应用方式
    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/ 网站上，

![在这里插入图片描述][1e8f2c606e1b4cd2a4346d20a14f98e2.png_pic_center]

就可以不用在 buildscript 里配置 classpath 依赖了，直接使用新出的 plugins DSL 的方式引用，案例如下：

使用 plugins DSL 方式

plugins {
        
        id 'org.springframework.boot' 
        version '2.4.1' 
    }

注意：

1.  如果使用老式插件方式 buildscript\{\}要放在 build.gradle 文件的最前面,而新式 plugins\{\}没有该限制。
2.  托管在网站 gradle 插件官网的第三方插件有两种使用方式，一是传统的 buildscript 方式，一种是 plugins DSL 方式 。

[Gradle_gradle_]: https://www.bilibili.com/video/BV1yT41137Y7
[d67c39937f9d43b989eb897062b247a0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/1cfac0f06d6644048a6962782a104365.png
[93f0053b9c7d4f52a0ff673bd42f080e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/94795ae84fff459cac4e00c12d79965e.png
[80451996ba4345738427fdb27bb19aac.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/3d91d10b44a24f849b3d2615d86117bc.png
[a19a418d18ad47d19a914c51d672432a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/54eb5337293d44699ba3446d8c3a6321.png
[e633cb3ea9a54702a1aa0c13a75087c2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ce639eb40bb2420fb2724038005505c3.png
[https_docs.gradle.org_current_userguide_java_plugin.html]: https://docs.gradle.org/current/userguide/java_plugin.html
[6da826989c49498a8b6fcf563b7fb1bf.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/d3ff85adde9c47edafbc95a1694e51b4.png
[795f4865818445a9a8ac833f4d37b029.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/f3d725bacaf64334a1aaa8e81beffc58.png
[1e8f2c606e1b4cd2a4346d20a14f98e2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/3e155dcdf80049ce8a14a0c9b7754b13.png