Gradle自定义插件介绍1

前言

前面几篇文章笔者对Gradle的一些基础认知，groovy基础语法，以及Gradle 项目中常用的一些api进行了讲解。

今天笔者再来讲解一些关于Gradle插件的使用

1.定义

首先来讲下Gradle和Gradle插件有啥区别？

Gradle是一套构建工具，其内部构建过程主要是以Project组成一个树形的生态系统，整个构建流程有自己的生命周期。每个Project又是由若干个Task组成。

Gradle插件你可以理解为是运行在Gradle这套构建系统上的单个task,

如 执行脚本的编写 ，字节码插庄等，都可以依靠Gradle插件实现。

我们常用的Android Gradle Plugin也是一个Gradle插件模块：

应用插件的ID：‘com.android.application’
或者lib库：‘com.android.library’

2.有哪些优势

• 1.逻辑复用 :Gradle插件将一个公共模块单独的抽离出来，然后上传到共享平台，供其他项目使用
• 2.插件配置扩展 ：Gradle插件声明插件扩展，将插件内部参数暴露给对应的Project进行配置，大大提高了插件的可扩展性。

3.插件的形式

• 1. build script ：直接在build.gradle构建脚本中创建对应的插件，这种方式只对当前Project有效，不支持对外提供调用，无复用性，一般不推荐使用
• 2. buildSrc模块 ：这种方式是编译器提供的特殊模块，编译器可以自动识别该模块的，对所有的Project可见。但是在项目外不可见，无法给其他工程使用，复用性差。
• 3. 独立插件项目 ：替插件创建一个单独的项目，这个项目可以单独的打包成一个jar包，然后发布到企业服务器上供其他项目使用，通常这个插件中包含了一个或多个任务的组合，实现具体的插件功能

4.自定义插件实战

下面我会以第三种形式来大家实现一个简单的Gradle插件功能：

需求如下：

在编译过程中实现：将当前编译的版本信息发布到公司服务器上，可以在本地服务器上实时查看编译的版本日志,通过日志的分析可以对当前编译版本进行优化。

步骤如下 ：

• 1.初始化插件模块目录结构
• 2.创建插件实现类
• 3.创建插件扩展Bean
• 4.创建插件实现的任务:上传版本信息
• 5.将插件扩展和插件任务集成到Project生命周期中
• 6.插件发布
• 7.插件引入

步骤1.初始化插件模块目录结构

首先创建一个Java or Kotlin Library的模块，

步骤1创建.png

在创建的模块build.gradle中引入:

plugins {
    id 'groovy' // Groovy Language
    //id 'org.jetbrains.kotlin.jvm' // Kotlin 
    id 'java-gradle-plugin' // Java Gradle Plugin
}

• groovy :使用groovy语言开发
• org.jetbrains.kotlin.jvm ：使用kotlin开发引入kotlin核心插件库
• java-gradle-plugin ：Gradle插件的一个辅助插件，可以在我们build目录下自动生成资源属性

设置sourceSets：

sourceSets {
    main {
        groovy {
            srcDir 'src/main/groovy'
        }
        resources {
            srcDir 'src/main/resources'
        }
    }
}

工程目录结构如下：

插件目录结构.png

步骤2.创建插件实现类

class UploadVersionPlugin implements Plugin<Project>{
    @Override
    void apply(Project project) {
            println "begin:now this is a ${project.name} 's upload plugin"
    }
}

步骤3.创建插件扩展Bean

class VersionInfo {
    //版本名称
    String versionName
    //版本代码
    int versionCode
    //版本更新信息
    String versionUpdateInfo
}