build.gradle配置（buildgradle配置全解）

## build.gradle 配置详解

简介

`build.gradle` 文件是 Gradle 构建系统的核心配置文件，用于定义项目构建的各个方面，例如依赖管理、编译选项、打包方式等等。它使用 Groovy 或 Kotlin DSL 编写，具备强大的灵活性和扩展性，能适应各种复杂的项目构建需求。本文将详细介绍 `build.gradle` 文件的常见配置项，并解释其作用。### 一、项目类型和版本在顶级 `build.gradle` 文件（通常位于项目根目录）中，你需要声明项目的类型和版本号。

`plugins {}` 块:

用于声明 Gradle 插件，这些插件提供特定的构建功能。例如，使用 Java 插件来构建 Java 项目，使用 Android 插件来构建 Android 应用。```groovy plugins {id 'java' // Java 项目id 'org.jetbrains.kotlin.jvm' version '1.8.20' // Kotlin 项目id 'application' // 应用 } ```

`group`:

定义项目的组织或组名，通常是反向域名。

`version`:

定义项目的版本号。

`java` 插件 (示例):

```groovy plugins {id 'java' }group 'com.example' version '1.0-SNAPSHOT'repositories {mavenCentral() // 指定依赖仓库 }dependencies {implementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.10.0' } ```### 二、依赖管理依赖管理是 `build.gradle` 文件中最重要的部分之一。 它定义了项目所依赖的库或模块。

`repositories {}` 块:

定义依赖库的获取来源，例如 Maven 中央仓库、JCenter（已关闭）、私有仓库等等。```groovy repositories {mavenCentral()jcenter() // Deprecated, use Maven Central insteadmaven { url "https://my-private-repo.com/releases" } } ```

`dependencies {}` 块:

定义项目依赖。 `implementation` 声明编译依赖，仅对当前模块可见；`api` 声明编译依赖，对依赖该模块的其他模块可见； `compileOnly` 只在编译时使用，不包含在运行时； `runtimeOnly` 只在运行时使用；`testImplementation` 仅用于测试代码的依赖； `testRuntimeOnly` 仅在测试运行时使用。```groovy dependencies {implementation 'com.google.guava:guava:31.1-jre'api 'org.apache.commons:commons-lang3:3.12.0'testImplementation 'junit:junit:4.13.2' } ```### 三、任务配置Gradle 提供了丰富的内置任务，你也可以自定义任务。

自定义任务 (示例):

```groovy task helloWorld {doLast {println "Hello, World!"} } ```### 四、构建过程配置你可以根据需要配置编译选项、打包方式等。

Java 插件的编译配置 (示例):

```groovy java {toolchain {languageVersion.set(JavaLanguageVersion.of(17))}withJavadocJar()withSourcesJar() } ```

打包配置 (示例):

(取决于所使用的插件)```groovy jar {manifest {attributes 'Main-Class': 'com.example.Main'} } ```### 五、多模块项目对于多模块项目，每个模块都有自己的 `build.gradle` 文件，根目录的 `build.gradle` 文件用于管理所有模块。

根项目的 `build.gradle` 文件 (示例):

```groovy plugins {id 'java'id 'org.jetbrains.kotlin.jvm' version '1.8.20' }subprojects {apply plugin: 'java'apply plugin: 'kotlin' } ```### 六、使用 Kotlin DSL你可以使用 Kotlin DSL 来编写 `build.gradle.kts` 文件，这提供了一种更现代化的配置方式。```kotlin plugins {kotlin("jvm") version "1.8.20"java }group = "com.example" version = "1.0-SNAPSHOT"repositories {mavenCentral() }dependencies {implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.0")testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.10.0") } ```这篇文章只涵盖了 `build.gradle` 配置的常见部分。 Gradle 功能非常强大，还有很多其他的配置项和插件可以探索，建议参考官方文档以获取更完整的资料。 记住，根据你的项目类型和需求选择合适的插件和配置。

build.gradle 配置详解**简介**`build.gradle` 文件是 Gradle 构建系统的核心配置文件，用于定义项目构建的各个方面，例如依赖管理、编译选项、打包方式等等。它使用 Groovy 或 Kotlin DSL 编写，具备强大的灵活性和扩展性，能适应各种复杂的项目构建需求。本文将详细介绍 `build.gradle` 文件的常见配置项，并解释其作用。

一、项目类型和版本在顶级 `build.gradle` 文件（通常位于项目根目录）中，你需要声明项目的类型和版本号。* **`plugins {}` 块:** 用于声明 Gradle 插件，这些插件提供特定的构建功能。例如，使用 Java 插件来构建 Java 项目，使用 Android 插件来构建 Android 应用。```groovy plugins {id 'java' // Java 项目id 'org.jetbrains.kotlin.jvm' version '1.8.20' // Kotlin 项目id 'application' // 应用 } ```* **`group`:** 定义项目的组织或组名，通常是反向域名。* **`version`:** 定义项目的版本号。* **`java` 插件 (示例):**```groovy plugins {id 'java' }group 'com.example' version '1.0-SNAPSHOT'repositories {mavenCentral() // 指定依赖仓库 }dependencies {implementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.10.0' } ```

二、依赖管理依赖管理是 `build.gradle` 文件中最重要的部分之一。 它定义了项目所依赖的库或模块。* **`repositories {}` 块:** 定义依赖库的获取来源，例如 Maven 中央仓库、JCenter（已关闭）、私有仓库等等。```groovy repositories {mavenCentral()jcenter() // Deprecated, use Maven Central insteadmaven { url "https://my-private-repo.com/releases" } } ```* **`dependencies {}` 块:** 定义项目依赖。 `implementation` 声明编译依赖，仅对当前模块可见；`api` 声明编译依赖，对依赖该模块的其他模块可见； `compileOnly` 只在编译时使用，不包含在运行时； `runtimeOnly` 只在运行时使用；`testImplementation` 仅用于测试代码的依赖； `testRuntimeOnly` 仅在测试运行时使用。```groovy dependencies {implementation 'com.google.guava:guava:31.1-jre'api 'org.apache.commons:commons-lang3:3.12.0'testImplementation 'junit:junit:4.13.2' } ```

三、任务配置Gradle 提供了丰富的内置任务，你也可以自定义任务。* **自定义任务 (示例):**```groovy task helloWorld {doLast {println "Hello, World!"} } ```

四、构建过程配置你可以根据需要配置编译选项、打包方式等。* **Java 插件的编译配置 (示例):**```groovy java {toolchain {languageVersion.set(JavaLanguageVersion.of(17))}withJavadocJar()withSourcesJar() } ```* **打包配置 (示例):** (取决于所使用的插件)```groovy jar {manifest {attributes 'Main-Class': 'com.example.Main'} } ```

五、多模块项目对于多模块项目，每个模块都有自己的 `build.gradle` 文件，根目录的 `build.gradle` 文件用于管理所有模块。* **根项目的 `build.gradle` 文件 (示例):**```groovy plugins {id 'java'id 'org.jetbrains.kotlin.jvm' version '1.8.20' }subprojects {apply plugin: 'java'apply plugin: 'kotlin' } ```

六、使用 Kotlin DSL你可以使用 Kotlin DSL 来编写 `build.gradle.kts` 文件，这提供了一种更现代化的配置方式。```kotlin plugins {kotlin("jvm") version "1.8.20"java }group = "com.example" version = "1.0-SNAPSHOT"repositories {mavenCentral() }dependencies {implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.0")testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.10.0") } ```这篇文章只涵盖了 `build.gradle` 配置的常见部分。 Gradle 功能非常强大，还有很多其他的配置项和插件可以探索，建议参考官方文档以获取更完整的资料。 记住，根据你的项目类型和需求选择合适的插件和配置。