Eclipse Java アプリケーション開発用の Service Fabric プラグイン

[アーティクル]
06/01/2023

Eclipse は、Java 開発者の間で最も広く使用されている統合開発環境 (IDE) の 1 つです。この記事では、Eclipse 開発環境をセットアップして Azure Service Fabric を操作する方法について説明します。 Service Fabric プラグインのインストール、Service Fabric アプリケーションの作成、ローカルまたはリモートの Service Fabric クラスターへの Service Fabric アプリケーションのデプロイを Eclipse で行う方法を確認します。

Note

Eclipse プラグインは、現在、Windows でサポートされていません。

重要

JDK 8 がシステムにインストールされ、Eclipse で選択されていることを確認してください。

Eclipse で Service Fabric プラグインをインストールまたは更新する

Service Fabric プラグインを Eclipse にインストールすることができます。このプラグインを使用すると、Java サービスのビルドとデプロイの手順を簡素化できます。

重要

Service Fabric プラグインには、Eclipse Neon またはそれ以降のバージョンが必要です。 Eclipse のバージョンを確認する方法については、この注の後の手順を参照してください。以前のバージョンの Eclipse がインストールされている場合は、より新しいバージョンを Eclipse サイトからダウンロードすることができます。 Eclipse の既存のインストールの上にインストールする (上書きする) ことはお勧めしません。インストーラーを実行する前に削除するか、新しいバージョンを別のディレクトリにインストールすることができます。

Ubuntu では、パッケージインストーラー (apt または apt-get) を使用するのではなく、Eclipse サイトから直接インストールすることをお勧めします。そうすることで、Eclipse の最新バージョンを確実に入手することができます。

Eclipse サイトから Eclipse Neon またはそれ以降をインストールします。さらに、Buildship のバージョン 2.2.1 以降をインストールします (Service Fabric プラグインは旧バージョンの Buildship と互換性がありません)。

インストールされているコンポーネントのバージョンを確認するには、Eclipse で [Help]\(ヘルプ\)>[About Eclipse]\(Eclipse について\)>[Installation Details]\(インストールの詳細\) の順に移動します。
Buildship は、Eclipse Buildship: Gradle 用の Eclipse プラグインに関するページの手順に従って更新できます。
Eclipse の更新プログラムを確認してインストールするには、 [Help]\(ヘルプ\)>[Check for Updates]\(更新プログラムの確認\) の順に移動します。

Service Fabric プラグインをインストールするために、Eclipse で [Help]\(ヘルプ\)>[Install New Software]\(新しいソフトウェアのインストール\) の順に移動します。

[Work with]\(作業対象\) ボックスに「 https://servicefabricdownloads.blob.core.windows.net/eclipse/ 」と入力します。
[追加] をクリックします。
Service Fabric プラグインを選択して [Next (次へ)] をクリックします。
インストール手順を完了し、マイクロソフトソフトウェアライセンス条項に同意します。

Service Fabric プラグインが既にインストールされている場合は、最新バージョンをインストールしてください。

使用できる更新プログラムを確認するには、 [Help]\(ヘルプ\)>[About Eclipse]\(Eclipse について\)>[Installation Details]\(インストールの詳細\) の順に移動します。
インストールされているプラグインの一覧で Service Fabric を選択して、 [Update (更新)] をクリックします。使用できる更新プログラムがインストールされます。
Service Fabric プラグインを更新したら、Gradle プロジェクトも更新します。 build.gradle を右クリックし、 [Refresh](最新の情報に更新) を選択します。

Note

Service Fabric プラグインのインストールまたは更新に時間がかかる場合、Eclipse の設定が原因である可能性があります。 Eclipse は、Eclipse インスタンスに登録されている更新サイトに対するすべての変更のメタデータを収集します。 Service Fabric プラグインの更新プログラムを確認してインストールする手順を高速化するには、 [Available Software Sites (利用できるソフトウェアサイト)] に移動します。 Service Fabric プラグインの場所 ('https://servicefabricdownloads.blob.core.windows.net/eclipse/ ') を指すサイトを除き、すべてのサイトのチェックボックスをオフにします。

Note

Eclipse が Mac で意図したように動かない場合、またはスーパーユーザーとして実行する必要がある場合は、ECLIPSE_INSTALLATION_PATH フォルダーの Eclipse.app/Contents/MacOS サブフォルダーに移動します。 ./eclipse を実行して Eclipse を起動します。

Eclipse での Service Fabric アプリケーションの作成

Eclipse で、 [File]\(ファイル\)>[New]\(新規\)>[Other]\(その他\) の順に移動します。 [Service Fabric Project](Service Fabric プロジェクト) を選択して、[Next](次へ) をクリックします。
プロジェクトの名前を入力し、 [Next (次へ)] をクリックします。
テンプレートの一覧で [サービステンプレート] を選択します。サービステンプレートの種類 (アクター、ステートレス、コンテナー、またはゲストバイナリ) を選択して、 [Next (次へ)] をクリックします。
サービス名とサービスの詳細を入力して、 [Finish (完了)] をクリックします。
Service Fabric プロジェクトを初めて作成する場合、 [Open Associated Perspective (関連付けられている観点を開く)] ダイアログボックスで [Yes (はい)] をクリックします。
新しいプロジェクトは次のようになります。

Eclipse での Service Fabric アプリケーションの構築

新しい Service Fabric アプリケーションを右クリックして、 [Service Fabric] を選択します。
コンテキストメニューで、次のいずれかを選択します。
- クリーニングなしでアプリケーションをビルドするには、 [Build Application (アプリケーションのビルド)] をクリックします。
- アプリケーションのクリーンビルドを実行するには、 [Rebuild Application (アプリケーションのリビルド)] をクリックします。
- ビルドアーティファクトのアプリケーションをクリーンするには、 [Clean Application (アプリケーションのクリーン)] をクリックします。

Eclipse を使用してローカルクラスターに Service Fabric アプリケーションをデプロイする

Service Fabric アプリケーションを構築したら、以下の手順に従ってローカルクラスターにデプロイします。

ローカルクラスターを起動していない場合は、ローカルクラスターのセットアップに関する記事の説明に従ってローカルクラスターを起動し、実行されていることを確認します。
Service Fabric アプリケーションを右クリックして、 [Service Fabric] を選択します。
コンテキストメニューから [アプリケーションの展開] をクリックします。
デプロイ操作の進捗状況は、コンソールウィンドウから確認できます。
アプリケーションが実行されていることを確認するには、ブラウザーのウィンドウでローカルクラスターの Service Fabric Explorer を開きます http://localhost:19080/Explorer。 Applications ノードを展開し、アプリケーションが実行されていることを確認します。

ローカルクラスターを使用する Eclipse でアプリケーションをデバッグする方法については、Eclipse での Java サービスのデバッグに関する記事を参照してください。

[Publish Application]\(アプリケーションの発行) コマンドを使用してローカルクラスターにアプリケーションをデプロイすることもできます。

Service Fabric アプリケーションを右クリックして、 [Service Fabric] を選択します。
コンテキストメニューから [Publish Application...]\(アプリケーションの発行) をクリックします。
[Publish Application]\(アプリケーションの発行) ウィンドウで、ターゲットプロファイルとして PublishProfiles/Local.json を選択し、 [発行] をクリックします。

既定では、Local.json 発行プロファイルはローカルクラスターに発行するために設定されています。発行プロファイルにある接続およびエンドポイントパラメーターの詳細については、次のセクションを参照してください。

Eclipse を使用して Azure に Service Fabric アプリケーションを発行する

アプリケーションをクラウドに発行するには、次の手順を実行します。

クラウド内のセキュリティで保護されたクラスターにアプリケーションを発行するには、X.509 証明書を使用してクラスターと通信する必要があります。テストおよび開発環境では、多くの場合、クラスター証明書が使用されます。運用環境ではクラスター証明書とは異なるクライアント証明書である必要があります。証明書と秘密キーの両方が必要です。証明書 (およびキー) ファイルは、PEM 形式である必要があります。 PFX ファイルからの証明書と秘密キーを含む PEM ファイルは、次の openssl コマンドを使用して作成できます。
```
openssl pkcs12 -in your-cert-file.pfx -out your-cert-file.pem -nodes -passin pass:your-pfx-password
```
PFX ファイルがパスワードで保護されていない場合は、最後のパラメーターとして --passin pass: を使用します。
PublishProfiles ディレクトリにある Cloud.jsonファイルを開きます。クラスターに適切なクラスターエンドポイントとセキュリティ資格情報を構成する必要があります。
- ConnectionIPOrURL フィールドには、クラスターの IP アドレスまたは URL が含まれています。値には URL スキームにが含まれていないことに注意してください (https://)。
- 既定では、このポートをクラスター用に明示的に変更した場合を除き、ConnectionPort フィールドは 19080 である必要があります。
- ClientKey フィールドは、クライアントまたはクラスター証明書のための秘密キーを含む、ローカルコンピューター上の PEM 形式の .pem または .key ファイルを指す必要があります。
- ClientCert フィールドは、クライアントまたはクラスター証明書のための証明書データを含む、ローカルコンピューター上の PEM 形式の .pem または .crt ファイルを指す必要があります。
```
{
    "ClusterConnectionParameters":
    {
       "ConnectionIPOrURL": "lnxxug0tlqm5.westus.cloudapp.azure.com",
       "ConnectionPort": "19080",
       "ClientKey": "[path_to_your_pem_file_on_local_machine]",
       "ClientCert": "[path_to_your_pem_file_on_local_machine]"
    }
}
```
Service Fabric アプリケーションを右クリックして、 [Service Fabric] を選択します。
コンテキストメニューから [Publish Application...]\(アプリケーションの発行) をクリックします。
[Publish Application]\(アプリケーションの発行) ウィンドウで、ターゲットプロファイルとして PublishProfiles/Cloud.json を選択し、 [発行] をクリックします。
発行操作の進捗状況は、コンソールウィンドウから確認できます。
アプリケーションが実行されていることを確認するには、ブラウザーのウィンドウで Azure クラスターの Service Fabric Explorer を開きます。上記の例では、これは https://lnxxug0tlqm5.westus.cloudapp.azure.com:19080/Explorer のようになります。 Applications ノードを展開し、アプリケーションが実行されていることを確認します。

セキュリティで保護された Linux クラスターの場合、アプリケーションに Reliable Services サービスが含まれている場合は、Service Fabric runtime API を呼び出すためにサービスが使用できる証明書を構成する必要もあります。詳しくは、「Reliable Services アプリを Linux クラスター上で実行するように構成する」をご覧ください。

セキュリティで保護された Linux クラスターに Java で記述された Service Fabric Reliable Services アプリケーションをデプロイする方法については、「クイックスタート: Service Fabric に Java Reliable Services アプリケーションをデプロイする」を参照してください。

Eclipse 実行構成を使用して Service Fabric アプリケーションをデプロイする

Eclipse 実行構成を使用して Service Fabric アプリケーションをデプロイするという方法もあります。

Eclipse で、 [Run (実行)]>[Run Configurations (構成の実行)] の順に移動します。
[Gradle Project (Gradle プロジェクト)] で [ServiceFabricDeployer] 実行構成を選択します。
右側のウィンドウの [引数] タブで、 [ip] 、 [port] 、 [clientCert] 、および [clientKey] パラメーターがデプロイに適切に設定されていることを確認します。既定では、パラメーターは、次のスクリーンショットのように、ローカルクラスターにデプロイするよう設定されています。アプリを Azure に発行するには、Azure クラスターのエンドポイントの詳細とセキュリティ資格情報を含めるようパラメーターを変更することができます。詳細については、前のセクションの「Eclipse を使用して Azure Service Fabric アプリケーションを発行する」を参照してください。
[作業ディレクトリ] が、デプロイするアプリケーションを指していることを確認します。アプリケーションを変更するには、 [Workspace (ワークスペース)] ボタンをクリックし、目的のアプリケーションを選択します。
[Apply (適用)] をクリックし、 [Run (実行)] をクリックします。

すぐにアプリケーションのビルドとデプロイが行われます。 Service Fabric Explorer でデプロイの状態を監視できます。

Service Fabric アプリケーションへの Service Fabric サービスの追加

既存の Service Fabric アプリケーションに Service Fabric サービスを追加するには、次の手順を実行します。

サービスの追加先となるプロジェクトを右クリックし、 [Service Fabric] をクリックします。
[Add Service Fabric Service (Service Fabric サービスの追加)] をクリックし、一連の手順を完了してサービスをプロジェクトに追加します。
プロジェクトに追加するサービステンプレートを選択して、 [Next (次へ)] をクリックします。
(必要に応じて他の詳細と共に) サービス名を入力し、 [Add Service (サービスの追加)] ボタンをクリックします。
サービスの追加後、プロジェクト全体の構造は次のようになります。

Service Fabric Java アプリケーションのマニフェストバージョンの編集

マニフェストバージョンを編集するには、プロジェクトを右クリックし、 [Service Fabric] に移動して、メニューのドロップダウンから [マニフェストバージョンの編集] を選択します。ウィザードで、アプリケーションマニフェストとサービスマニフェストのバージョン、さらに Code、Config、Data パッケージのバージョンを更新することができます。

[アプリケーションとサービスのバージョンを自動的に更新する] チェックボックスをオンにし、バージョンを更新すると、マニフェストのバージョンが自動的に更新されます。たとえば、最初にこのチェックボックスをオンにしたうえで、Code のバージョンを 0.0.0 から 0.0.1 に更新し、 [完了] をクリックすると、サービスマニフェストのバージョンとアプリケーションマニフェストのバージョンが自動的に 0.0.1 に更新されます。

Service Fabric Java アプリケーションのアップグレード

アップグレードシナリオの一例を挙げます。たとえば、Eclipse で Service Fabric プラグインを使用して App1 プロジェクトを作成したとします。また、そのプラグインを使用してプロジェクトをデプロイし、fabric:/App1Application というアプリケーションを作成してあります。アプリケーションの種類は App1AppicationType、アプリケーションのバージョンは 1.0 です。この場合に、可用性を維持しつつアプリケーションをアップグレードする必要が生じたとしましょう。

最初にアプリケーションに変更を加え、変更されたサービスをリビルドします。変更されたサービスのマニフェストファイル (ServiceManifest.xml) を、サービスの更新されたバージョン (と関連する Code、Config、Data) で更新します。さらに、アプリケーションのマニフェスト (ApplicationManifest.xml) を、アプリケーションの更新されたバージョン番号と変更されたサービスで変更します。

Eclipse を使用してアプリケーションをアップグレードするには、実行構成プロファイルの複製を作成します。次に、この構成を使用して、必要に応じてアプリケーションをアップグレードします。

[Run (実行)]>[Run Configurations (構成の実行)] の順に移動します。左側のウィンドウにある [Gradle Project (Gradle プロジェクト)] の左側の小さな矢印をクリックします。
[ServiceFabricDeployer] を右クリックし、 [Duplicate (複製)] を選択します。この構成に新しい名前を付けます (ServiceFabricUpgrader など)。
右側のパネルの [Arguments (引数)] タブで、 -Pconfig='deploy' を -Pconfig='upgrade' に変更し、 [Apply (適用)] をクリックします。

この手順を行うと、いつでもアプリケーションのアップグレードに使用できる実行構成プロファイルが作成されて保存されます。これを使用すると、アプリケーションマニフェストファイルから、アプリケーションの種類の更新後の最新バージョンも取得されます。

アプリケーションのアップグレードには数分かかります。アプリケーションのアップグレードは Service Fabric Explorer で監視できます。

以前の Service Fabric Java アプリケーションを移行して Maven で使用する

最近、Service Fabric Java ライブラリが Service Fabric Java SDK から Maven リポジトリに移行されました。 Eclipse を使って生成する新しいアプリケーションでは、(Maven で使用可能な) 最新のプロジェクトが生成されますが、(これまで Service Fabric Java SDK を使っていた) 既存の Service Fabric のステートレスまたはアクター Java アプリケーションは、Maven からの Service Fabric Java 依存関係を使うように更新することができます。以前のアプリケーションを Maven で使用するには、こちらに記載した手順に従ってください。

次のステップ

Java Reliable サービスアプリケーションを構築し、それをローカルおよび Azure にデプロイする手順の概要については、「クイックスタート: Service Fabric に Java Reliable Services アプリケーションをデプロイする」を参照してください。
ローカルクラスター上の Java アプリケーションをデバッグする方法については、Eclipse での Java サービスのデバッグに関する記事を参照してください。
Service Fabric アプリケーションを監視し診断する方法については、「ローカルコンピューターの開発のセットアップでのサービスの監視と診断」を参照してください。

Eclipse Java アプリケーション開発用の Service Fabric プラグイン

Eclipse で Service Fabric プラグインをインストールまたは更新する

Eclipse での Service Fabric アプリケーションの作成

Eclipse での Service Fabric アプリケーションの構築

Eclipse を使用してローカル クラスターに Service Fabric アプリケーションをデプロイする

Eclipse を使用して Azure に Service Fabric アプリケーションを発行する

Eclipse 実行構成を使用して Service Fabric アプリケーションをデプロイする

Service Fabric アプリケーションへの Service Fabric サービスの追加

Service Fabric Java アプリケーションのマニフェスト バージョンの編集

Service Fabric Java アプリケーションのアップグレード

以前の Service Fabric Java アプリケーションを移行して Maven で使用する

次のステップ

その他のリソース

Eclipse を使用してローカルクラスターに Service Fabric アプリケーションをデプロイする

Service Fabric Java アプリケーションのマニフェストバージョンの編集