Vert.x Gradle 插件使用教程
1. 项目目录结构及介绍
vertx-gradle-plugin/
├── build.gradle.kts
├── gradle/
│ └── wrapper/
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── LICENSE
├── README.adoc
├── settings.gradle.kts
└── src/
├── main/
│ ├── java/
│ └── resources/
└── test/
├── java/
└── resources/
目录结构介绍
- build.gradle.kts: 项目的构建脚本,定义了项目的依赖、插件和其他构建配置。
- gradle/: 包含 Gradle Wrapper 的相关文件,用于确保项目使用一致的 Gradle 版本。
- gradlew: Gradle Wrapper 的 Unix 脚本,用于在 Unix 系统上运行 Gradle 构建。
- gradlew.bat: Gradle Wrapper 的 Windows 脚本,用于在 Windows 系统上运行 Gradle 构建。
- LICENSE: 项目的开源许可证文件。
- README.adoc: 项目的说明文档,通常包含项目的概述、使用方法和贡献指南。
- settings.gradle.kts: 项目的设置文件,定义了项目的名称、模块和其他全局设置。
- src/: 项目的源代码目录,包含主代码和测试代码。
- main/: 主代码目录,包含 Java 源代码和资源文件。
- test/: 测试代码目录,包含测试用例和测试资源文件。
2. 项目的启动文件介绍
build.gradle.kts
build.gradle.kts
是项目的构建脚本,定义了项目的依赖、插件和其他构建配置。以下是一个简单的示例:
plugins {
id("io.vertx.vertx-plugin") version "x.y.z" // (1)
}
repositories {
jcenter()
}
vertx {
mainVerticle = "sample.App"
}
启动文件介绍
- plugins: 定义了项目使用的插件,这里使用了
vertx-plugin
插件来简化 Vert.x 项目的构建和运行。 - repositories: 定义了项目的依赖仓库,这里使用了
jcenter()
仓库。 - vertx: 配置了 Vert.x 相关的属性,例如
mainVerticle
,指定了主 Verticle 的类名。
3. 项目的配置文件介绍
settings.gradle.kts
settings.gradle.kts
是项目的设置文件,定义了项目的名称、模块和其他全局设置。以下是一个简单的示例:
rootProject.name = "vertx-gradle-plugin"
配置文件介绍
- rootProject.name: 定义了项目的根名称,通常与项目的目录名称一致。
gradle/wrapper/gradle-wrapper.properties
gradle-wrapper.properties
文件定义了 Gradle Wrapper 的配置,确保项目使用一致的 Gradle 版本。以下是一个示例:
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
配置文件介绍
- distributionUrl: 指定了 Gradle 发行版的下载地址,确保项目使用特定的 Gradle 版本。
- distributionBase 和 zipStoreBase: 定义了 Gradle 发行版和 ZIP 文件的存储位置。
通过以上配置,项目可以确保使用一致的 Gradle 版本,并且简化了 Vert.x 项目的构建和运行过程。