【Gradle：新一代构建工具】学习笔记 3 Gradle进阶说明 3.18 Gradle用户自定义插件之buildSrc目录

超、凢脫俗 2024-03-23 15:39 48阅读 0赞

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

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

*   *  【Gradle：新一代构建工具】学习笔记
     *   *  3 Gradle进阶说明
         *   *  3.18 Gradle用户自定义插件之buildSrc目录

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

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

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

##### 3.18 Gradle用户自定义插件之buildSrc目录 #####

buildSrc 是 Gradle 默认的插件目录，编译 Gradle 的时候会自动识别这个目录，将其中的代码编译为插件。

1.  首先先建立一个名为 buildSrc 的 java Module,
    
    ![在这里插入图片描述][fedd980264f94973a07f85a609a60cce.png_pic_center]
    
    ![在这里插入图片描述][d60135d6be884514a056c315a85a3707.png_pic_center]
    
    将 buildSrc 从 included modules 移除,
    
    ![在这里插入图片描述][eaebdb04d2dc44429569dd88a2e2fb07.png_pic_center]
    
    ![在这里插入图片描述][4e3290a7e87a409d9210ea301041d185.png_pic_center]
    
    重新构建,然后只保留 build.gradle 和 src/main 目录，其他全部删掉,注意名字一定是 buildSrc,不然会找不到插件。
    
    ![在这里插入图片描述][11bac0609db64cfca87b8ac00b68f000.png_pic_center]
2.  然后修改 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'
                }
            }
        }
    
    ![在这里插入图片描述][c12e55ce0e204fadaf9967fd5e47390a.png_pic_center]
3.  创建入口目录，在 src/main 下创建代码入口目录，如下：
    
    ![在这里插入图片描述][77cb4b8ff9d0419c804a7852a3976434.png_pic_center]
    
    ![在这里插入图片描述][d3d9522ab6704478a835ee7d56b1a59e.png_pic_center]
4.  然后实现插件代码 Text.groovy，注意文件后缀为 groovy,文件要引入 package com.dingjiaxiong
    
        package com.dingjiaxiong
        
        
        import org.gradle.api.Plugin
        import org.gradle.api.Project
        
        class Text implements Plugin<Project> {
              
            @Override
            void apply(Project project) {
              
                project.task("dingjiaxiong") {
              
                    doLast {
              
                        println("自定义 dingjiaxiong 插件")
                    }
                }
            }
        }
    
    ![在这里插入图片描述][b75e5f3f5a8546e49b7934e411cf55b2.png_pic_center]
5.  接下来在 main 目录下创建 resources 目录,在 resources 目录下创建 META-INF 目录，在 META-INF 目录下创建 gradle-plugins 目录，在 gradle-plugins 目录下创建 properties 文件
    
    ![在这里插入图片描述][3de2148fc2de46deb4c764c41842a0da.png_pic_center]
6.  properties 文件可以自己命名，但是要以.properties 结尾，比如 com.dingjiaxiong.plugin.properties,其 com.dingjiaxiong.plugin 就是 定义的包名路径.
7.  最后需要在 properties 文件中指明我们实现插件的全类名 `implementation-class=com.dingjiaxiong.Text`
    
    ![在这里插入图片描述][8f55617cb4f54701a74c8dd98e77e712.png_pic_center]

到目前为止我们的插件项目已经写完了，在 module 引入我们写的插件 `apply plugin:'com.dingjiaxiong.plugin'`,

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

然后执行插件的 `Task，./gradle dingjiaxiong`，输出如下

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

没问题

这种形式的写法，在我们整个工程的 module 都可以使用，但也只是限制在本工程，其他工程不能使用。

[Gradle_gradle_]: https://www.bilibili.com/video/BV1yT41137Y7
[99332805f5ac4e41933aa100d4c38567.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/56ecb9add2f743569c2ba694ca771aef.png
[fedd980264f94973a07f85a609a60cce.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/44d240c2e06544c3aa86c8ae48d913fe.png
[d60135d6be884514a056c315a85a3707.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e28ad4f354934018892beff5651dbf94.png
[eaebdb04d2dc44429569dd88a2e2fb07.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/9b29eebe71d041bb8488c965a7fc10c1.png
[4e3290a7e87a409d9210ea301041d185.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/1bca14fec89046f3a3be2b679616fff2.png
[11bac0609db64cfca87b8ac00b68f000.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/838b3bb7af6c46139945185e45f174d9.png
[c12e55ce0e204fadaf9967fd5e47390a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ab9afb5ab9694618ab31cd28c38997fb.png
[77cb4b8ff9d0419c804a7852a3976434.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/76915cc0172f400b885c2d8d79f8f939.png
[d3d9522ab6704478a835ee7d56b1a59e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/4c85bfa98b9b4568b8c3c3bdbc9b6cad.png
[b75e5f3f5a8546e49b7934e411cf55b2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e6b441517609479fb70338d47a0350f5.png
[3de2148fc2de46deb4c764c41842a0da.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ab07cfeb39eb433dae79dff66be8de96.png
[8f55617cb4f54701a74c8dd98e77e712.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/158d6d9e97d14bd685b66afd0e1055e7.png
[26a66134290641d6a4e1384eac18829a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/bbbf5434916a48fea09b67787a13734a.png
[edcb193819fd4842a6c7df927c00161a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e630b39ea97441cd97b04a5b8d7e2111.png