原文: Migrating from Camel Karaf to Camel Spring Boot or Quarkus By Claus lbsen(@davsclaus) Dec 9, 2024
この記事は、Camel 4 への移行支援に関するブログシリーズ第２段です。
第１段の記事は、移行に関する一般原則に注目して書かれています。
今回の記事は、Apache Karaf OSGi Blueprint から Camel 4 への移行に注目しています。
移行作業
Camel Karaf および OSGi Blueprint から Camel 4 への移行は、些細な移行作業ではありません。
移行は、以下の主要な作業から構成されます:
- Camel 2.x/3.x から Camel 4.x へのアップグレード
- Java 17 か 21 へのアップグレード
- Kafka(OSGi) と Spring Boot、Quarkus、Standalone Camel などへの置き換え
- あたなの Camel インテグレーションの移行
はじめはこれらの作業量を膨大に感じるかもしれませんが、慌てないでください。
Camel Karaf から Camel 4 への移行
came-karaf ベースの Camel インテグレーションを移行するには、以下の移行が必要です:
- Javaコードを、Camel 3.x/3.x から Camel 4.x へ
- OSGi Blueprint XML ファイルを、Camel 4 XML/YAML DSL へ
移行作業を支援する為、camel-jbang にサポート機能を組み込みました。
camel-kafka の例を使い、どのような作業が必要かご紹介します。
最初の例題を移行
最初に、例題 camel-example-sql-blueprint がどういったものか確認します。この例題は、カスタム Java ソースと OSGi blueprint XML に Camel ルートが記述されています。
どれほど状況が悪いか簡単に確認する為、camel-jbang を使い例題を実行し、実行結果を確認します:
cd examples/camel-example-sql-blueprint
camel run pom.xmlcamel-jbang は pom.xml を使い、既存 Mavenプロジェクトにて Camel がベストエフォートで実行するようなっています。この方法は、Mavenや Camelの実行方法の代替にはなりません。しかし、移行作業においては有用です。
例題を実行した際、何もエラーが出力されず動作することに気がつくでしょう。
何が起きたかというと、camel-jbang が OSGi blueprint XML ファイルを読み込むことができ、<bean> や <camelContext> を解析し、モダンな Camel 4 上で実行しています。これは、例題の移行作業が最小限であることを意味します。
Blueprint XML ファイルの移行
OSGi Blueprint XML ファイルを、XML か YAML DSL へ移行する必要があります。以下のように camel-jbang の transform コマンドで実施可能です:
camel transform route pom.xmlUI Designer
YAML DSL は、以下のスクリーンショットにある Apache Camel Karavan や Kaoto といった Camel designer で編集可能です。
XML へダンプ
この例題の移行には XMLを使うので、以下のように --format=xml を指定します:
camel transform route pom.xml --format=xmlダンプをファイルへ書き出す
コンソールへプリントするのではなく、camel transform route コマンドを使いファイルやディレクトリーへ書き出すこともできます。
camel transform route pom.xml --format=xml --output=codeこのコマンドで、code ディレクトリー配下に移行されたファイルが出力されます。
camel transform route --help を使い、このコマンドの詳細についてご確認ください。
次の移行作業は、生成されたファイルをご利用予定の runtime (Spring Boot、Quarkus、Camel Main など)へ出力します。
重要: 出力機能は、１回で移行および変換作業をサポートしません。つまり、変換された OSGi Blueprint ファイルを、適切なディレクトリーへ手動でコピーする必要があります。
Spring Boot へのエクスポート
以下のように、Spring Boot へエクスポートできます:
Quarkus へのエクスポートはこのようになります:
移行の完了
エクスポート機能は Camel Karafベースのプロジェクトをフルサポートしていませんので、エクスポート終了後、プロジェクトを少し掃除する必要があります。
cd code変換したルート(前回の作業)を、src/main/resources/camel ディレクトリー配下へコピーし、古い OSGi blueprint ファイルを削除する必要があるでしょう。
PS: 変換作業を忘れた場合、変換をやり直して以下のようなフォルダーへ直接出力できます:
また、karaf feature.xml ファイルも削除すべきです。
その他、エクスポート ツールは application.properties で定義されている値のみをサポートするため、sql.properties から値をコピーする必要があります。つまり、値を sql.properties から code/src/main/resources/application.properties にコピーします。
Spring Boot で実行する場合は、 Web サーバーを使用するのがベスト プラクティスであるため、次のように pom.xml に依存関係を追加する必要があります:
前述した作業後、プロジェクトをコンパイルし Spring Boot を実行できます:
アプリケーションは Spring Boot 上で実行し、無事に移行できました。
それでは、次にもう少し複雑で追加作業が必要な例題を移行します。
より困難な移行
今回は、camel-example-openapi-osgi example を移行します。DSLの修正も必要になります。
まずはこちらを実行しましょう:
実行すると、次のようなエラーが表示されます。
Camel 4 への移行には DSL の変更が必要になる可能性があるため、これは予想されます。この例では、apiContextListing が削除されているため、src/main/resources/OSGI-INF/blueprint/camel.xml ファイル内の行を手動で修正する必要があります:
次に、camel run pom.xml を使用して再度実行してみます。
次のエラーは、description に関するものです:
<description> は属性に移行する必要があります。したがって、src/main/resources/OSGI-INF/blueprint/camel.xml 内のすべての <description> に対して修正を行う必要があります。この後、再度実行すると、別のエラーが発生します。
GET、PUT、POST などのすべての REST 動詞については、次に示すように uri 属性の名前を path に変更する必要があります:
もうすぐそこまで来ましたが、最後のエラーが 1 つあります。
Rest DSL では、インライン化された <route> はサポートされなくなり、これらのインライン化されたルートを別のルートに移動し、direct エンドポイント経由で呼び出す必要があります。
修正前:
修正後:
ついにアプリケーションが Camel 4 で実行できるようになりました。
Camel Quarkus への移行
この例題では、Spring Boot ではなく Camel Quarkus に移行します。
異なるエラーが出力されます:
これは、古い Karaf の例が、Rest DSL サービスをホストするための HTTP サーバーとして Jetty を使用しているからです。これを削除し、Quarkus (または Spring Boot) に付属するデフォルトの platform-http を Camel で使用できるようにする必要があります。
したがって、次のように XML ファイルを修正します:
重要: Rest DSL を使用する場合、Camel JBang がルートを変換できるようにルートを分離する必要があるため、inlineRoutes="false" を設定する必要があります。この問題は、Camel 4.10 以降では自動的に修正される可能性があります。
export を再度実行します。
次に、Blueprint XML ファイルを移行し、以下のように src/main/resources/camel ディレクトリーへ直接出力します:
次に、Camel 4 on Quarkus へ完全に移行するため、プロジェクトを掃除する必要があります。
pom.xml で、camel-jetty と Camel-spring の依存関係を削除します。
また、src/main/resources/camel.xml ファイルに <restConfiguration> を追加する必要があります。これらは、camel transform route コマンドに自動で含まれないためです。
よって、ファイル先頭の <camel> ルート タグ配下に、これを追加します:
この作業後、次のように移行したサンプルをコンパイルし、 Camel Quarkus で実行できるようになります:
そして、次のような Rest サービスを呼び出すことができるはずです:
ふー、これは少し大変でした。
まとめ
Camel JBang ツールは、OSGi Blueprint XML ファイルを最新の Camel へ移行するのに役立つツールです。特殊な OSGi 機能を使用するより複雑な OSGi アプリケーションを構築している場合は、手動で移行する必要があります。
Camel 4 では、従来の Apache Karaf よりもはるかに大きなコミュニティとユーザー ベースを持つ Spring Boot または Quarkus の最新スタック上で動作するので、将来のアップグレードは、はるかに簡単になります。
Rest DSL から YAML DSL への変換はまだサポートされていないことに注意してください。たとえば、Rest を使用して移行した最後の例では、YAML DSL の REST 要素を自動生成することはできません。これは将来的に実装される予定です。
詳細については、Camel 3.x/4.x の移行およびアップグレード ガイドを参照してください。移行に関するほとんどの問題は、ガイド (上記) に記載されています。
Camel JBang ツールは、このブログ投稿に示されているように、既存プロジェクトの移行をすぐ試すのに役立ちます。
移行ツールに関するフィードバックは大歓迎です。頑張ってください。モダンな Camel 4 の世界で会いましょう。
