AEM Developer Tools for Eclipse aem-developer-tools-for-eclipse
概要 overview
Experience Manager Developer Tools for Eclipse は、Apache License 2 に従ってリリースされた Apache Sling 向け Eclipse プラグインをベースとした Eclipse プラグインです。
このツールは、AEM 開発を容易にする次のような機能を提供します。
- Eclipse Server Connector による AEM インスタンスとのシームレスな統合
- コンテンツと OSGi バンドルの同期
- コードのホットスワップ機能を備えたデバッグサポート
- 固有のプロジェクト作成ウィザードからの AEM プロジェクトの簡単なブートストラップ
- JCR プロパティを容易に編集できる
要件 requirements
AEM Developer Tools を使用する前に、次の作業が必要です。
- Eclipse IDE for Enterprise Java and Web Developers. をダウンロードしてインストールします。
- AEM Developer Tools for Eclipse のバージョン 1.4.0 は、Eclipse 2022-12 (4.26)以降と互換性があり、実行するには Java 17 以降が必要です。
eclipse.ini
Eclipse に関する FAQ の説明に従って、 設定ファイルを編集し、ヒープメモリが 1 GB 以上になるように Eclipse を設定します。
eclipse.ini
ージを探します。Eclipse 用 AEM 開発者ツールのインストール方法 how-to-install-the-aem-developer-tools-for-eclipse
前述の requirements を満たしたら、次の手順で開発者ツールプラグインをインストールできます。
-
インストール用リンク をコピーします。
- または、インストールリンクを使用する代わりに、アーカイブをダウンロードできます。
- この方法ではオフラインインストールが可能ですが、自動更新の通知は受け取りません。
-
Eclipse で、ヘルプ メニューを開きます。
-
「Install New Software」をクリックします。
-
「Add…」をクリックします。
-
「Name」フィールドに「
AEM Developer Tools
」と入力します。 -
「Location」フィールドにインストール用 URL をコピーします。
-
「Add」をクリックします。
-
「AEM」プラグインと「Sling」プラグインの両方をオンにします。
-
「Next」をクリックします。
-
インストールの詳細 ウィンドウで、インストールする項目を確認し、もう一度 次へ をクリックします。
-
使用許諾契約書に同意し、「Finish」をクリックします。
-
信頼する機関 ダイアログが表示されるので、機関/サイト
https://eclipse.adobe.com
を選択して 信頼する選択 をクリックします。 -
アーティファクトを信頼 ダイアログが表示されるので、コード署名者を選択して 選択項目を信頼 をクリックします。
-
「RestartNow」をクリックして、Eclipse を再起動します。
AEM パースペクティブ the-aem-perspective
Eclipse では、パースペクティブ によって、ウィンドウ内で使用可能なアクションやビューが決定され、Eclipse のリソースとのタスク指向のやり取りが可能になります。 パースペクティブについて詳しくは、Eclipse のドキュメント を参照してください。
Experience Manager Development Tools for Eclipse には、AEM プロジェクトおよびインスタンスを完全にコントロールできるAEM パースペクティブが用意されています。 AEM パースペクティブを開くには:
- Eclipse メニューバーから、ウィンドウ/パースペクティブ/パースペクティブを開く/その他 を選択します。
- ダイアログで「AEM」を選択し、「Open」をクリックします。
サンプルのマルチモジュールプロジェクト sample-multi-module-project
Experience Manager Developer Tools for Eclipse には、Eclipse でのプロジェクト設定を素早く習得できる、サンプルのマルチモジュールプロジェクトが付属しています。 また、AEM プロジェクトアーキタイプを活用して、AEMのいくつかの機能のベストプラクティスガイドとしても役立ち す。
サンプルプロジェクトを作成する手順は次のとおりです。
-
File/New/Project メニューで、「AEM」セクションを参照して、「AEM Sample Multi-Module Project」を選択します。
-
「Next」をクリックします。
note note NOTE m2eclipse がアーキタイプカタログをスキャンする必要があるので、この手順には数分かかることがあります。 -
com.adobe.aem : aem-project-archetype : <highest-number>
アーキタイプ ドロップダウンで が自動的に選択されます。 必要に応じて、以前のバージョンを選択します。 「次へ」をクリックします。 -
サンプルプロジェクトの次のフィールドを指定します。
- Name
- Group Id
- Artifact Id
- appId - この値を設定するには、「Advanced」オプションを展開する必要があります。
- appTitle - この値を設定するには、「Advanced」オプションを展開する必要があります。
- Package - この値を設定するには、「Advanced」オプションを展開する必要があります。
-
「Next」をクリックします。
-
新規サーバーを設定 を選択し、サーバー名と必要な接続詳細を入力して、Eclipse が接続するAEM サーバーを設定します。
- デバッガー機能を使用するには、
-agentlib
のパラメーターを指定してAEMをデバッグモードで起動する必要があります。以下に例を示します。
code language-text $ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar aem-author-p4502.jar
note tip TIP ローカルのAEM SDKで動作するプロジェクトのデバッグについて詳しくは、AEM SDKのリモートデバッグ を参照してください。 - デバッガー機能を使用するには、
-
「終了」をクリックします。
プロジェクト構造が作成されます。 必要なアーティファクトをプロジェクトにダウンロードするのに時間がかかる場合があります。
既存プロジェクトの読み込み方法 how-to-import-existing-projects
新規プロジェクト 機能を使用して、基本的なプロジェクト構造を作成します。
-
手順に従って、基本的なプロジェクト構造を作成し 関心事を合理的に分離した サンプル マルチモジュールプロジェクト」を作成します。
PROJECT.ui.apps
:/apps
および/etc
のコンテンツ用PROJECT.ui.content
:/content
の作成済みコンテンツ用- Java バンドルの
PROJECT.core
PROJECT.it.launcher
およびPROJECT.it.tests
:統合テスト用
-
PROJECT.ui.apps
プロジェクトの内容をパッケージのapps
フォルダーとetc
フォルダーに置き換えます。- プロジェクトエクスプローラー パネルで、
PROJECT.ui.apps
/src
/main
/content
/jcr_root
/apps
を展開します。 apps
フォルダーを右クリックし、表示/System Explorer を選択します。- そこで
apps
フォルダーとetc
フォルダーを削除します。 - 同じ場所に、コンテンツパッケージの
apps
フォルダーとetc
フォルダーを配置します。 - Eclipse で
PROJECT.ui.apps
プロジェクトを右クリックし、「更新」を選択します。
- プロジェクトエクスプローラー パネルで、
-
続いて、
PROJECT.ui.content
に対して同じことを行い、そのコンテンツフォルダーを自分のパッケージの 1 つに置き換えます。- プロジェクトエクスプローラー パネルで、
PROJECT.ui.content
/src
/main
/content
/jcr_root
/content
を展開します。 - 深い階層のコンテンツフォルダーを右クリックし、表示/System Explorer を選択します。
- そこでコンテンツフォルダーを削除します。
- 同じ場所に、コンテンツパッケージのコンテンツフォルダーを配置します。
- Eclipse で
PROJECT.ui.content
プロジェクトを右クリックし、「更新」を選択します。
- プロジェクトエクスプローラー パネルで、
-
コンテンツパッケージの
filter.xml
ファイルを別のテキスト/コードエディターで開いて、コンテンツパッケージのコンテンツに対応するようにこれら 2 つのプロジェクトのMETA-INF/vault/filter.xml
ファイルを更新します。filter.xml
ファイルの例を次に示します。
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/apps/foo"/> <filter root="/apps/foundation/components/bar"/> <filter root="/etc/designs/foo"/> <filter root="/content/foo"/> <filter root="/content/dam/foo"/> <filter root="/content/usergenerated/content/foo"/> </workspaceFilter>
-
2 つのプロジェクトに分割されたパッケージ内容については、これらのフィルタールールを 2 つに分割し、それに応じて 2 つのプロジェクトの
filter.xml
ファイルを更新する必要もあります。-
Eclipse で
PROJECT.ui.apps/src/main/content/META-INF/filter.xml
を開きます。 -
<workspaceFilter>
要素の内容を、/apps
または/etc
で始まる、パッケージのルールに置き換えます-
次に例を示します。
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/apps/foo"/> <filter root="/apps/foundation/components/bar"/> <filter root="/etc/designs/foo"/> </workspaceFilter>
-
-
次に、
PROJECT.ui.content/src/main/content/META-INF/filter.xml
を開きます。 -
ルールを、
/content
で始まる、パッケージのルールに置き換えます。-
次に例を示します。
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/content/foo"/> <filter root="/content/dam/foo"/> <filter root="/content/usergenerated/content/foo"/> </workspaceFilter>
-
-
-
すべての変更を保存してください。これで、新しいコンテンツが AEM インスタンスに同期するようになりました。
-
サーバー パネルで、接続が開始されていることを確認し、開始されていない場合は開始します。
-
「削除と公開」アイコンをクリックします。
完了したら、パッケージがインスタンス上で実行されます。 保存時に、変更はすべてインスタンスに自動的に同期されます。
プロジェクトからパッケージを再ビルドする場合は、PROJECT.ui.apps
または PROJECT.ui.content
を右クリックし、次として実行/Maven インストール を選択します。
これで、パッケージ(例えば、PROJECT.ui.apps-0.0.1-SNAPSHOT.zip
)を含んだターゲットフォルダーが作成されました。
トラブルシューティング troubleshooting
無効なプロジェクト定義の解決 resolving-invalid-project-definition
無効な依存関係およびプロジェクト定義を解決するには、次の手順を実行します。
- 作成したプロジェクトをすべて選択します。
- 右クリックします。
- コンテキストメニューで、Maven/プロジェクトを更新 を選択します。
- 「Force Updates of Snapshot/Releases」をオンにします。
- 「OK」をクリックします。
必要な依存関係が自動的にダウンロードされます。これには少し時間がかかる場合があります。
詳細情報 more-information
Apache Sling IDE tooling for Eclipse の公式 web サイトでは、次の有益な追加情報を参照できます。
- Apache Sling IDE tooling for Eclipse ユーザーガイド を参照しながら、全体のコンセプト、AEM Development Tools がサポートするサーバー統合およびデプロイメント機能を確認できます。
- Apache Sling IDE ツールのトラブルシューティング
- 既知の問題リスト
次の公式の Eclipse ドキュメントは、環境の設定に役立ちます。