Quarkus エクステンションの成熟度マトリックス

ほとんどのエクステンションの場合、これが最低限の期待値です。 既存のライブラリーをラップする場合、これは通常簡単に実現できますが、エクステンションがまったく新しい機能を提供する場合は、もう少し作業が必要になる可能性があります。Quarkus は、ユニットテストと結合テスト エクステンション用のツールを提供します。

場合によっては、ラップされたライブラリーが開発モードに対応できるように追加の作業が必要になることがあります。これは、クラスローディングの仕組みが異なり、ホットリロードによって一部の前提が崩れる可能性があるためです。エクステンションは、Dev モード向けの特別な処理 を追加することもできます。 Dev モードを検証する自動テストを追加するには、QuarkusDevModeTest を拡張するテスト を追加できます。

多くのライブラリーにとって、ネイティブモードのサポートはエクステンションを作成する主な動機です。必要になる可能性のあるいくつかの適応の詳細は、ネイティブ実行可能ファイルのサポートに関するガイド を参照してください。

エクステンションは、Quarkus 設定モデルとの統合 によって、Quarkus のインテグレーション設定をサポートする必要があります。 エクステンションの作成ガイドには、Quarkus の設定 に関する詳細なガイダンスが記載されています。

Quarkus エクステンションは、ユーザーアプリケーションがスムーズに使用できるように、CDI 経由でコンポーネントを公開 することを目指す必要があります。 すべてを CDI Bean として注入可能にしておくと、特に mocking でテストにも役立ちます。

Dev Services は通常、データソースのデータベース、セキュリティーの Keycloak インスタンス、メッセージングの Apache Kafka インスタンスなど、何かに接続するエクステンションに関連しています。

開発サービスを提供するには、 DevServicesResultBuildItem ビルドアイテムを使用します。詳細は、Dev Services のハウツー を参照してください。

すべてのエクステンションには、Dev UI のタイルが表示されます。デフォルトのタイルは、エクステンションメタデータ から情報を取得します。これは、メタデータを正しく取得するために少し時間をかける必要があるもう 1 つの理由です。

エクステンションは、Dev UI フックを使用して、ユーザーに追加情報を提示します。たとえば、タイルに外部コンソールへのリンクや、単純なテキストメトリクスを表示する内部ページを含めることができます。エクステンション開発者向けの Dev UI ガイドを参照してください。

一部のエクステンションは非常に洗練された Dev UI を提供します。 たとえば、実行中のアプリケーションと対話したり、リロードに応答したり、アプリケーションメトリクスを視覚化したり、アプリケーション固有のログをストリームしたりできるようになります。 エクステンション開発者向けの開発 UI ガイドでも、これらのより高度なオプションについて説明しています。

Quarkus のビルド時最適化の思想により、エクステンションは API のボイラープレートを整理し、プログラミングモデルをより簡潔かつ表現力豊かにすることができます。 出発点としては、Jandex を使用して、ユーザーのコードをスキャンし、アノテーションやその他のマーカーを検出する方法が適切で一般的です。 新しく便利な方法を提供することは適切ですが、ユーザーが慣れ親しんでいる通常のパターンを壊さないことも重要です。

この分野でのアイデアの参考として、シンプル化されたロギング、Panache を使用したシンプルな Hibernate ORM、@RestQuery アノテーション、または Quarkus がテストコンテナを 設定なしで使用できるようにする方法 を参照してください。

Codestarts は、ユーザー向けのアプリケーションを生成するために使用できるテンプレートです。 エクステンションは、独自のコードスタートテンプレートを提供する ことができます。

可能な限り多くの初期化を静的に実行します。 これにより、実行時のオーバーヘッドを回避できます。

多くの Java ライブラリーは、実行時に判断を遅らせるためにリフレクションを多用しています。Quarkus は、ロジックをビルド時に移行し、不必要な動的処理を削減することでパフォーマンスを向上させることを目指しています。 エクステンションは、リフレクションをビルド時のコードに置き換えることを目標とすべきです。これを可能にするのが、Jandex という「オフライン・リフレクション」ライブラリーです。また、既存のライブラリーに対してバイトコード変換を行う必要がある場合もあります。

リフレクションを排除する方法と、それがパフォーマンスにどのようなメリットをもたらすかについてのケーススタディについては、 リフレクションなしの Jackson のシリアル化 を参照してください。

すべてのライブラリーが、そのままでは仮想スレッドでの使用に適しているわけではありません。 "なぜすべての場所で仮想スレッドを使わないのか?" にその理由が説明されています。

ライブラリーを仮想スレッドで適切に動作させるには、ライブラリーがキャリアースレッドを固定していないことを確認する必要があります。 Quarkus には、これらのチェックを自動的に行うためのテストヘルパー があります。 ディスパッチ作業には、Quarkus によって管理される仮想エグゼキューター を使用する必要があります。WebSockets-next エクステンション は、仮想ディスパッチャーとスマートディスパッチを使用しており、参考にするのに適した例です。

Quarkus はエクステンションのパフォーマンスに独自の機会を提供しますが、エクステンション開発者は パフォーマンス最適化の基礎 を忘れてはなりません。

Quarkus のリアクティブコアは、その優れたスループットとスケーラビリティーに主に貢献します。エクステンションは、独自の内部操作にこのモデルを採用することを検討する必要があります。

スケーラビリティーを最大限に高めるには、Mutiny を使用して、リアクティブコアを超えて、完全なリアクティブプログラミングを有効にします。リアクティブプログラミングモデルをサポートするほとんどのプロジェクトでは、 -reactive とプレーンなエクステンションの 2 つの異なるエクステンションが提供されています。 たとえば、 ElasticSearch および ElasticSearch Reactive エクステンションを参照してください。

Quarkus は、ロギングエンジンとして JBoss Logging を使用し、複数のログ記録 API をサポートしています。(これは通常の Java ロギングであり、OpenTelemetry ログ記録ではありません。)

通常の動作に影響しない状況では、エラーや警告を使用しないでください。これらの出力は、ユーザー監視システムで誤報を引き起こす可能性があります。

エクステンションでは、そのエクステンションに固有のヘルス基準について ライブラリー固有のエンドポイントを定義 する必要がある場合があります。新しいエンドポイントを追加するには、エクステンションで NonApplicationRootPathBuildItem を生成する必要があります。

エクステンションを使用するアプリケーションの OpenTelemetry 出力に、適切に定義されたスパンが含まれているかどうかをテストする必要があります。スパンが適切なトレース ID で作成されるようにするには、追加の作業が必要になる場合があります。 たとえば、リアクティブな内部構造を持つエクステンションは、正しいコンテキスト伝播のために 重複したコンテキスト をサポートする必要があります。

Quarkus は Kubernetes ネイティブランタイムとして設計されています。 エクステンションは、Kubernetes とのライブラリー固有の統合ポイントを追加することで、この思想を確保できます。 Kubernetes ネイティブであることは、コンテナーネイティブであることを意味します。少なくとも、エクステンションは常にコンテナー内で適切に機能する必要がありますが、エクステンションにはコンテナースタックの下位レベルと統合する機会もあります。