Skip to main content

Gradle命令

Gradle 提供了一组命令行工具来执行各种构建任务，以下是一些常用的 Gradle 命令及其用途。

1. gradle build​

gradle build

作用:
执行完整的构建流程，包含编译代码、运行测试、生成 JAR 文件等所有相关步骤。

使用场景:

  • 完成整个构建过程并生成可分发的产物。

2. gradle clean​

gradle clean

作用:
删除先前的构建输出（如 build/ 目录），为后续的构建任务创建干净的环境。

使用场景:

  • 当构建环境有问题或者需要重新构建整个项目时。

3. gradle assemble​

gradle assemble

作用:
构建项目的输出产物（如 JAR 或 WAR 文件），但不会运行测试。

使用场景:

  • 只想打包项目，不运行测试时使用。

4. gradle test​

gradle test

作用:
编译项目并运行所有测试。

使用场景:

  • 在确保代码正确性时使用，可以单独运行测试任务。

5. gradle check​

gradle check

作用:
运行所有验证任务，包括测试、代码质量检查等。

使用场景:

  • 在项目中有代码质量工具时（如 Checkstyle、PMD、SpotBugs 等），希望对代码质量进行全面检查时使用。

6. gradle dependencies​

gradle dependencies

作用:
显示项目的依赖树，帮助分析项目中引入的所有依赖项及其传递性依赖。

使用场景:

  • 当你需要检查某个依赖项的版本或分析传递性依赖时。

7. gradle tasks​

gradle tasks

作用:
列出项目中可用的所有任务，包括自定义的和 Gradle 提供的任务。

使用场景:

  • 当不确定有哪些可用的 Gradle 任务时，或需要查看项目中的自定义任务时。

8. gradle run​

gradle run

作用:
运行项目中的 main 方法。需要项目配置了 application 插件。

使用场景:

  • 当项目是一个可执行的应用程序时，用于直接从命令行运行项目。

9. gradle bootRun​

gradle bootRun

作用:
启动 Spring Boot 应用程序。需要项目应用了 Spring Boot 插件。

使用场景:

  • 在开发 Spring Boot 项目时，用于快速启动应用程序进行测试和开发。

10. gradle jar​

gradle jar

作用:
生成项目的 JAR 文件（如果项目是 Java 项目）。

使用场景:

  • 只想生成 JAR 文件，而不运行其他构建任务时使用。

11. gradle bootJar​

gradle bootJar

作用:
生成 Spring Boot 可执行 JAR 文件，包含所有依赖项和应用程序代码。

使用场景:

  • 在 Spring Boot 项目中使用，打包项目成可执行的 JAR 文件。

12. gradle publish​

gradle publish

作用:
将构建的产物发布到远程仓库，前提是项目配置了 publishing 插件。

使用场景:

  • 当你需要将项目发布到 Maven 仓库或其他远程仓库时。

13. gradle wrapper​

gradle wrapper

作用:
生成或更新 Gradle Wrapper 脚本 (gradlew)，确保项目使用特定版本的 Gradle 来构建。

使用场景:

  • 确保团队成员和 CI 环境使用相同版本的 Gradle 构建项目。

14. gradle help​

gradle help

作用:
显示帮助信息，解释命令行选项和常见命令的使用方法。

使用场景:

  • 当不确定如何使用某个命令或选项时，查看帮助文档。

15. gradle properties​

gradle properties
``)
**作用**:  
列出项目的所有属性（包括 Gradle 系统属性和自定义属性）。

**使用场景**:  
- 查看项目的当前配置及其属性值。

---

### 16. **`gradle init`**
```bash
gradle init

作用:
初始化新的 Gradle 项目结构，自动生成 build.gradle、settings.gradle 和标准的目录结构。

使用场景:

  • 当需要快速开始一个新项目时。

总结​

  • build 和 clean 是最常用的命令，负责构建和清理项目。
  • test、check、dependencies 让你能够测试项目并分析依赖关系。
  • bootRun 和 bootJar 主要用于 Spring Boot 项目。
  • gradle wrapper 和 publish 对于项目发布和配置统一构建环境很有用。

这些命令让 Gradle 在各种项目类型中能够快速、灵活地执行构建、测试、发布等任务。