新しい IBM Developer JP サイトへようこそ!サイトのデザインが一新され、旧 developerWorks のコンテンツも統合されました。 詳細はこちら

Codewind をインストールして Eclipse と VS Code で操作する

Eclipse Codewind は、開発者がお気に入りの IDE 内で簡単にクラウド・ネイティブ・アプリケーションを作成できるようにするための新しいオープンソース・プロジェクトです。現時点で、Codewind は Visual Studio Code、Eclipse IDE、Eclipse Che をサポートしています。

Codewind では、テンプレートからアプリケーションを作成できるだけでなく、デスクトップ上の Docker コンテナー内でアプリケーションを起動、更新、テスト、デバッグするためのサポートも揃えています。これらの機能は Kubernetes 上でも使用できます。Codewind を使用すると、既存のアプリケーションを Docker と Kubernetes に移行できます。Codewind は、確実にベスト・プラクティスに従ったアプリケーションを作成するための手段になります。

このチュートリアルでは、Eclipse と VS Code IDE を使用する場合の両方で、Codewind を使ってクラウド・ネイティブの Java アプリケーションを開発する方法を説明します。

Eclipse IDE で Codewind を操作する

このセクションでは、Codewind を Eclipse IDE にインストールし、Eclipse IDE 上の Codewind を使用して Java アプリケーションを作成する方法を説明します。

前提条件

  • 最新の Eclipse IDE for Java EE Developers をダウンロードしてインストールするか、既存のインストール済み環境を使用します。Codewind は Eclipse IDE バージョン 4.11.0 以降でサポートされています。
  • Docker をインストールします。

Codewind をインストールする

  1. Eclipse IDE を開き、「Help (ヘルプ)」 > 「Eclipse Marketplace」にナビゲートします。
  2. Codewind を検索します。
  3. Install (インストール)」をクリックします。
  4. ウィザードの手順を完了します。必要に応じて使用条件に同意します。 Eclipse での Codewind のインストール
  5. インストールが完了したら、Eclipse を再起動します。
  6. Eclipse で、「Window (ウィンドウ)」 > 「ビューの表示 (Show View)」 > 「Other… (その他)」 > 「Codewind」 > 「Codewind Explorer」にナビゲートします。 Codewind Explorer ビュー
  7. Codewind を使用するには、追加の Docker イメージをインストールして実行する必要があります。Codewind Explorer ビュー内の Codewind 項目をダブルクリックして、インストールを完了します。インストールが完了するまでに数分かかることがあります。 Codewind の起動
  8. Codewind により、ホーム・ディレクトリー内に codewind-workspace という名前のフォルダー (~/codewind-workspace on mac) が生成されます。作成する Codewind プロジェクトはここに格納されることになります。

この codewind-workspace には、さまざまなエディターからアクセスできます。codewind-workspace フォルダーには各種エディターとの互換性があるため、Codewind プロジェクトを Eclipse IDE 内で作成したとしても、Visual Studio Code の Codewind プラグインからそのプロジェクトにアクセスできます。

プロジェクト・テンプレート

Codewind には、プロジェクトを作成するために使用できる一連のテンプレートが用意されています。テンプレートには以下のタイプがあります。

  • 標準的な Codewind テンプレート
  • Kabanero Collections
  • Appsody スタック - appsodyhub

現在、Go、Lagom Java、Node.js Express、Open Liberty、Python、Sprint Boot、Swift、WebSphere Liberty MicroProfile、Loopback などのテンプレートを使用できるようになっています。

独自のテンプレートを作成して、それを使用してプロジェクトを作成することもできます。詳細については、Codewind のドキュメントを参照してください。

MicroProfile プロジェクトを作成して実行する

Codewind 内に用意されている WebSphere Liberty MicroProfile テンプレートを使ってプロジェクトを作成しましょう。

  1. Codewind Explorer ビューで、Codewind が実行中であることを確認します。実行中でない場合は、「Codewind」をクリックして起動します。
  2. Codewind が起動したら、Codewind 項目を展開して 「Local Projects (ローカル・プロジェクト)」を右クリックし、「New Project (新規プロジェクト)」をクリックします.
  3. プロジェクトの名前を入力し、テンプレートの中から「WebSphere Liberty MicroProfile」を選択します。「Finish (完了)」をクリックしてプロジェクトを作成します。 プロジェクトの作成
  4. クラウド・ネイティブ Java アプリケーションに必要なすべてのディレクトリーとファイルからなる、新しいプロジェクトが作成されます。必要なエントリーを含む Dockerfilepom.xml も作成されます。これらのファイルを必要に応じて編集できます。 プロジェクトの構造
  5. プロジェクトは自動的にビルド、デプロイ、起動されます。
  6. プロジェクトのコンテキスト・メニューを使用して、アプリケーションをブラウザー内で開いたり、アプリケーションとビルド・ログを表示したり、デバッグ・モードでアプリケーションを再起動したりするなど、さまざまな操作が可能です。Codewind のドキュメントに、コンテキスト・メニューの項目とそれぞれの機能のリストが記載されています。
  7. Codewind Explorer ビューで、上記のステップで作成したプロジェクトを右クリックし、「Open Application (アプリケーションを開く)」をクリックします。デフォルトの Eclipse ブラウザー内にアプリケーションが開きます。これで、アプリケーションを使い始めることができます。 変更前

アプリケーションに変更を加える

アプリケーションに変更を加えて、その変更をデプロイするのは簡単です。いかに簡単であるか、src/main/java/application/rest/v1 にある Example.java ファイルに変更を加えて確かめましょう。

ファイルの変更

  1. 表示されるメッセージを「Congratulations, your modified application is up and running!!!」に変更します。
  2. ファイルを保存します。
  3. 変更が自動的にビルドされてデプロイされるまでしばらく待ちます。
  4. ブラウザー上で REST API http://localhost:xxxx/v1/example を呼び出して、変更後のアプリケーションを確認します。ポート番号は、ブラウザーからリンクを使用してアプリケーションのホーム・ページにアクセスすると確認できます。

変更後のメッセージが表示されるはずです。このように、クラウド・ネイティブのアプリケーションに変更を加えて、すぐにその変更をテストすることができます。

変更後

さらに、アプリケーションを変更してビジネス・ロジックを追加することもできます。ビジネス・ロジックを追加すると、ビジネス・ロジックに必要なものだけに専念して作業を進めることができます。アプリケーションをビルドする際の環境に関する他の問題を考える必要はありません。

トラブルシューティング

Visual Studio Code 上で Codewind を操作する

前提条件

Visual Studio Code 用の Codewind をインストールする

  1. VS Code IDE を起動します。
  2. メニュー・バーで、「View (表示)」の下にある「Extensions (拡張機能)」をクリックします。
  3. 検索フィールドに「Codewind」と入力し、Enter キーを押します。
  4. Codewind エントリーに対応する「Install (インストール)」をクリックして Codewind をインストールします。
  5. Codewind を使用するには、追加の Docker イメージをインストールして実行する必要があります。インストールを完了するよう求められたら、「Install (インストール)」を選択します。インストールが完了するまでに数分かかることがあります。 VSCode での Codewind のインストール

    これで、Codewind がインストール済みになります。

  6. Codewind により、ホーム・ディレクトリー内に codewind-workspace という名前のフォルダー (~/codewind-workspace on mac) が生成されます。作成する Codewind プロジェクトはここに格納されることになります。

この codewind-workspace には、さまざまなエディターからアクセスできます。codewind-workspace フォルダーには各種エディターとの互換性があるため、Codewind プロジェクトを Eclipse IDE 内で作成したとしても、Visual Studio Code の Codewind プラグインからそのプロジェクトにアクセスできます。

Codewind 内のプロジェクト・テンプレート

Codewind には、プロジェクトを作成するために使用できる一連のテンプレートが用意されています。テンプレートには以下のタイプがあります。

  • 標準的な Codewind テンプレート
  • Kabanero Collections
  • Appsody スタック - appsodyhub

現在使用できるテンプレートの中には、Go、Lagom Java、Node.js Express、Open Liberty、Python、Sprint Boot、Swift、WebSphere Liberty MicroProfile、Loopback などに対応するものがあります。

独自のテンプレートを作成して、それを使用してプロジェクトを作成することもできます。詳細については、Codewind のドキュメントを参照してください。

Java プロジェクトを作成して実行する

  1. VSCode IDE を起動します。
  2. Explorer ビューで、「Codewind」、「Projects (プロジェクト)」の順に展開します。
  3. Projects (プロジェクト)」を右クリックし、「Create New Project (新規プロジェクトの作成)」を選択します。
  4. プロジェクトを作成するために使用するテンプレートを選択します。このチュートリアルでは、「標準的な Codewind テンプレート」を選択します。
  5. テンプレートを選択します。ここでは「WebSphere Liberty MicroProfile」エントリーを選択してください。
  6. プロジェクトの名前を入力し、Enter キーを押します。新しい Java MicroProfile プロジェクトが作成され、Codewind ワークスペース内で表示できるようになります。
  7. 数分後にビルドとデプロイが完了すると、プロジェクトが実行中の状態になります。実行中の状態になったら、Codewind ビュー内で Python プロジェクトを右クリックし、「Open App (アプリを開く)」をクリックします。 VSCode でのプロジェクトの作成

Codewind ビュー内のアプリケーションのコンテキスト・メニューには、アプリを開く以外にも多数のオプションがあります。詳細については、Codewind のドキュメントを参照してください。

アプリケーションに変更を加える

アプリケーションに変更を加えて、その変更をデプロイするのは簡単です。src/main/java/application/rest/v1 にある Example.java ファイルを変更しましょう。 ファイルの変更

変更を行う前に、curl http://127.0.0.1:xxxx/v1/example を実行してレスポンスを確認してください (ポート番号は、コンテキスト・メニューからアプリを開いた後、ブラウザーからリンクを使用してアプリケーションのホーム・ページにアクセスすると確認できます)。上の図には、VS Code エディターのターミナル・ビュー内に表示された出力が示されています。

表示されるメッセージを「Congratulations, your modified application is up and running!!!」に変更してからファイルを保存します。変更が自動的にビルドされてデプロイされるまでしばらく待ちます。それが完了したら、curl http://127.0.0.1:xxxx/v1/example を実行してレスポンスを確認します。変更後のメッセージが表示されるはずです。このように、クラウド・ネイティブのアプリケーションに変更を加えて、すぐにその変更をテストすることができます。以下の GIF 画像には、VS Code エディターのターミナル・セクション内に反映された変更が示されています。

変更後

さらに、このアプリケーションを変更してビジネス・ロジックを追加することもできます。ビジネス・ロジックを追加すると、ビジネス・ロジックに必要なものだけに専念して作業を進められるようになります。クラウド・ネイティブのアプリケーションをビルドする際の環境に関する他の問題を考える必要はありません。

Codewind のトラブルシューティング・ガイド

Codewind のトラブルシューティングに関するガイドラインについては、このリンク先のページを参照してください。