build.gradle标签详解

一、简介

Gradle是一个开源的构建自动化工具，主要用于Java、Groovy和其他JVM语言的项目。它使用一个基于Groovy或Kotlin的特定领域语言(DSL)来声明项目设置，从而摒弃了基于XML的繁琐配置。build.gradle是Gradle项目的核心配置文件，它定义了项目的构建逻辑，包括依赖关系、任务、插件和其他构建相关的设置。

二、`build.gradle`基础结构

在build.gradle文件中，通常包含以下几个部分：

插件：通过plugins标签应用所需的插件，如Java插件、Android插件等。插件可以为项目添加新的任务、属性和方法。
仓库：通过repositories标签配置项目的仓库，指定Gradle从哪些仓库下载依赖项。常见的仓库有Maven Central、JCenter和自定义的Maven仓库。
依赖项：通过dependencies标签声明项目所需的各种库和框架的依赖关系。Gradle会自动下载和管理这些依赖项。
任务：通过任务定义项目的构建过程。Gradle提供了许多内置任务，如编译、测试和打包等。开发者也可以定义自定义任务来执行特定的构建逻辑。

三、`build.gradle`标签详解

plugins标签

plugins标签用于声明并应用项目所需的插件。插件可以扩展Gradle的功能，为项目添加新的任务、属性和方法。在plugins标签中，可以使用id属性指定插件的标识符，Gradle会自动下载并应用该插件。

plugins {id 'java' // 应用Java插件id 'org.springframework.boot' version '2.5.4' // 应用Spring Boot插件并指定版本号
}

repositories标签

repositories标签用于配置项目的仓库。Gradle需要从仓库中获取项目依赖的库和插件。在repositories标签中，可以指定多个仓库，Gradle会按照声明的顺序依次查找依赖项。

repositories {mavenCentral() // 使用Maven中央仓库jcenter() // 使用JCenter仓库（已弃用）maven { url 'https://example.com/repo' } // 使用自定义的Maven仓库
}

dependencies标签

dependencies标签用于声明项目所需的各种库和框架的依赖关系。在dependencies标签中，可以使用不同的配置来指定依赖项的作用范围和传递性。

dependencies {implementation 'com.google.guava:guava:30.1-jre' // 编译时依赖，传递性testImplementation 'junit:junit:4.13.2' // 测试时依赖，不传递runtimeOnly 'com.h2database:h2:1.4.200' // 运行时依赖，不参与编译
}

task标签

task标签用于定义自定义任务，可以指定任务的名称、类型、依赖关系和执行逻辑。

task customTask {doLast {println 'Executing custom task'}
}

四、高级配置与技巧

自定义属性：通过ext关键字定义自定义属性，可以在构建脚本中共享和使用这些属性。
构建脚本模块化：对于大型项目，可以将构建逻辑拆分成多个脚本文件，并通过apply from语句引入。
多项目构建：对于包含多个子项目的复杂项目，可以使用settings.gradle文件定义项目的层次结构和包含的子项目。
构建缓存：Gradle支持构建缓存，通过重用先前构建的输出，可以显著减少构建时间。
Gradle Wrapper：Gradle Wrapper是一个便捷的构建工具包装器，它可以确保每个开发者使用相同版本的Gradle进行构建。

如下：
build.gradle 文件

plugins {id 'java' // 应用Java插件id 'application' // 如果需要打包成可执行应用，可以加上这个插件
}repositories {mavenCentral() // 使用Maven中央仓库// 还可以添加其他的仓库，如jcenter()（虽然它现在已经被废弃）或者自定义的Maven仓库
}dependencies {// 声明项目依赖implementation 'com.google.guava:guava:30.1-jre' // 例如，添加Google Guava库testImplementation 'junit:junit:4.13.2' // 添加JUnit测试库
}application {mainClassName = 'com.example.Main' // 设置主类，仅当使用'application'插件时需要
}// 配置Java编译选项
java {sourceCompatibility = JavaVersion.VERSION_1_8 // 设置源代码兼容性，例如Java 8targetCompatibility = JavaVersion.VERSION_1_8 // 设置目标代码兼容性，例如Java 8
}// 如果有需要，可以配置自定义的源代码集
sourceSets {main {java {srcDirs = ['src/main/java'] // 设置主源代码目录}resources {srcDirs = ['src/main/resources'] // 设置主资源目录}}test {java {srcDirs = ['src/test/java'] // 设置测试源代码目录}resources {srcDirs = ['src/test/resources'] // 设置测试资源目录}}
}// 配置测试任务
test {useJUnit() // 使用JUnit进行测试testLogging {events "passed", "skipped", "failed" // 显示测试通过、跳过和失败的事件}
}// 如果有需要，可以添加自定义任务
task customTask {doLast {println 'This is a custom task!'}
}// 配置打包任务，例如创建一个可执行的JAR
jar {  manifest {  attributes 'Main-Class': 'com.example.Main'  }  doLast {  copy {  from 'some/directory'  into archiveBaseDir.get().asFile.toPath('some/path/in/jar')  }  }  
}