17 gradle 中 添加插件的方法和注意点

在官网上https://plugins.gradle.org/?_ga=1.178671588.1784557816.1480580600 可以查看到所有的gradle插件

找到某个插件，点进去，会发现插件的引用方式，比如Tomcat的引用方式

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "com.bmuschko:gradle-tomcat-plugin:2.2.5"
  }
}

apply plugin: "com.bmuschko.tomcat"

和自己原来的配置 融合一下就变成了这样：

build.gradle

group 'test-gradle-groovy'
version '1.0-SNAPSHOT'

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "com.bmuschko:gradle-tomcat-plugin:2.2.5"
    }
}
apply plugin: "com.bmuschko.tomcat"
apply plugin: 'groovy'
apply plugin: 'java'
apply plugin: 'jetty'

sourceCompatibility = 1.8
repositories {
    mavenCentral()
}
dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.11'
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

感觉好奇怪啊，为什么是这样写呢？

apply plugin: 'spring-boot' 需要 classpath("org.springframework.boot:spring-boot-gradle-plugin:1.2.3.RELEASE")

apply plugin: 'com.moowork.gulp' 需要classpath 'com.moowork.gradle:gradle-gulp-plugin:0.10'

在编写Gradle脚本的时候，在build.gradle文件中经常看到这样的代码：

build.gradle

1 2 3 4 5 6 7 8 9

buildScript { repositories { mavenCentral() } } repositories { mavenCentral() }

这样子很容易让人奇怪，为什么repositories要声明两次哪？buildscript代码块中的声明与下半部分声明有什么不同？

其实答案非常简单。buildscript中的声明是gradle脚本自身需要使用的资源。可以声明的资源包括依赖项、第三方插件、maven仓库地址等。

而在build.gradle文件中直接声明的依赖项、仓库地址等信息是项目自身需要的资源。

gradle是由groovy语言编写的，支持groovy语法，可以灵活的使用已有的各种ant插件、基于jvm的类库，

这也是它比maven、 ant等构建脚本强大的原因。虽然gradle支持开箱即用，但是如果你想在脚本中使用一些第三方的插件、类库等，

就需要自己手动添加对这些插件、类库的 引用。而这些插件、类库又不是直接服务于项目的，而是支持其它build脚本的运行。

所以你应当将这部分的引用放置在buildscript代码块中。 gradle在执行脚本时，会优先执行buildscript代码块中的内容，

然后才会执行剩余的build脚本。

举个例子，假设我们要编写一个task，用于解析csv文件并输出其内容。虽然我们可以使用gradle编写解析csv文件的代码，

但其实 apache有个库已经实现了一个解析csv文件的库供我们直接使用。我们如果想要使用这个库，

需要在gradle.build文件中加入对该库的引用。

build.gradle

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

buildscript { repositories { mavenLocal() mavenCentral() } dependencies { classpath 'org.apache.commons:commons-csv:1.0' } } import org.apache.commons.csv.* task printCSV() { doLast { def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv')) for (item in records) { print item.get(0) + ' ' println item.get(1) } } }

buildscript代码块中的repositories和dependencies的使用方式与直接在build.gradle文件中的使用方 式几乎完全一样。

唯一不同之处是在buildscript代码块中你可以对dependencies使用classpath声明。该classpath声 明说明了在执行其余的build脚本时，

class loader可以使用这些你提供的依赖项。这也正是我们使用buildscript代码块的目的。

而如果你的项目中需要使用该类库的话，就需要定义在buildscript代码块之外的dependencies代码块中。

所以有可能会看到在build.gradle中出现以下代码：

build.gradle

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

repositories { mavenLocal() mavenCentral() } dependencies { compile 'org.springframework.ws:spring-ws-core:2.2.0.RELEASE', 'org.apache.commons:commons-csv:1.0' } buildscript { repositories { mavenLocal() mavenCentral() } dependencies { classpath 'org.apache.commons:commons-csv:1.0' } } import org.apache.commons.csv.* task printCSV() { doLast { def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv')) for (item in records) { print item.get(0) + ' ' println item.get(1) } } }