JBang、Java エコシステムに欠けているスクリプト ツール

Java エコシステムには、Maven と Gradle という 2 つの強力なプロジェクト管理ツールがすでにありますが、シンプルで強力なスクリプト ツールが不足していました。
ここで JBang の出番です。
これは、最小限でありながら強力な Java、Kotlin、Groovy ファイル ランチャーです。
実際、スクリプトを実行するのと同じくらい簡単にコードを実行できます。
また、依存関係管理、テンプレート、App Store など、他の多くの機能も提供します。
この投稿では、JBang とその機能を詳しく見てみましょう。

設定

jbang コマンドラインは、ここで詳しく説明されているさまざまな方法を使用して Windows、Linux、macOS にインストールできます。
jbang --version.

を実行することで、インストールを確認できます。

それに加えて、お気に入りの IDE に付属の IDE 拡張機能をインストールすることをお勧めします。
サポートされている IDE 拡張機能はここにリストされています。

JBang は JRE への JDK には依存しませんが、Java を使用するスクリプトを実行するには JDK が必要です。
JDK 23 をインストールする jbang jdk install 23 を実行すると、JBang でインストールできます。

これで、最初のスクリプトを作成する準備が整いました。

最初のスクリプト

「Hello, World!」を出力する簡単なスクリプトを作成してみましょう。コンソールへ。

> jbang init helloworld.java

これにより、jbang helloworld.java で実行できる helloworld.java という名前のファイルが作成されます。

> jbang helloworld.java
Hello world

ファイルを開くと、メイン メソッドと特定の最初の行を含むプレーン Java ファイルであることがわかります。

///usr/bin/env jbang "<pre class="brush:php;toolbar:false">> chmod +x helloworld.java
> ./helloworld.java
Hello world

" "$@" ; exit $? import static java.lang.System.*; public class helloworld { public static void main(String... args) { out.println("Hello world"); } }

これから説明するように、JBang スクリプトは、シバン、オプションのプロパティ、スクリプト自体の 3 つの部分で構成されています。
次のセクションの 2 番目の部分でいくつかのプロパティを使用しますが、最初の部分に焦点を当てましょう。

この部分 ///usr/bin/env jbang "$0" "$@" ; $を終了しますか? JBang を使用してスクリプトを実行するようにシステムに指示します。
これは Unix エコシステムではシバンと呼ばれ、スクリプトのインタープリターを指定するために使用されます。
Unix システム (macOS、Linux) でこれを説明するには、chmod x helloworld.java を実行してスクリプトを実行可能にしてから、./helloworld.java.
を実行します。

/// usr/bin/env jbang "<pre class="brush:php;toolbar:false">///usr/bin/env jbang "<pre class="brush:php;toolbar:false">//JAVA 23+
//COMPILE_OPTIONS --enable-preview -source 23
//RUNTIME_OPTIONS --enable-preview

" "$@" ; exit $? //JAVA 23+ //COMPILE_OPTIONS --enable-preview -source 23 //RUNTIME_OPTIONS --enable-preview void main(String... args) { System.out.println("Hello World"); } " "$@" ; exit $? //JAVA 25 //COMPILE_OPTIONS --enable-preview -source 25 //RUNTIME_OPTIONS --enable-preview import java.util.concurrent.Callable; import java.util.concurrent.StructuredTaskScope; import static java.lang.System.*; void main(String... args) { out.println("Hello Java 25"); Callable task1 = () -> { out.println("Task 1" + Thread.currentThread()); return "Task 1"; }; Callable task2 = () -> { out.println("Task 2" + Thread.currentThread()); return 2; }; try ( var scope = new StructuredTaskScope

これで、Java ファイルと同じようにスクリプトを開発できるようになりました。
公開する準備ができたら、次のようにさまざまな形式でエクスポートできます:

• jar ファイル: jbang エクスポート ポータブル helloworld.java。スクリプトで依存関係を使用している場合は、次のコマンドの方が推奨されます。
• A fatjar: すべての依存関係が含まれています: jbang export fatjar helloworld.java。この方法でも、ターゲット マシンに JDK / JRE をインストールする必要があります。それを望まない場合は、次のコマンドの方が推奨されます。
• JDK を含む jlink バイナリ: jbang export jlink helloworld.java。実行するバイナリは、Unix の場合は helloworld-jlink/bin/helloworld、Windows の場合は helloworld-jlink/bin/helloworld.bat です。
• ネイティブ画像: jbang エクスポート ネイティブ helloworld.java。これには GraalVM のインストールが必要です。

スクリプトは、次のように mavenrepo としてエクスポートすることもできます: jbang export mavenrepo helloworld.java

JDK管理

前の章で説明したように、JBang はマシンに JDK をインストールできます。
jbang jdk list を使用してインストールされている JDK を一覧表示し、jbang jdk list --available --show-details を使用してインストール可能な JDK を一覧表示し、jbang jdk install [version] を使用して新しい JDK をインストールできます。 Jbang は、サポートされているシステム上で JDK を管理するための SDKMAN の使用もサポートしています。

さらに、スクリプト内で JDK バージョンを指定することができます。
これは、スクリプト プロパティに次の行を追加することで実行できます: //JAVA [version] 正確なバージョンが必要な場合、//JAVA [version] 少なくとも特定のバージョンが必要な場合。
その場合、JBang は必要な JDK バージョンを自動的にインストールし、システムのデフォルトの JDK を変更せずにそのスクリプトにのみ使用します。

たとえば、次のスクリプトは Java 25 といくつかのプレビュー機能を使用します。

> jbang init helloworld.java

「Main」クラスのないスクリプト

スクリプトは軽量になる傾向があるため、クラスや main メソッドを使用せずにスクリプトを記述することをお勧めします。
幸いなことに、Java には暗黙的に宣言されたクラスとインスタンスの main メソッドと呼ばれる機能があります (これは Java 23 ではまだプレビュー段階です)。
この機能を使用すると、クラスや静的メイン メソッドを使用せずに Java プログラムと JBang スクリプトを作成できます。

次のスクリプトは問題なくコンパイルされ、実行されます。

> jbang helloworld.java
Hello world

これは、次のプロパティをスクリプトに追加することで可能になります。

///usr/bin/env jbang "<pre class="brush:php;toolbar:false">> chmod +x helloworld.java
> ./helloworld.java
Hello world

" "$@" ; exit $? import static java.lang.System.*; public class helloworld { public static void main(String... args) { out.println("Hello world"); } }

最初の行 //JAVA 23 は、JBang に Java 23 以降を使用するように指示します。
2 行目と 3 行目の //COMPILE_OPTIONS --enable-preview -source 23 と //RUNTIME_OPTIONS --enable-preview は、それぞれコンパイルとランタイムのプレビュー機能を有効にします。

機能が安定したら、3 行を削除してもスクリプトは引き続き機能します。素敵です!

依存関係

JBang は、依存関係ごとに //DEPS atrefact-id:atrefact-name:version 行を追加することで、Gradle スタイルの依存関係の形式でスクリプトへの依存関係の追加をサポートします。
たとえば、jfiglet ライブラリを使用するには、次の行をスクリプトに追加します: //DEPS com.github.lalyos:jfiglet:0.0.8.

> jbang init helloworld.java

カタログ

JBang のカタログを使用すると、スクリプトとテンプレートを効率的に整理して共有できます。
この機能は、一般的なタスクやワークフロー用のスクリプトのコレクションを共有したいチームやコミュニティに特に役立ちます。
また、ソース コードを提供せずにスターター コードを配布したり、演習の結果を示したりしたい教師にも役立ちます。

カタログは、エイリアスとテンプレートという 2 つの項目グループを含む jbang-catalog.json という名前の JSON ファイルです。
エイリアスを使用すると、単純なコマンドを使用してカタログからスクリプトを実行できますが、テンプレートは新しいスクリプトの開始点を提供します。
カタログはリモートまたはローカルにすることができ、必要に応じてローカルまたはリモートのリポジトリを追加して使用することができます。
興味深いのは、JBang がセットアップ中に、いくつかのエイリアスとテンプレートを含むローカル カタログをすぐに作成することです。

JBang は、これらのディレクトリ内のローカル カタログを次の順序で検索します (ソース JBang ドキュメント):

1. 現在のディレクトリ、./jbang-catalog.json
2. ./.jbang/jbang-catalog.json 内
3. 親ディレクトリの ../jbang-catalog.json
4. 親の .jbang ディレクトリ内、../.jbang/jbang-catalog.json
5. そして、ファイル システムのルートに向かって手順 3 と 4 を再帰的に繰り返します
6. 最後のステップとして、$HOME/.jbang/jbang-catalog.json を調べます。

JBang は、GitHub、GitLab、Bitbucket などの多くのオープン ソース リポジトリにあるカタログをリモートで検索します。
この投稿では例として GitHub を使用します。
リモート カタログを作成するには、jbang-catalog.json をリポジトリのルート フォルダーに追加する必要があります。
その後、カタログは account/repository_name.
によって参照されます。 リポジトリの名前が jbang-catalog の場合は、アカウントごとにそれを参照できます。
したがって、たとえば、私の GitHub アカウントの名前が yostane で、jbang-catalog.json というファイルというカタログを含む cours-java という名前のリポジトリがある場合、yostane/cours-java によってそのカタログを参照できます。さらに、jbang-catalog という名前のリポジトリに jbang-catalog.json がある場合、それを yostane/jbang-catalog または単に yostane で参照できます。

> jbang helloworld.java
Hello world

次の章では、カタログのエイリアスとテンプレートを使用する方法を説明します。

別名

JBang のエイリアスを使用すると、カタログからスクリプトを実行できます。
完全な構文は、それぞれリモート エイリアスとローカル エイリアスを表す jbang alias@account/repository [args] と jbang alias [args] です。

エイリアスは、次の形式を使用してカタログ ファイルのエイリアス セクションで定義できます。

> jbang init helloworld.java

これは DevoxxMA 2024 でのセッション中に使用したカタログです。

> jbang helloworld.java
Hello world

次のコマンドを使用してこれらのエイリアスを実行できます:

• jbang palcli@yostane/cours-java マダム
• jbang palqrest@yostane/cours-java
• jbang hellojfx@yostane/cours-java

公式 JBang GitHub アカウントは、多くのエイリアスとテンプレートを含むカタログを提供します。
それらのいくつかを実行してみましょう:

• jbang httpd@jbangdev ローカル Web サーバーを実行します。
• jbang gavsearch@jbangdev [arg] search.maven.org で [arg] を検索します。

テンプレート

テンプレート。新しいスクリプトの開始点として使用できる事前定義されたスクリプトです。
これらは、次の形式を使用してカタログ ファイルのテンプレート セクションで定義されます:

///usr/bin/env jbang "<pre class="brush:php;toolbar:false">> chmod +x helloworld.java
> ./helloworld.java
Hello world

" "$@" ; exit $? import static java.lang.System.*; public class helloworld { public static void main(String... args) { out.println("Hello world"); } }

テンプレートが使用されると、JBang は file-refs プロパティ内のすべてのファイルのコピーを作成します。
ファイル参照に {basename} が含まれる場合、JBang はそれを作成中のスクリプトの名前に置き換えます。
ファイル参照で .qute 拡張子が使用されている場合、JBang は Qute テンプレート エンジンを使用します

すぐに使用できるテンプレートの例をいくつか示します:

• picocli を使用する CLI スクリプト: jbang init -t cli hellocli.java
• Quarkus の単一ファイル REST API: jbang init -t qrest helloqrest.java

コミュニティで共有されているインターネットのテンプレートを使用することもできます。
たとえば、次のコマンドは JUnit 単体テスト ファイルを作成します: jbang init -t junit@jbangdev file_to_test.java.
このコマンドから、jbangdev/jbang-catalog リポジトリでテンプレートを定義した jbang-catalog.json を見つけることができます。

/// usr/bin/env jbang "<pre class="brush:php;toolbar:false">///usr/bin/env jbang "<pre class="brush:php;toolbar:false">//JAVA 23+
//COMPILE_OPTIONS --enable-preview -source 23
//RUNTIME_OPTIONS --enable-preview

" "$@" ; exit $? //JAVA 23+ //COMPILE_OPTIONS --enable-preview -source 23 //RUNTIME_OPTIONS --enable-preview void main(String... args) { System.out.println("Hello World"); } " "$@" ; exit $? //JAVA 25 //COMPILE_OPTIONS --enable-preview -source 25 //RUNTIME_OPTIONS --enable-preview import java.util.concurrent.Callable; import java.util.concurrent.StructuredTaskScope; import static java.lang.System.*; void main(String... args) { out.println("Hello Java 25"); Callable task1 = () -> { out.println("Task 1" + Thread.currentThread()); return "Task 1"; }; Callable task2 = () -> { out.println("Task 2" + Thread.currentThread()); return 2; }; try ( var scope = new StructuredTaskScope

アプリストア

JBang App Store は、インデックス付きカタログのエイリアスを参照できる Web アプリです。
複雑なセットアップやインストールのプロセスを必要とせずに、さまざまなツールやユーティリティを見つけて使用するための便利な方法を提供します。
たとえば、yostane を検索すると、さまざまなカタログで定義したさまざまなエイリアスを見つけることができるはずです。
次の画像は検索結果を示しています。

App Store を閲覧して見つけた、興味深く面白いスクリプトをいくつか紹介します。

• カウセー。スクリプトの実行例をいくつか示します。
  • jbang Cowsay@ricksbrown/cowsay MOO!
  • jbang Cowsay@ricksbrown/cowsay -f Dragon 「私はヴェルドラ・テンペストです!」
• grep のような部分文字列を検索します: jbang grep@a-services "hello" 。
• 画像から PDF を作成します:images2pdf@a-services。次のコマンドは、2 つの画像から PDF ファイルを作成します。

///usr/bin/env jbang "<pre class="brush:php;toolbar:false">  {
    "catalogs": {},
    "aliases": {
      // aliases
    },
    "templates": {
      // templates
    }
  }

" "$@" ; exit $? //DEPS com.github.lalyos:jfiglet:0.0.9 import com.github.lalyos.jfiglet.FigletFont; public class DependenciesDemo { public static void main(String... args) throws Exception { System.out.println(FigletFont.convertOneLine("JBang is amazing")); } }

カタログを公開すると、次回 JBang AppStore にインデックスが作成された後にカタログが表示される可能性が高くなります。
これは、ここで定義されたスケジュールされた GitHub アクションです。

注目すべきフレームワークを使用したいくつかの例

JBang を使用すると、一般的なフレームワークやライブラリを使用する単一ファイル アプリケーションを作成できます。
例としては、Quarkus、picolcli、JavaFX などがあります。
次のセクションでいくつかの例を見てみましょう。

JavaFX (openjfx)

JavaFX はデスクトップおよび UI フレームワークです。
公式 Web サイトは openjfx.io で、追加の UI コンポーネントを提供し、JavaFX にモバイル アプリのサポートをもたらす Gluon によってもサポートされています。
JBang はこのフレームワークをサポートしており、単一ファイルの JavaFX アプリケーションの作成に使用できます。

JBang で作成された JavaFX アプリの例をいくつか示します:

• 基本ウィンドウ
• より美しいサンプル jbang https://gist.github.com/FDelporte/c69a02c57acc892b4c996a9779d4f830
• テンプレート jbang init -t javafx@yostane hellojfx

クォーカス

Quarkus は、Kubernetes およびサーバーレス環境用に最適化された Java フレームワークです。
起動時間が短く、メモリ消費量が少ないため、クラウドネイティブ アプリケーションに最適です。

JBang のおかげで、このフレームワークの力を活用する単一ファイルの Quarkus アプリケーションを作成できます。
次の例は、文字列が回文であるかどうかをテストする REST API を示しています。 JSON 解析、ロギング機能があり、OpenAPI と Swagger ドキュメントを提供します。

> jbang init helloworld.java

スクリプト内に //SOURCES PalindromeService.java 行があることに気づくかもしれません。
これは、スクリプトと同じディレクトリで PalindromeService.java という名前のファイルを探すように JBang に指示します。
これは、JBang が複数ファイルのスクリプトをサポートしていることを意味します。

jbang palqrest@yostane/cours-java でサーバーを実行し、curl http://localhost:8080/palindrome?input=madam でエンドポイントを呼び出すことができます。

> jbang helloworld.java
Hello world

その他の言語

JBang は Java、Kotlin、JShell、Groovy コードの実行をサポートしています。
マークダウン ファイルから Java コードを実行することもできます。
さまざまな言語で JBang を使用する方法の例をいくつか示します:

• Kotlin: jbang init -t hello.kt filename.kt を使用して Kotlin スクリプトを初期化できます。これは公式の .main.kts Kotlin スクリプトとは異なることに注意してください。実際、JBang によって作成された Kotlin スクリプトは、カタログと App Store の機能の恩恵を受けることができます。以下は、JBang で作成された Kotlin スクリプトの例です。

> jbang init helloworld.java

• 興味深い事実: JBang のアイデアは、Kotlin エコシステムを対象とした kscript から来ています。
• Kotlin はすでにネイティブ スクリプト サポート (.main.kts スクリプトを使用) を備えていますが、カタログ、テンプレート、App Store の機能が欠けているようです。
  • Groovy: jbang init -t hello.groovy filename.groovy を使用して Groovy スクリプトを初期化します。以下は、JBang で作成された Groovy スクリプトの例です。

> jbang helloworld.java
Hello world

• JShell: JBang は、.jsh または .jshell 拡張子を持つ JShell スクリプトと、jbang -c 'System.out.println("Inline Java ☕ yay!")' を使用したインライン スクリプトをサポートします。以下は、JBang で作成された JShell スクリプトの例です。

///usr/bin/env jbang "<pre class="brush:php;toolbar:false">> chmod +x helloworld.java
> ./helloworld.java
Hello world

" "$@" ; exit $? import static java.lang.System.*; public class helloworld { public static void main(String... args) { out.println("Hello world"); } }

• Java および JShell コード ブロックを使用したマークダウン: jbang my_markdown.md を使用して、マークダウン ファイルから Java および JShell コード ブロックを直接実行できます。

/// usr/bin/env jbang "<pre class="brush:php;toolbar:false">///usr/bin/env jbang "<pre class="brush:php;toolbar:false">//JAVA 23+
//COMPILE_OPTIONS --enable-preview -source 23
//RUNTIME_OPTIONS --enable-preview

" "$@" ; exit $? //JAVA 23+ //COMPILE_OPTIONS --enable-preview -source 23 //RUNTIME_OPTIONS --enable-preview void main(String... args) { System.out.println("Hello World"); } " "$@" ; exit $? //JAVA 25 //COMPILE_OPTIONS --enable-preview -source 25 //RUNTIME_OPTIONS --enable-preview import java.util.concurrent.Callable; import java.util.concurrent.StructuredTaskScope; import static java.lang.System.*; void main(String... args) { out.println("Hello Java 25"); Callable task1 = () -> { out.println("Task 1" + Thread.currentThread()); return "Task 1"; }; Callable task2 = () -> { out.println("Task 2" + Thread.currentThread()); return 2; }; try ( var scope = new StructuredTaskScope

以上がJBang、Java エコシステムに欠けているスクリプト ツールの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。