CodeReady Studio ツールのスタートガイド
Red Hat CodeReady Studio ツールの使用方法
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、弊社 の CTO、Chris Wright のメッセージ を参照してください。
第1章 CodeReady Studio の Git の基本
CodeReady Studio には、開発者がグラフィカルインターフェイスから Git リポジトリーを管理できる Git Perspective が含まれています。ここでは、Git Perspective における Git プロジェクトの基本ワークフローの概要と、最も一般的な Git 関連のタスクを実行する方法を説明します。
1.1. Git Perspective の設定
CodeReady Studio で Git Perspective を開く方法を説明します。
手順
- CodeReady Studio を起動します。
Open Perspective ウィンドウが表示されます。
- Git を選択します。
Git Repositories ビューが表示されます。
1.2. Git Perspective でのリポジトリーの管理
1.2.1. 新規 Git リポジトリーの作成
Git Perspective を使用して新規 Git リポジトリーを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Create a new Git Repository and add it to this view アイコンをクリックします。
Create a Git Repository ウィンドウが表示されます。
デフォルトの Repository ディレクトリー へのパスが自動的に生成されます。リポジトリーの保存先へのパスを選択し、リポジトリーの作成を続行します。
必要に応じて、Create as bare repository チェックボックスを選択します。
注記ベアリポジトリーは中央リポジトリーに推奨されますが、開発環境には推奨されません。ベアリポジトリーには、ソースファイルの作業用のコピーや、チェックアウトされたコピーが含まれません。そのため、ファイルの編集や変更のコミットができません。さらに、リポジトリーの Git リビジョンの履歴は、
.git
サブフォルダーではなく、root
フォルダーに保存されます。新しい Git リポジトリーがローカルマシンに作成され、Git Repositories ビューに表示されます。
1.2.2. 既存のローカル Git リポジトリーの追加
Git Perspective を使用して、ローカル Git リポジトリーを CodeReady Studio に追加する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Add an existing local Git Repository to this view アイコンをクリックします。
Add Git Repositories ウィンドウが表示されます。
-
Search results フィールドで、
.git
ファイルへのパスを表示するチェックボックスを選択します。 - をクリックします。
ローカルリポジトリーが Git Repositories ビューに表示されます。
1.2.3. 既存の Git リポジトリーのクローン作成
Git Perspective を使用して、オンラインにすでに存在するリポジトリー (GitHub、GitLab) のローカルクローンを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Clone a Git Repository and add the clone to this view アイコンをクリックします。
Clone Git Repository ウィンドウが表示されます。
ソースリポジトリーのアドレスを URI フィールドに追加します。
Host および Repository path フィールドが自動的に入力されます。
- をクリックします。
- クローンを作成するブランチを選択します。
- をクリックします。
Directory パスとInitial branch が正しく設定されていることを確認してください。
- をクリックします。
クローンしたリポジトリーが、CodeReady Studio の Git Repository ビューに表示されます。
1.2.4. リポジトリーのリモートの追加
Git Perspective にリポジトリーを設定したら、リポジトリーにリモートを追加します。これは、新たに作成または追加されたリポジトリーに 1 度だけ必要な設定ステップです。
Git Perspective を使用してリポジトリーにリモートを設定する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
リポジトリーを拡張します。
New Remote ウインドウが表示されます。
- リモートに名前を付けます。
- Configure push が選択されていることを確認します。
Configure Push ウィンドウが表示されます。
Select a URI ウィンドウが表示されます。
ソースリポジトリーの URI、ユーザー名、およびパスワードを追加します。
Host および Repository パスフィールドが自動的に入力されます。
- をクリックします。
- をクリックします。
新たに追加されたリモートが、CodeReady Studio の Git Repositories ビューに表示されます。
1.3. Git Perspective でのブランチの管理
1.3.1. 新規ブランチの作成
Git パースペクティブを使用して新規ブランチを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
- リポジトリーを拡張します。
Create Branch ウインドウが表示されます。
- をクリックして、新規ブランチのソースを選択します。
- ブランチに名前を付けます。
- Configure upstream for push and pull および Checkout new branch チェックボックスを選択します。
- When pulling フィールドでオプションを選択します。
- をクリックします。
新しく追加されたブランチは、CodeReady Studio の Git Repositories ビューに表示されます。
→ の下の1.3.2. ブランチの使用
Git Perspective で埋め込みのターミナルを開き、作成したブランチを使用する方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Shift+Ctrl+Alt+T キーを押します。
Launch Terminal ウインドウが表示されます。
- Local Terminal を選択します。
- Encoding を Default (ISO-8859-1) に設定します。
Terminal ウインドウにコマンドラインターミナルが表示されます。
デフォルトでは、現在の作業用ディレクトリーは、現在のユーザーのホームディレクトリーであることに注意してください。
1.3.3. ローカルリポジトリーの更新
マージの競合を回避するには、特に共有リポジトリーで作業している場合は、変更をマージする前にローカルリポジトリーを更新してください。
ローカルリポジトリーを更新するには、リモートリポジトリーから変更を取得し、それらをローカルリポジトリーにマージします。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Pull Results ウインドウが表示されます。
- をクリックします。
これで、リモートリポジトリーからの変更がローカルリポジトリーにマージされます。
1.4. 変更のコミットおよびプッシュ
CodeReady Studio で変更をコミットおよびプッシュする方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Git Staging ビューが表示されます。
- ステージする変更を選択します。
- Add selected files to the index アイコンをクリックし、変更をステージします。
Commit Message フィールドにコミットメッセージを追加します。
Author および Committer フィールドが自動的に入力されます。
- をクリックして変更をコミットするか、 をクリックして変更をコミットし、リモートリポジトリーにプッシュします。
Commit and Push オプションを選択すると、リポジトリーアドレスと、リポジトリーのアクセスユーザー名およびパスワードの入力を要求されることに注意してください。
第2章 CodeReady Studio における Maven の基本
Maven はアプリケーション開発の標準化されたビルドシステムを提供し、1 つ以上のリポジトリーから依存関係のフェッチを容易にします。
ルート Maven プロジェクトは、複数の Maven モジュール (サブプロジェクト) のアグリゲーターとして提供できます。Maven プロジェクトの一部である各モジュールには、<module> エントリーがプロジェクトの pom.xml
ファイルに追加されます。pom.xml
には <module> エントリーが含まれ、aggregator pom とも呼ばれます。
モジュールがプロジェクトに含まれる場合は、親プロジェクトディレクトリーから実行された 1 つコマンドにて、すべてのモジュールで Maven ゴールを実行できます。
2.1. 新規 Maven プロジェクトの作成
CodeReady Studio で新しい Maven プロジェクトを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Show View ウインドウが表示されます。
- 検索フィールドに Project Explorer と入力します。
- プロジェクトエクスプローラーを選択します。
プロジェクトエクスプローラービューが表示されます。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- Wizards フィールドに Maven と入力します。
- Maven Project を選択します。
New Maven Project ウインドウが表示されます。
Create a simple project チェックボックスを選択します。
注記Create a simple project チェックボックスを選択すると、archetype の選択が省略されます。また、プロジェクトタイプは、マルチモジュールの Maven プロジェクトに必要な POM (Project Object Model) に自動的に設定されます。
代わりにスタンドアロンの Maven プロジェクトを作成するには、Create a simple project チェックボックスを未選択にし、画面上の指示に従ってパッケージオプションを
jar
またはwar
に設定します。- をクリックしてワークスペースの場所を選択します。
グループ ID とアーティファクト ID を入力します。
注記ID の値には、スペースや特殊文字を使用できません。使用できる特別文字は、ピリオド (
.
)、アンダースコア (_
)、およびダッシュ (-
) のみです。一般的なグループ ID またはアーティファクト ID の例はorg.company-name_project-name
です。必要に応じて、プロジェクトに名前を付け、説明を追加できます。
- Packaging を pom、jar、または war に設定します。
- をクリックします。
新たに作成されたプロジェクトが Project Explorer ビューに表示されます。
2.2. 既存の Maven プロジェクトのインポート
既存の Maven プロジェクトを CodeReady Studio にインポートする方法を説明します。
2.2.1. ローカルに保存された既存の Maven プロジェクトのインポート
ローカルに保存された既存の Maven プロジェクトを CodeReady Studio にインポートする方法を説明します。
手順
- CodeReady Studio を起動します。
Import ウインドウが表示されます。
- Select an import wizard フィールドに Maven と入力します。
- Existing Maven Projects を選択します。
Import Maven Project ウインドウが表示されます。
- をクリックして、Maven プロジェクトを見つけます。
- プロジェクトをワーキングセットに追加 チェックボックスをオンにします。
- をクリックします。
ローカルの Maven プロジェクトが Project Explorer ビューに表示されます。
2.2.2. リモートで保存された 既存の Maven プロジェクトのインポート
リモートで保存された既存の Maven プロジェクトを CodeReady Studio にインポートする方法を説明します。
手順
- CodeReady Studio を起動します。
- Git Perspective を開きます。
Clone a Git repository and import existing Maven projects アイコンをクリックします。
Check out as Maven project from SCM ウィンドウが表示されます。
- ソースリポジトリーのアドレスを SCM URL フィールドに追加します。
Select Project Location ウインドウが表示されます。
- をクリックしてワークスペースの場所を選択します。
- をクリックします。
リモート Maven プロジェクトが Git リポジトリー ビューに表示されます。
2.3. 新しい Maven モジュールの作成
新しい Maven モジュールの作成方法を説明します。
前提条件
既存の Maven プロジェクト。
Maven プロジェクトの作成方法に関する詳細は、「新規 Maven プロジェクトの作成」 を参照してください。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- Wizards フィールドに Maven と入力します。
- Maven Module を選択します。
New Maven Module ウインドウが表示されます。
Create a simple project チェックボックスを選択します。
注記Create a simple project チェックボックスを選択すると、archetype の選択が省略されます。また、プロジェクトタイプは、マルチモジュールの Maven プロジェクトに必要な POM (Project Object Model) に自動的に設定されます。
代わりにスタンドアロンの Maven プロジェクトを作成するには、Create a simple project チェックボックスを未選択にし、画面上の指示に従ってパッケージオプションを
jar
またはwar
に設定します。- モジュールに名前を付けます。
- をクリックして、親プロジェクトを選択します。
Configure Project ウインドウが表示されます。
Packaging を pom、jar、または war に設定します。
必要に応じて、モジュールに名前を付け、説明を追加できます。
- をクリックします。
新しく作成した Maven モジュールが Maven プロジェクトの下に表示されます。
2.4. Maven 依存関係の Maven プロジェクトへの追加
CodeReady Studio で Maven プロジェクトに Maven 依存関係を追加する方法を説明します。
前提条件
既存の Maven プロジェクト。
Maven プロジェクトの作成方法に関する詳細は、「新規 Maven プロジェクトの作成」 を参照してください。
手順
- CodeReady Studio を起動します。
- Project Explorer を開きます。
Maven の
→ → を右クリックします。Add Dependency ウインドウが表示されます。
Enter groupId, artifactId or sha1 prefix or pattern フィールドに、グループ ID またはアーティファクト ID を入力します。
上記のフィールドは自動的に入力されます。
- をクリックします。
依存関係がプロジェクトの pom.xml
ファイルに追加されます。
2.5. Maven サポートを Maven 以外の既存プロジェクトへ追加
Maven サポートを使用せずに作成されたアプリケーションに Maven サポートを追加する方法を説明します。
- CodeReady Studio を起動します。
- Project Explorer を開きます。
Create a new POM ウインドウが表示されます。
すべてのフィールドは自動的に入力されます。グループ ID またはアーティファクト ID を変更する場合は、値にスペースまたは特殊文字を使用できません。使用できる特別文字は、ピリオド (
.
)、アンダースコア (_
)、およびダッシュ (-
) のみです。一般的なグループ ID またはアーティファクト ID の例は org.company-name_project-name です。新たに生成された
pom.xml
ファイルが Java プロジェクトに表示されます。
2.6. 関連情報
- Maven ソフトウェアプロジェクト管理および理解ツールの使用方法の詳細は、JBoss Community Archive を参照してください。
第3章 CodeReady Studio でのアプリケーションデプロイメント
CodeReady Studio 内からサーバーにアプリケーションをデプロイするには、サーバーに関する情報で IDE を設定する必要があります。ローカルサーバーの場合、この情報には以下が含まれます。
- サーバーランタイム環境 (サーバーの場所、ランタイム JRE、設定ファイルの詳細など)
- サーバーアダプターとサーバーランタイム環境の管理設定 (アクセスパラメーター、起動引数、パブリッシュオプションなど)
JBoss Server Tools を使用すると、Runtime Detection (ランタイム検出) を使用して、ローカルサーバーを効率的に設定し、 CodeReady Studio と使用できるようにすることができます。この機能は、アプリケーションのデプロイとテストを行うサーバーを迅速に設定するのに役立ちます。
3.1. ローカルサーバーの設定
Runtime Detection (ランタイム検出) は、指定のローカルシステムパスを検索し、特定タイプのランタイムサーバーを見つけます。Runtime Detection は、見つかったサーバーに対してデフォルトのサーバーランタイム環境とデフォルトのサーバーアダプターの両方を自動的に生成します。これらは、アプリケーションを即座にデプロイするためにそのまま使用したり、要件に合わせてカスタマイズしたりできます。
CodeReady Studio でローカルサーバーを設定する方法を説明します。
手順
- CodeReady Studio を起動します。
Preferences ウィンドウが表示されます。
- 検索フィールドに JBoss と入力します。
- JBoss Runtime Detection を選択します。
- をクリックします。
- ランタイムサーバーが含まれるディレクトリーを見つけます。
Searching for runtimes ウィンドウが表示されます。
- をクリックします。
ランタイムサーバーディレクトリーへのパスを選択します。
- をクリックします。
3.2. リモートサーバーの設定
CodeReady Studio でリモートサーバーを設定する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Server と入力します。
- Server を選択します。
Define a New Server ウィンドウが表示されます。
- サーバータイプを選択します。
Create a new Server Adapter ウィンドウが表示されます。
- Remote チェックボックスを選択します。
- Controlled by オプションを選択します。
- Server lifecycle external managed チェックボックスを選択します。
- Assign a runtime to server チェックボックスを選択します。
JBoss Runtime ウィンドウが表示されます。
- Home Directory フィールドの をクリックして、ランタイムサーバーを見つけます。
Remote System Integration ウィンドウが表示されます。
Remote Server Home フィールドで をクリックします。
Browse remote system ウインドウが表示されます。
- リモートサーバーが含まれるディレクトリーへのパスを指定します。
- をクリックします。
3.3. アプリケーションのデプロイ
ローカルサーバーの設定後に、サーバーアダプターを使用して CodeReady Studio からサーバーにアプリケーションをデプロイできます。サーバーアダプターは、アプリケーションとサーバー管理を簡単にデプロイできるように、サーバーと CodeReady Studio 間のランタイムの通信を可能にします。
CodeReady Studio のサーバーにアプリケーションをデプロイする方法を説明します。
手順
- CodeReady Studio を起動します。
Run on Server ウインドウが表示されます。
- Choose an existing server チェックボックスを選択します。
- デプロイするサーバーを選択します。
- をクリックします。
内部の CodeReady Studio Web ブラウザーでアプリケーションが開かれます。
第4章 CodeReady Studio の JBoss EAP および JBoss WFK の基本
Eclipse IDE は、Red Hat JBoss Enterprise Application Platform (JBoss EAP) および Red Hat JBoss Web Framework Kit (JBoss WFK) でのアプリケーション開発およびデプロイメントをサポートします。
ただし、最初に Maven リポジトリーを設定する必要があります。この設定は、Red Hat Central で提供される、エンタープライズバージョンの Maven プロジェクトサンプルの使用に不可欠です。これらのプロジェクトは JBoss EAP へのデプロイメントを目的としており、JBoss EAP リポジトリーおよび JBoss WFK リポジトリーへの IDE のアクセスが必要になります。
4.1. Maven リポジトリーの設定
Maven リポジトリーを設定する方法を説明します。
手順
- CodeReady Studio を起動します。
Preferences ウィンドウが表示されます。
- 検索フィールドに JBoss と入力します。
- JBoss Maven Integration を選択します。
Configure Maven Repositories ウインドウが表示されます。
Add Maven Repository ウインドウが表示されます。
- Profile ID フィールドの下向き矢印をクリックします。
redhat-ga-repository を選択します。
他のフィールドは自動的に入力されます。
- をクリックします。
Confirm File Update ウインドウが表示されます。
- をクリックします。
- をクリックします。
関連情報
- Maven リポジトリーの詳細は、Maven: Getting Started - Developers を参照してください。
4.2. JBoss EAP の設定
Eclipse で JBoss EAP を設定するには、IDE がローカルまたはリモートのランタイムサーバーを示すようにする必要があります。これにより、IDE と JBoss EAP サーバー間の通信チャネルが確立され、デプロイメントおよびサーバー管理のワークフローが効率的になります。
CodeReady Studio で JBoss EAP をインストールする方法を説明します。
前提条件
設定済みの Maven リポジトリー。
Maven リポジトリーの設定方法に関する詳細は、「Maven リポジトリーの設定」 を参照してください。
手順
- CodeReady Studio を起動します。
Preferences ウィンドウが表示されます。
- 検索フィールドに JBoss と入力します。
- JBoss Runtime Detection を選択します。
Download Runtimes ウィンドウが表示されます。
必要な JBoss EAP バージョンを選択します。
注記JBoss EAP バージョン 6.0.x 以前を選択した場合は、画面の指示に従います。6.0.x よりも新しいバージョンを選択した場合は、以下の手順に従います。
Credentials ウインドウが表示されます。
- をクリックします。
- access.redhat.com のユーザー名とパスワードを入力します。
- をクリックします。
ライセンス契約の内容を確認します。ライセンス契約に同意し、
をクリックしてインストールを続行します。Download Runtimes ウィンドウが表示されます。
- Install folder を選択します。 をクリックして、
- Download folder を選択します。 をクリックして、
Runtime のダウンロードとインストールには時間がかかる場合があるため注意してください。
JBoss Runtime Detection ウインドウが表示されます。
- JBoss EAP インストールファイルへのパスを選択します。
- をクリックします。
検証手順
Show View ウインドウが表示されます。
- 検索フィールドに Servers と入力します。
- Servers を選択します。
Servers ビューが表示されます。
新たに追加された JBoss EAP が Servers ビューに表示されます。
第5章 CodeReady Studio での OpenShift の基本
CodeReady Studio には OpenShift Application Explorer ビューが含まれています。これにより、ユーザーエクスペリエンスが簡素化され、内部ループで簡単および迅速にフィードバックすることができ、デバックも容易および迅速に行うことができます。
OpenShift Application Explorer は、CodeReady Studio でデフォルトのビューとして設定されています。手動で開く必要がある場合は、OpenShift Application Explorer ビューの設定 を参照してください。
前提条件
- 実行中の OpenShift クラスター。
5.1. OpenShift Application Explorer ビューの設定
CodeReady Studio で OpenShift Application Explorer を開く方法を説明します。
手順
- CodeReady Studio を起動します。
Show View ウインドウが表示されます。
- 検索フィールドに OpenShift と入力します。
- OpenShift Application Explorer を選択します。
OpenShift Application Explorer ビューが表示されます。
5.2. OpenShift Application Explorer を使用した OpenShift クラスターへの接続
OpenShift Application Explorer を使用して CodeReady Studio で OpenShift クラスターにログインする方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を開きます。
Can't connect to cluster. Click to loging. をクリックします。
Login ウインドウが表示されます。
OpenShift API URL を URL フィールドに貼り付けます。
OpenShift API URL を介してクラスターにアクセスする方法の詳細は、Red Hat OpenShift - Accessing your Services を参照してください。
- ユーザー名とパスワードまたはトークンを入力します。
- をクリックします。
5.3. ブラウザーベースのトークンの取得を使用した OpenShift クラスターへの接続
ユーザー名とパスワード、またはトークンを OpenShift Application Explorer に提供する代わりに、ブラウザーベースのトークンを取得して、OpenShift クラスターにログインすることができます。ログインコマンドを貼り付けるか、トークンを取得する場合は 2 つのログインオプションがあります。
5.3.1. login コマンドの貼り付け
手順
OpenShift API URL を URL フィールドに貼り付けます。
OpenShift API URL を介してクラスターにアクセスする方法の詳細は、Red Hat OpenShift - Accessing your Services を参照してください。
OpenShift Container Platform Web UI にアクセスします。
- 右上隅のドロップダウンメニューをクリックします。
- Copy Login Command をクリックします。
- Display Token をクリックします。
- ログインコマンドをコピーします。
Sign in to OpenShift ウィンドウで、 をクリックします。
- 注記
OpenShift 3 の場合、ログインコマンドはクリップボードに自動的にコピーされます。
5.3.2. トークンの取得
手順
OpenShift API URL を URL フィールドに貼り付けます。
OpenShift API URL を介してクラスターにアクセスする方法の詳細は、Red Hat OpenShift - Accessing your Services を参照してください。
- ユーザー名およびパスワードを入力します。
- をクリックします。
- をクリックします。
- をクリックします。
プロジェクトが OpenShift Application Explorer ビューに表示されます。
5.4. OpenShift ツールを使用した Developer Sandbox のセットアップ
次のセクションでは、CodeReady Studio で Developer Sandbox をブートストラップしてログインする方法について説明します。
手順
- CodeReady Studio を起動します。
OpenShift Application Explorer を開きます。
- OpenShift 接続を右クリックします。
Login をクリックします。
Sign in to OpenShift ウィンドウが表示されます。
- Red Hat Developer Sandbox をクリックします。
Red Hat アカウントの認証情報を入力し、
をクリックします。Developer Sandbox がブートストラップされました。
Red Hat Developer Sandbox へのログイン ウィンドウが表示されます。
- をクリックします。
- をクリックします。
- Red Hat アカウントの認証情報を再度入力し、 をクリックします。
- Display Token をクリックします。
Finish をクリックします。
トークンは、Sign in to OpenShift ウィンドウに表示されます。
Developer Sandbox にログインしました。
Developer Sandbox が OpenShift Application Explorer ビューに表示されます。
5.5. devfile に基づくアプリケーションのビルド
devfile を基にしてアプリケーションをデプロイするには、ローカルのワークスペースに空のプロジェクトが必要です。さらに、OpenShift にも devfile コンポーネントを作成するための空のプロジェクトが必要です。コンポーネントの確立後、プロジェクトが更新され、OpenShift で作成されたローカルおよびリモートアーティファクトも更新されます。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- → を選択します。
New Project ウインドウが表示されます。
- プロジェクトに名前を付けます。
- プロジェクトの場所を選択します。
新しく作成した空のプロジェクトが Package Explorer ビューに表示されます。
- OpenShift Application Explorer を起動します。
New project ウインドウが表示されます。
- プロジェクトに名前を付けます。
新たに作成したプロジェクトが OpenShift Application Explorer ビューに表示されます。
ターゲットの
→ → を右クリックします。Create component ウィンドウが表示されます。
- プロジェクトに名前を付けます。
- Eclipse Project を選択します。 をクリックして
-
Component type を
java-vertx
に設定します。 -
Project starter を
java-vertx
に設定します。 - アプリケーションに名前を付けます。
- Push after create チェックボックスを未選択にします。
Console ビューが表示され、検証プロセスが表示されます。
新たに作成されたコンポーネントが、プロジェクト下の OpenShift Application Explorer ビューに表示されます。
devfile をベースとするアプリケーションがビルドされます。
5.5.1. devfile レジストリーの管理
以下のセクションでは、CodeReady Studio で OpenShift Application Explorer を使用して devfile レジストリーを作成、削除、および編集する方法を説明します。
5.5.1.1. devfile レジストリーの追加
前提条件
- 実行中の OpenShift クラスター。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
Devfile レジストリーは、Devfile registries ノードの下に表示されます。
devfile レジストリーノードを拡張すると、そのレジストリーのすべての devfile が表示されます。
新しい devfile レジストリーを追加するには、Devfile registries を右クリックし、new をクリックします。
Create devfile registry ウィンドウが表示されます。
- devfile レジストリーに名前を付けます。
- devfile の URL を貼り付けます。
- をクリックします。
新しく作成された devfile レジストリーが OpenShift Application Explorer ビューの Devfile registries の下に表示されます。
5.5.1.2. devfile レジストリーの削除
前提条件
- 実行中の OpenShift クラスター。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
Devfile レジストリーは、Devfile registries ノードの下に表示されます。
拡張された devfile レジストリーノードには、そのレジストリーのすべての devfile が表示されます。
devfile レジストリーを削除するには、devfile レジストリーのノードを右クリックし、delete をクリックします。
これで、devfile レジストリーが削除されました。
5.5.1.3. devfile レジストリーの編集
前提条件
- 実行中の OpenShift クラスター。
手順
- devfile レジストリーを編集するには、YAML エディターを使用します。YAML エディターは、構文検証およびコンテンツアシストを提供します。
5.5.1.4. devfile レジストリーからのコンポーネントの作成
コンポーネントタイプまたはスタータープロジェクトの devfile レジストリーから新規コンポーネントを作成できます。
前提条件
- 既存の Eclipse プロジェクト。
- 既存の OpenShift プロジェクト。
- OpenShift クラスターに接続している。
手順
- Devfile レジストリー ノードで devfile レジストリーを展開します。
コンポーネントの種類またはスタータープロジェクトを右クリックし、
→ → をクリックします。Create component ウィンドウが表示されます。
- コンポーネントに名前を付けます。
- をクリックして Eclipse プロジェクトを選択します。
- Component タイプを選択します。
- プロジェクトのスターターを選択します。
- アプリケーションに名前を付けます。
- をクリックします。
新規コンポーネントは devfile レジストリーから作成されます。
関連情報
devfile の詳細は、Introduction to Devfile を参照してください。
5.6. OpenShift Application Explorer を使用したクラスターへのコンポーネントのデプロイ
CodeReady Studio で OpenShift Application Explorer を使用して、クラスターにコンポーネントをデプロイする方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
- プロジェクトを展開します。
- アプリケーションを展開します。
Console ビューが表示され、ファイル同期化のプロセスが表示されます。
5.7. OpenShift Application Explorer を使用した外部アクセス URL の定義
CodeReady Studio で OpenShift Application Explorer を使用して外部アクセス URL を定義する方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
- プロジェクトを展開します。
- アプリケーションを展開します。
Create URL ウインドウが表示されます。
- URL に名前を付けます。
- Port の値を 8080 に設定します。
Console ビューが表示され、URL 作成のプロセスが表示されます。
OpenShift Application Explorer で、 → を右クリックします。
Console ビューが表示され、ファイル同期化のプロセスが表示されます。
新たに作成された URL がコンポーネント下の OpenShift Application Explorer ビューに表示されます。
5.8. OpenShift Application Explorer を使用したクラスターでのアプリケーションのデバッグ
CodeReady Studio で OpenShift Application Explorer を使用して、クラスターでアプリケーションをデバッグする方法を説明します。
手順
- CodeReady Studio を起動します。
-
Project Explorer ビューで
MainVerticle.java
(devfiles) ファイルを見つけ、ダブルクリックして開きます。 左側がルーラーになっている列をクリックし、ブレークポイントを設定します。
- OpenShift Application Explorer を開きます。
- プロジェクトを展開します。
- アプリケーションを展開します。
Console ビューが表示されます。
- OpenShift Application Explorer で、コンポーネントを展開します。
Confirm Perspective Switch ウインドウが表示されます。
Debug Perspective ウィンドウが表示され、デバッグプロセスが表示されます。
5.9. OpenShift Application Explorer を使用したアプリケーションサービスの作成
OpenShift でクラウドネイティブアプリケーションを開発する際に Operator を使用してサービスを作成します。
前提条件
-
クラスターへのインストールされた Operator。
Operator のインストールについての詳細は、Adding Operators to a cluster を参照してください。
手順
OpenShift Application Explorer ビューで、アプリケーションを右クリックします。
Create service ビューが表示されます。
- サービスの名前を入力します。
- ドロップダウンメニューから、クラスターにインストールされている Operator からサービスを選択します。
- ドロップダウンメニューから、デプロイメントのタイプを選択します。
新たに作成されたサービスが OpenShift Application Explorer ビューに表示されます。
第6章 CodeReady Studio の Quarkus ツールの基本
Quarkus は Kubernetes ネイティブのフルスタック Java フレームワークで、Java 仮想マシンとの作業を最適化することを目的としています。Quarkus は、Quarkus アプリケーション開発者向けのツールを提供し、Java アプリケーションのサイズとコンテナーイメージのフットプリント、および必要なメモリー量を削減するのに役立ちます。
前提条件
- 最新バージョンの JBoss Tools がインストールされている。詳細は、JBoss Tools Downloads を参照してください。
6.1. 新しい Quarkus プロジェクトの作成
CodeReady Studio で新しい Quarkus プロジェクトを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Quarkus と入力します。
- Quarkus Project を選択します。
New Quarkus project ウインドウが表示されます。
- Quarkus ストリームを選択します。
- プロジェクトの種類を選択します。
- プロジェクトに名前を付けます。
- プロジェクトの場所を選択します。
Project type ウインドウが表示されます。
- デフォルト値が正しいことを確認します。
Quarkus extensions ウインドウが表示されます。
プロジェクトに必要な Categories を選択します。
選択したカテゴリーに使用可能なエクステンションが Extensions 列に表示されます。
プロジェクトに必要な Extensions を選択します。
エクステンションをダブルクリックして選択または選択解除します。選択したエクステンションが Selected 列に表示されます。
- をクリックします。
新たに作成された Quarkus プロジェクトが Project Explorer ビューに表示されます。
6.2. Quarkus アプリケーションの実行
CodeReady Studio で Quarkus アプリケーションを実行する方法を説明します。
手順
- CodeReady Studio を起動します。
Run Configurations ウィンドウが表示されます。
Quarkus Application まで下へスクロールします。
- 設定に名前を付けます。
- 注記
環境変数を Quarkus プロジェクトに追加することができます。新しい環境変数を追加するには、
→ をクリックし、名前と値を選択します。 - をクリックします。
Console ビューが表示されます。
アプリケーションは、ビルドプロセスの後に起動します。
6.3. Quarkus アプリケーションのデバッグ
CodeReady Studio で Quarkus アプリケーションをデバッグする方法を説明します。
手順
- CodeReady Studio を起動します。
Debug Configurations ウィンドウが表示されます。
- Quarkus Application を拡張します。
- 設定を選択します。
Console ビューが表示されます。
Quarkus アプリケーションが起動し、リモート JVM デバッグ設定に接続します。アプリケーションのソースファイルにブレークポイントを設定すると、ブレークポイントに到達した後に実行が自動的に停止します。
6.4. CodeReady Studio での言語サポートの使用
すべての Quarkus アプリケーションは、application.properties
設定ファイルを使用して設定されます。この設定ファイルの内容は、アプリケーションが使用している Quarkus エクステンションのセットによって異なります。
Quarkus ツールには、コード補完、検証、およびドキュメントを提供するコンテンツアシストが含まれています。コード補完により、コードのステートメントを迅速に完了できます。ポップアップから複数の選択肢を利用することができます。この言語サポートは、Kubernetes、OpenShift、Docker プロパティー、MicroProfile REST Client プロパティー、および MicroProfile Health アーティファクトで使用できるようになりました。
MicroProfile REST Client プロパティーの言語サポートは、個別に有効にする必要があります。詳細は、「MicroProfile REST Client プロパティーの言語サポートの有効化」 を参照してください。
6.4.1. Quarkus のコンテンツアシストの使用
CodeReady Studio で Quarkus の application.properties
コンテントアシストを使用する方法を説明します。
前提条件
既存の Quarkus プロジェクト。
Quarkus プロジェクトの作成方法に関する詳細は、「新しい Quarkus プロジェクトの作成」 を参照してください。
手順
- CodeReady Studio を起動します。
- Project Explorer を起動します。
- → を展開します。
Generic Text Editor ウインドウが表示されます。
- 空の行に移動します。
Ctrl+Space を押してコード補完を呼び出します。
コード補完のサジェスチョンが表示されます。マウスカーソルをサジェスチョンの上に移動し、ドキュメントを表示します。
エディターで誤った値を入力すると、エラーの下に赤い波線が表示されます。
関連情報
- MicroProfile REST Client プロパティーの言語サポートは、個別に有効にする必要があります。詳細は、「MicroProfile REST Client プロパティーの言語サポートの有効化」 を参照してください。
6.4.2. MicroProfile REST Client プロパティーの言語サポートの有効化
MicroProfile REST Client プロパティーの言語サポートを有効にする方法を説明します。
前提条件
既存の Quarkus プロジェクト。
Quarkus プロジェクトの作成方法に関する詳細は、「新しい Quarkus プロジェクトの作成」 を参照してください。
手順
- CodeReady Studio を起動します。
- Project Explorer を起動します。
- → を展開します。
Select wizard ウインドウが表示されます。
- 検索フィールドに file と入力します。
- File を選択します。
Create a new file resource ウインドウが表示されます。
- 新しいファイルに名前を付けます。
- をクリックします。
新たに作成されたファイルに以下の内容を貼り付けます。
package org.acme; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.core.Response; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; @RegisterRestClient public interface MyServiceClient { @GET ("/greet") Response greet(); }
- Ctrl+S キーを押して変更を保存します。
関連情報
- 言語サポートの使用方法の詳細は、「Quarkus のコンテンツアシストの使用」 を参照してください。
- 言語サポートの調整は、Quarkus - Using the REST client, Create the interface を参照してください。
第7章 CodeReady Studio の Hibernate Tools の基本
Hibernate Tools は、Hibernate バージョン 5 以前に関連するプロジェクトのツールのコレクションです。このツールは、Hibernate とのリバースエンジニアリング、コード生成、可視化、および対話を行う Eclipse プラグインを提供します。
7.1. 新しい Jakarta Persistence プロジェクトの作成
CodeReady Studio で新規 Jakarta Persistence プロジェクトを作成する方法を説明します。
前提条件
Sakila データベースサーバーが起動している。
Sakila データベースを起動するには、以下を実行します。- h2 バージョンの Sakila データベース をダウンロードします。
-
runh2.sh
ファイルが含まれるディレクトリーに移動します。 runh2.sh
ファイルを実行します。$ ./runh2.sh
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a Wizard ウインドウが表示されます。
- 検索フィールドに JPA と入力します。
- JPA Project を選択します。
New JPA Project ウインドウが表示されます。
- プロジェクトに名前を付けます。
- プロジェクトの場所を選択します。
- Target runtime フィールドで下矢印をクリックし、ランタイムサーバーを選択します。
- JPA version を 2.1 に設定します。
Java ウィンドウが表示されます。
- ソースフォルダーを選択します。
JPA Facet ウィンドウが表示されます。
- Platform フィールドの下矢印をクリックし、Hibernate (JPA 2.1) を選択します。
ユーザーライブラリーを追加するか、JPA Implementation Type を Disable Library Configuration に設定します。
ユーザーライブラリーの設定方法の詳細は、「ライブラリーの追加」 を参照してください。
Connection Profile ウインドウが表示されます。
- 検索フィールドに Generic と入力します。
- Generic JDBC を選択します。
- Name フィールドに Sakila と入力します。
Specify a Driver and Connection Details ウィンドウが表示されます。
New Driver Definition ウインドウが表示されます。
- Generic JDBC Driver を選択します。
JAR List タブをクリックします。
- ボタンをクリックします。
-
Sakila データベースの
.jar
ファイルを選択します。 Properties タブをクリックします。
-
jdbc:h2:tcp://localhost/./sakila
を Connection URL フィールドに追加します。 - Driver Class フィールドをクリックします。
Driver Class フィールドの末尾にある、点 3 つのアイコンをクリックします。
Available Classes from Jar List ウインドウが表示されます。
- Browse for Class オプションを選択します。
- org.h2.Driver を選択します。
- をクリックします。
User ID フィールドに
sa
と入力します。- → → とクリックします。
新たに作成された Jakarta Persistence プロジェクトが Project Explorer ビューに表示されます。
7.2. ライブラリーの追加
CodeReady Studio で、Hibernate プロジェクトにライブラリーを追加する方法を説明します。
手順
- Hibernate ORM をダウンロードします。
- ファイルを展開します。
- CodeReady Studio を起動します。
Preferences ウィンドウが表示されます。
- 検索フィールドに Libraries と入力します。
- Java で User Libraries を選択します。
New User Library ウィンドウが表示されます。
- ユーザーライブラリーに名前を付けます。
- をクリックします。
新しいユーザーライブラリーを選択します。
- ボタンをクリックします。
- Hibernate ORM ファイルを展開したディレクトリーを選択します。
-
/lib/required/
ディレクトリーに移動します。 -
.jar
ファイルを選択します。 選択した
.jar
ファイルがユーザーライブラリーに表示されます。- をクリックします。
7.3. エンティティーからのテーブルの生成
CodeReady Studio で Hibernate プロジェクトのエンティティーからテーブルを生成する方法を説明します。
手順
- CodeReady Studio を起動します。
- Project Explorer を開きます。
Generate Table from Entities ウィンドウが表示されます。
- Use Console Configuration チェックボックスを選択します。
- をクリックします。
7.4. Hibernate マッピングファイルの作成
Hibernate マッピングファイルは、オブジェクトがどのようにデータベーステーブルに関連するかを指定します。
CodeReady Studio で Hibernate マッピングファイルを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Hibernate と入力します。
- Hibernate XML Mapping file (hbm.xml) を選択します。
Create Hibernate XML Mapping file ウインドウが表示されます。
- ボタンをクリックしてクラスを追加します。
または、パッケージまたはクラスを選択せずに空の
.hbm.xml
ファイルを作成することもできます。- depth control チェックボックスを選択し、クラスの選択時に使用される依存関係の深さを定義します。
New Hibernate XML Mapping files ウインドウが表示されます。
- 親ディレクトリーを選択します。
-
.hbm.xml
ファイルに名前を付けます。 - をクリックします。
7.5. Hibernate 設定ファイルの作成
リバースエンジニアリング、プロトタイプクエリー、または Hibernate Core の使用には、hibernate.properties
または hibernate.cfg.xml
ファイルが必要になります。CodeReady Studio には、設定ファイル hibernate.cfg.xml
を生成するウィザードがあります。
CodeReady Studio で Hibernate 設定ファイルを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Hibernate と入力します。
- Hibernate Configuration file (cfg.xml) を選択します。
Create Hibernate Configuration file (cfg.xml) ウインドウが表示されます。
- 親ディレクトリーを選択します。
Hibernate Configuration File(cfg.xml) ウインドウが表示されます。
- Database dialect フィールドの下矢印をクリックして、データベースを選択します。
- Driver class フィールドの下矢印をクリックして、ドライバーを選択します。
- Connection URL フィールドの下矢印をクリックし、URL を選択します。
- をクリックします。
7.6. Hibernate コンソール設定ファイルの作成
コンソール設定ファイルには、Hibernate プラグインがどのように Hibernate を設定するかが記述されています。また、POJO や JDBC ドライバーなどのロードに必要な設定ファイルおよびクラスパスも記述されています。これは、クエリープロトタイピング、リバースエンジニアリング、およびコードの生成を使用するために必要です。プロジェクトごとに複数のコンソール設定を指定できますが、1 つの設定で十分です。
CodeReady Studio で Hibernate コンソール設定ファイルを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Hibernate と入力します。
- Hibernate Console Configuration を選択します。
Create Hibernate Console Configuration ウィンドウが表示されます。
- 設定ファイルに名前を付けます。
- Type が Core に設定されていることを確認します。
- 正しい Hibernate version を選択します。
- をクリックしてプロジェクトを見つけます。
Database connection を設定します。
をクリックして、新しいNew Connection Profile ウインドウが表示されます。
- Data Connection を選択するか、新たに作成します。
Property file を設定します。
をクリックして、Setup property file ウインドウを表示します。
Create Hibernate Properties file (.properties) ウインドウが表示されます。
- 親ディレクトリーを選択します。
-
.properties
ファイルに名前を付けます。 - をクリックします。
- Configuration file を設定します。 をクリックし、
ターゲット
.cfg.xml
ファイルへのパスを選択します。Setup configuration file ウインドウが表示されます。
Create Hibernate Configuration file (cfg.xml) ウインドウが表示されます。
- 親ディレクトリーを選択します。
Hibernate Configuration File(cfg.xml) ウインドウが表示されます。
- Database dialect フィールドの下矢印をクリックして、データベースを選択します。
- Driver class フィールドの下矢印をクリックして、ドライバーを選択します。
- Connection URL フィールドの下矢印をクリックし、URL を選択します。
Create Hibernate Console Configuration ウィンドウが表示されます。
-
データベースコネクションを
sakila
に設定します。 - をクリックします。
7.7. Hibernate プロジェクト設定の編集
CodeReady Studio で Hibernate プロジェクトの設定を編集する方法を説明します。
手順
- CodeReady Studio を起動します。
Show View ウインドウが表示されます。
- 検索フィールドに Hibernate と入力します。
- Hibernate Configurations を選択します。
Hibernate Configurations ビューが表示されます。
Edit Configuration ウインドウが表示されます。
- 設定を編集します。
- をクリックします。
- をクリックします。
7.8. Hibernate ランタイム実装の設定
Hibernate 設定ページでランタイム実装を有効または無効にできます。
以下のセクションでは、ランタイムの設定方法を説明します。
手順
設定ページが開きます。
- 検索フィールドに Hibernate と入力します。
- Hibernate を選択します。
チェックを入れて Hibernate プロジェクトのランタイムを無効にするか、チェックを解除します。
第8章 CodeReady Studio での Mobile Web Tools の基本
Mobile Web Tools は、モバイルデバイス向けに最適化された Web アプリケーションの作成を可能にする HTML5 Project ウィザードを提供します。HTML5 Project ウィザードは、CodeReady Studio ですべての新規 HTML5 Web アプリケーションを作成するための便利なウィザードです。このウィザードは、Maven archetype からの REST リソースを使用して、そのままデプロイできる HTML5 モバイルアプリケーションのサンプルを生成します。
組み込みエディターを使用してアプリケーションをカスタマイズでき、組み込みブラウザーでアプリケーションをデプロイおよび表示できます。
CodeReady Studio では、ユーザーが対話式の Web アプリケーションを作成できる Mobile Web パレットが提供されます。このパレットは、HTML5、jQuery Mobile、および Ionic タグなどの一般的な Web インターフェイスフレームワーク機能を html ファイルに追加するドラッグアンドドロップウィジェットなど、幅広い機能を提供します。また、よりユーザーフレンドリーで効率的なアプリケーションを実現するための、Panels、Pages、Lists、および Buttons などのウィジェットも含まれています。
8.1. HTML5 プロジェクトの作成
HTML5 Project ウィザードは、Maven アーキタイプと、提供するプロジェクトおよびアプリケーション識別子を基にして、サンプルプロジェクトを生成します。Maven archetype バージョンは、ウィザードの最初のページにある Description フィールドに示されます。バージョンを変更できるため、ウィザード内でエンタープライズまたは非エンタープライズいずれかのターゲットランタイムを選択して、プロジェクトの見た目と依存関係も変更できます。
CodeReady Studio で HTML5 プロジェクトを作成する方法を説明します。
前提条件
設定済みのローカルサーバー。
ローカルランタイムサーバーの設定およびアプリケーションのローカルランタイムサーバーへのデプロイメントに関する詳細は、「ローカルサーバーの設定」 を参照してください。
CodeReady Studio は、アプリケーションをデプロイするすべてのサーバーに対して設定する必要があります。これには、アプリケーションサーバーの場所およびタイプ、カスタム設定、カスタム管理設定などが含まれます。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに HTML5 と入力します。
- HTML5 Project を選択します。
New Project Example ウィンドウが表示されます。
- Target Runtime フィールドの下矢印をクリックします。
- サーバーを選択します。
- をクリックします。
- プロジェクトとパッケージに名前を付けます。
- プロジェクトの場所を選択します。
プロジェクトの生成には時間がかかる場合があります。
New Project Example ウィンドウが表示されます。
- をクリックします。
新たに作成されたプロジェクトが Project Explorer ビューに表示されます。
8.2. 新しい HTML5 jQuery Mobile ファイルの追加
HTML5 jQuery Mobile
ファイルテンプレートは、ファイルの HTML ヘッダーに挿入される JavaScript および CSS ライブラリー参照で設定されます。このテンプレートは、jQuery Mobile ページのスケルトンや、ファイルの HTML ボディーの listview ウィジェットも挿入します。
既存のプロジェクトに新しい HTML5 jQuery Mobile ファイルを追加する方法を説明します。
前提条件
設定済みのサーバー。
ローカルランタイムサーバーの設定およびアプリケーションのローカルランタイムサーバーへのデプロイメントに関する詳細は、「ローカルサーバーの設定」 を参照してください。
CodeReady Studio は、アプリケーションをデプロイするすべてのサーバーに対して設定する必要があります。これには、アプリケーションサーバーの場所およびタイプ、カスタム設定、カスタム管理設定などが含まれます。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに HTML と入力します。
- HTML File を選択します。
New HTML File ウインドウが表示されます。
- ファイルの場所を選択します。
- ファイルに名前を付けます。
Select HTML Template ウインドウが表示されます。
- テンプレートを選択します。
- をクリックします。
新たに作成された HTML ファイルが CodeReady Studio エディターに表示されます。
8.3. 新しいモバイルページの追加
既存の Web アプリケーションに新しい jQuery Mobile ページを追加する方法を説明します。
前提条件
HTML5 プロジェクト。
HTML5 プロジェクトの作成方法についての詳細は、「HTML5 プロジェクトの作成」 を参照してください。
手順
- CodeReady Studio を起動します。
Show View ウインドウが表示されます。
- 検索フィールドに Palette と入力します。
- Palette を選択します。
Palette ビューが表示されます。
Page アイコンをクリックします。
Insert Tag ウィンドウが表示されます。
- Header に名前を付けます。
- Footer に名前を付けます。
- をクリックします。
新たに追加されたページが CodeReady Studio エディターに表示されます。
同じワークフローを使用して、Palette ビューからウィジェットを選択することにより、Web アプリケーションのページをカスタマイズできます。