简介

目标受众 : 希望开始创建 Gradle 插件的开发者。

要高效地开发 Gradle 插件,一个配置良好的开发环境是必不可少的。 良好的设置会为您节省时间,减少挫败感,并确保您的构建保持一致。

本指南专注于四个关键支柱:
  1. Le Java 开发工具包(Java Development Kit),因为 Gradle 和 JBake 在 JVM 上运行。

  2. Un 集成开发环境使用现代化的 IntelliJ IDEA,对 Kotlin 和 Gradle 提供了良好的支持。

  3. Gradle他自己,为了初始化项目。

  4. JBake, 我们静态网站的引擎。

gradle env
Figure 1. 开发环境的组件

1. JDK:Gradle 的引擎

Gradle 是一个运行在 Java虚拟机(JVM) 上的应用程序。 因此,安装 JDK 是绝对的前置条件。

选择哪个版本?

建议使用 Java 的长期支持(LTS)版本。 目前,JDK 17 ou JDK 21是很好的选择。

通过 SDKMAN! 安装(推荐)

SDKMAN! 是管理众多 SDK 版本(包括 Java 和 Gradle)的绝佳工具。

安装 SDKMAN!

curl -s "https://get.sdkman.io" | bash source "$HOME/.sdkman/bin/sdkman-init.sh"

安装 JDK 版本

# Pour lister les versions de Java disponibles sdk list java

# Pour installer Java 17 (par exemple, la distribution Temurin)
sdk install java 17.0.8-tem

检查安装

java -version

您应该能看到您刚刚安装的版本显示出来。

IDE:IntelliJ IDEA

用于使用 Kotlin DSL 开发 Gradle 插件,IntelliJ IDEA是首选工具。 其与Gradle和Kotlin的集成无与伦比。

  • 社区版:免费且足够充裕,可以开始。

  • 终极版:付费版,它提供了用于Web开发和数据库的高级功能。

从JetBrains网站下载适合您的版本:https://www.jetbrains.com/idea/download/

IDE 将自动检测您的文件`build.gradle.kts` et settings.gradle.kts, 提供强大的自动补全、代码导航和集成调试工具。

3. Gradle:构建工具

虽然每个项目都会通过 Gradle Wrapper 使用其自己的 Gradle 版本,但拥有全局 Gradle 安装对于诸如初始化新项目之类的任务仍然很有用 (gradle init)

通过 SDKMAN! 安装

同样如同 JDK,SDKMAN! 简化了 Gradle 的安装。

安装 Gradle

sdk install gradle

检查安装

gradle -v

此命令将显示所使用的 Gradle、Kotlin、Groovy 和 JDK 版本。

4. JBake : 静态站点生成器

JBake 是我们将用来将源文件(如这个)转换为静态网站的工具。 �拥有本地安装对于预览更改很方便。

通过SDKMAN! 安装

与其他工具一样,SDKMAN! 是最简单的方法。

安装 JBake

sdk install jbake

检查安装

jbake -v

此命令将显示 JBake 的版本及其使用的 Java 环境信息。

5. Gradle 包装器:绝对的最佳实践

创建您的项目后(我们将在下一篇文章中介绍),您不应该再使用全局命令。gradle. 您将使用Gradle 包装器 (./gradlew), 一个包含在您的项目中的脚本。

为什么?

  • 可重复性:Wrapper 确保项目中的每个人(包括您的 CI/CD 服务器)都使用完全相同的相同版本的 Gradle, 从而消除了由于不同环境导致的构建错误。

  • 简洁:不需要手动安装 Gradle 即可为项目做出贡献。

只需克隆仓库并启动`./gradlew`.

一个典型的命令将如下所示:

# Ne pas faire : gradle build
# À faire :
./gradlew build

6. Docker 和 Portainer:实现可重复构建(可选)

虽然在编写插件时并非严格必需,但 Docker 和 Portainer 是现代的 DevOps 工具,极大地便利了创建可重现的构建以及管理您的环境。

Docker Engine 安装

Docker 允许您将应用程序及其依赖项打包到一个容器中。

通过官方脚本安装 Docker :

curl -fsSL https://get.docker.com -o get-docker.sh sudo sh get-docker.sh

管理 Docker 不使用 sudo(推荐):

将您的用户添加到组`docker`.

sudo usod -aG docker $USER
docker run hello-world

使用 Portainer (GUI) 管理 Docker

Portainer 是一个轻量级的 Web 界面,用于管理您的 Docker 容器。

创建一个用于 Portainer 数据的卷 :

docker volume create portainer_data

启动 Portainer 容器:

docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:latest

您现在可以访问Portainer界面在`https://localhost:9443`.

结论

您的环境现在已准备好! 您�拥有 JDK、最合适的 IDE、Gradle 和 JBake。 加入 Docker 后,您也已准备好创建容器化且可复现的构建。 这个坚实的基础将让你能够专注于本质:开发强大而实用的插件。

在下一篇文章中,我们将使用该命令`gradle init`用于生成我们第一个插件项目的结构。

相关文章