Android Gradle 学习笔记（六）：Gradle 插件

Gradle 本身提供了一些基本的概念和整体核心的框架，其他用于描述真实使用场景的都可以通过插件扩展的方式来实现。这样就可以通过抽象的方式提供一个核心的框架，其他具体的功能和业务都通过插件扩展的方式来实现。

Gradle 内置了很多常用的插件，基本满足大部分工作，但是也有一些插件是没有内置的，这时候就需要我们扩展现有插件或者自定义插件来达到我们的目的。比如 Android Gradle 插件就是基于内置的Java插件实现的。

一、插件的作用

插件会扩展项目的功能，帮助我们在项目的构建的过程中做很多事情：

• 可以添加任务到项目中，帮助完成诸如 测试、编译、打包等事情。
• 可以添加依赖配置到项目中，通过它们来配置我们在构建过程中的依赖。
• 可以向项目中现有的对象类型添加新的扩展属性、方法等，可以使用它们来配置优化构建。例如：android{}这个配置块就是Android Gradle插件为Project对象添加的一个扩展。
• 可以对项目进行一些约定，比如应用Java插件后，可以约定src/main/java目录下是我们的源代码的存放地址，在编译的时候也是编译这个目录下的Java源代码文件。

这就是插件，我们只需要按照它约定的方式，使用它提供的任务、方法或者扩展，就可以对我们的项目进行构建。

二、如何应用插件

插件的应用都是通过Project.apply()方法完成的。apply有好几种用法，并且插件也分为二进制插件和脚本插件。下面我们分别介绍一下：

1. 应用二进制插件

二进制插件就是实现了org.gradle.api.Plugin接口的插件，它们可以有plugin id。

举例：下面我们看一下如何应用一个Java插件：

apply plugin:'java'

使用上面的语句就可以把java插件应用到我们的项目中了，其中‘java’就是Java插件的plugin id，它是唯一的。

2. 应用脚本插件

脚本插件的使用方式如下例所示：

build.gradle：

apply from:'version.gradle'

task outVersion {

    println("APP版本是：${versionName},版本号是：${versionCode}")
    
}

version.gradle：

ext {
    versionName = '1.3.0'
    versionCode = 1
}

允许结果如下：

renhui$ gradle outVersion

> Configure project :
APP版本是：1.3.0,版本号是：1

BUILD SUCCESSFUL in 0s

应用脚本插件，其实就是把脚本加载进来，和二进制插件不同的是它使用的是from关键字，后面紧跟着一个脚本文件（可以是本地文件，也可以是网络文件）。

脚本插件能帮助我们把较大较复杂的脚本文件进行分块、分段整理，它是脚本文件模块化的基础。

3. 应用第三方发布的插件

第三方发布的作为jar的二进制插件，我们在应用的时候，必须要在buildscript{}里面配置其classpath才能使用，这个不像Gradle为我们内置的插件。

比如我们的Android Gradle插件就属于Android发布的第三方插件，如果我们要使用它就要先配置，示例如下：

buildscript {
    repositories {
        google()
        jcenter()
        
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'
    }
}

buildscript{}块是一个在构建项目之前，为项目进行前期准备和初始化相关配置依赖的地方，配置好所需的依赖，就可以应用其提供的插件了。

下面是在app层应用android gradle插件的方式：

apply plugin: 'com.android.application'

如果没有提前在buildscript里配置依赖的classpath，则会报错，提示找不到这个插件。

三、Java Gradle 插件

使用Java Gradle插件我们能够很轻松的构建出一个项目，我们常用的方式就是使用简称应用Java Gradle插件：

apply plugin: 'java'

通过以上的配置，Java插件会为工程添加很多有用的默认设置和约定，比如源代码的位置，单元测试代码的位置、资源文件的位置等。

作为Java项目，我们不可避免的会依赖很多第三方的Jar，这也是值得提倡的，因为有很多开源的工具和框架能够帮助我们更加高效的开发。下面我们就讲一下如何配置第三方依赖。

1. 配置第三方依赖

想要使用这些第三方依赖，就需要告诉Gradle如何找到这些依赖，也就是我们要讲的依赖配置。

一般情况下我们都是从仓库中查找我们需要的Jar包，在Gradle中要配置一个仓库的Jar依赖，首先我们得告诉Gradle我们要是有什么类型的仓库，这些仓库的位置在哪里，这样Gradle就知道从哪里去搜寻我们依赖的Jar，例如：

respositories {
    mavenCentral()
}

以上代码，我们配置了一个Maven中心库，告诉Gradle可以在Maven中心库中搜寻我们依赖的Jar，除此之外，我们也可以从jcenter库、ivy库、本地Maven库mavenLocal等中搜寻。由此可见，Gradle支持的仓库非常丰富，也可以多个仓库一起使用。比如一些公共的开源框架可以从mavenCenteral上下载，一些我们公司私有的Jar可以在自己搭建的Maven私服上下载：

respositories {
    mavenCentral()
    maven {
         url 'http://www.mavenurl.com'
    }
}

有了仓库，我们就可以通过配置告诉Gradle，我们需要依赖什么，例如：

dependencies {
     compile group: 'com.squareup.okhttp3', name: 'okhttp', version: '3.0.1'    
}

在上面的例子中，我们配置了一个okhttp的依赖，其中compile是依赖名称，它的意思表示我们在编译Java源文件时需要依赖okttp，并提供了GAV信息。

但是相对来说，上面的写法还是稍显麻烦的，Gradle为我们提供了简写的方式：

dependencies {
     compile 'com.squareup.okhttp3:okhttp:3.0.1'    
}

2. 配置项目&文件依赖

除了我们在上面提到的仓库的三方依赖，我们还可以进行项目的依赖以及文件的依赖。

项目依赖示例：

dependencies {
     compile project(':example')    
}

依赖后，此项目中的Java等类就可以进行使用了，就像使用自己项目中的类一样。

文件依赖，一般是依赖一个jar包（出于某些原因，不能将jar发布到Maven中心库中，只能放在项目中），例如：

dependencies {
     compile files('libs/example')    
}

通过上面的配置，我们就能成功引入这两个Jar包了。

但有时候，libs文件里的类太多了，不能一个个写，这时候我们就可以通过以下的方式配置：

dependencies {
     compile fileTree(dir: 'libs', include: '*.jar')    
}

这样配置后，libs下的文件夹的扩展名为jar的都会被依赖，非常方便。