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 を使用する前に、次の作業が必要です。
- エンタープライズ JavaおよびWeb デベロッパー向けEclipse IDEをダウンロードしてインストールします。
- AEM Developer Tools for Eclipseのバージョン 1.4.0は、Eclipse 2022-12 (4.26)以降と互換性があり、実行するにはJava 17以降が必要です。
- Eclipse FAQの説明に従って
eclipse.ini設定ファイルを編集し、ヒープメモリが1 GB以上になるようにEclipse インストールを設定します。
eclipse.iniを見つける必要があります。Eclipse 用 AEM 開発者ツールのインストール方法 how-to-install-the-aem-developer-tools-for-eclipse
上記の要件を満たした場合、次のように開発者ツールプラグインをインストールできます。
-
インストール用リンクをコピーします。
- または、インストールリンクを使用する代わりにアーカイブをダウンロードすることもできます。
- この方法では、オフラインでのインストールは可能ですが、自動更新通知は受け取りません。
-
Eclipse で、ヘルプメニューを開きます。
-
「Install New Software」をクリックします。
-
「Add…」をクリックします。
-
「Name」フィールドに「
AEM Developer Tools」と入力します。 -
「Location」フィールドにインストール用 URL をコピーします。
-
「Add」をクリックします。
-
「AEM」プラグインと「Sling」プラグインの両方をオンにします。
-
「Next」をクリックします。
-
詳細をインストール ウィンドウで、インストールするアイテムを確認し、次へをもう一度クリックします。
-
使用許諾契約書に同意し、「Finish」をクリックします。
-
表示されるTrust Authorities ダイアログで、権限/サイト
https://eclipse.adobe.comを選択し、Trust Selectedをクリックします。 -
表示されるTrust Artifacts ダイアログで、コード署名者を選択し、Trust Selectedをクリックします。
-
「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 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.jarnote 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 Explorer パネルで、
PROJECT.ui.apps>src>main>content>jcr_root>appsを展開します。 appsフォルダーを右クリックし、表示/System Explorer を選択します。- そこに
appsとetc個のフォルダーを削除します。 - 同じ場所に、コンテンツパッケージの
appsとetcフォルダーを配置します。 - Eclipse で
PROJECT.ui.appsプロジェクトを右クリックし、「更新」を選択します。
- Project Explorer パネルで、
-
続いて、
PROJECT.ui.contentに対して同じことを行い、そのコンテンツフォルダーを自分のパッケージの 1 つに置き換えます。- Project Explorer パネルで、
PROJECT.ui.content>src>main>content>jcr_root>contentを展開します。 - 深い階層のコンテンツフォルダーを右クリックし、表示/System Explorer を選択します。
- そこにコンテンツフォルダーを削除します。
- 同じ場所に、コンテンツパッケージのコンテンツフォルダーを配置します。
- Eclipse で
PROJECT.ui.contentプロジェクトを右クリックし、「更新」を選択します。
- Project Explorer パネルで、
-
コンテンツパッケージの
META-INF/vault/filter.xmlファイルを別のテキスト/コードエディターで開いて、これらの2つのプロジェクトの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 ツールのEclipse web サイトには、便利な追加情報が用意されています。
- Apache Sling IDE tooling for Eclipse User Guideでは、AEM Development Toolsでサポートされている全体的なコンセプト、サーバー統合、デプロイメント機能について説明しています。
- Apache Sling IDE ツールのトラブルシューティング
- 既知の問題リスト
次の公式の Eclipse ドキュメントは、環境の設定に役立ちます。