導入

対象者 : Gradle プラグインの作成に取り組みたい開発者

Gradleプラグインを効率的に開発するためには、適切に設定された開発環境が不可欠です。 良いセットアップは時間を節約し、フラストレーションを減らし、ビルドの一貫性を確保します。

このガイドは4つの重要な柱に焦点を当てています:
  1. Le JDK(Java Development Kit)、なぜならGradleとJBakeはJVM上で実行されます。

  2. Un 統合開発環境モダンな(IntelliJ IDEA)で、KotlinとGradleのサポートが良い。

  3. Gradle自身で、プロジェクトを初期化するために。

  4. JBake, 私たちの静的サイトのエンジン。

開発環境のコンポーネント
@startuml
!theme plain
node "開発者の機械" {
  component "JDK (JVM)" as JDK
  component "IntelliJ IDEA" as IDE
  component "Gradle (グローバル)" as Gradle
  component "JBake (グローバル)" as JBake

  IDE --> JDK : utilise
  Gradle --> JDK : utilise
  JBake --> JDK : utilise
}
@enduml

1. JDK: Gradleエンジン

Gradle は Java 仮想マシン (JVM) 上で実行されるアプリケーションです。 したがって、JDKのインストールは絶対に必要な前提条件です。

どのバージョンを選びますか?

JavaのLTS(Long-Term Support)バージョンを使用することをお勧めします。 現在,JDK 17 ou JDK 21非常に良い選択肢です。

SDKMAN! を介したインストール (推奨)

SDKMAN!は、JavaやGradleを含む多数のSDKのバージョンを管理するための優れたツールです。

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

インストールしたばかりのバージョンが表示されるはずです。

2. IDE : IntelliJ IDEA

Gradle プラグインの開発に Kotlin DSL を使用してIntelliJ IDEA選択のツールです。 Gradle と Kotlin との統合は比類ない。

  • コミュニティエディション :無料で、開始するには十分すぎるほどです。

  • アルティメットエディション:有料です。ウェブ開発とデータベースのための高度な機能を提供します。

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), あなたのプロジェクトに組み込まれたスクリプト。

なぜ?

  • 再現性:ラッパーは、プロジェクトで作業しているすべての人(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は、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`私たちの最初のプラグインプロジェクトの構造を生成するために。

関連記事