AEM Developer Tools for Eclipse

概要

AEM Developer Tools for Eclipse は、Apache License 2 に従ってリリースされた Apache Sling 向け Eclipse プラグイン をベースとする Eclipse プラグインです。

このツールは、AEM 開発を容易にする次のような機能を提供します。

  • Eclipse Server Connector による AEM インスタンスとのシームレスな統合。
  • コンテンツと OSGI バンドルの同期。
  • コードのホットスワップ機能によるデバッグのサポート。
  • 固有のプロジェクト作成ウィザードからの AEM プロジェクトの簡単なブートストラップ.
  • JCR プロパティの容易な編集.

要件

AEM Developer Tools を使用する前に、次の作業が必要です。

  • Eclipse IDE for Java EE Developers をダウンロードしてインストールします。AEM Developer Tools は現在、Eclipse Kepler以降をサポートしています。

  • AEMバージョン 5.6.1 以降で使用できます。

  • Eclipse に関する FAQ の説明に従って、eclipse.ini 設定ファイルを編集し、ヒープメモリが 1 GB 以上になるように Eclipse を設定します。

メモ

macOS では、Eclipse.app を右クリックし、「パッケージの内容を表示」を選択して、eclipse.iniを探します。

AEM Developer Tools for Eclipse のインストール方法

上記の要件を満たしたら、次の手順でプラグインをインストールできます。

  1. AEM Developer Tools Web サイトにアクセスします。

  2. インストール用リンク​をコピーします。

    または、インストール用リンクを使用する代わりに、アーカイブをダウンロードすることもできます。この方法ではオフラインインストールが可能ですが、自動アップデート通知は受けられません。

  3. Eclipse で、Help メニューを開きます。

  4. 「Install New Software」をクリックします。

  5. 「Add…」をクリックします。

  6. 「Name」に「AEM Developer Tools」と入力します。

  7. 「Location」にインストール用 URL をコピーします。

  8. 「OK」をクリックします。

  9. 「AEM」プラグインと「Sling」プラグインの両方をオンにします。

  10. 「Next」をクリックします。

  11. 「次へ」をクリックします。

  12. 使用許諾契約書に同意し、「Finish」をクリックします。

  13. 「Yes」をクリックして、Eclipse を再起動します。

既存プロジェクトの読み込み方法

メモ

AEM パースペクティブ

AEM Development Tools for Eclipse には、AEM プロジェクトおよびインスタンスを完全にコントロールできるパースペクティブが同梱されています。

chlimage_1-2

サンプルのマルチモジュールプロジェクト

AEM Developer Tools for Eclipse には、サンプルのマルチモジュールプロジェクトが同梱されています。このプロジェクトは、Eclipse でのプロジェクト設定を手早く行うために役立つだけでなく、いくつかの AEM 機能に対するベストプラクティスガイドの役割も果たします。プロジェクトのアーキタイプについて詳しくは、こちらを参照してください。

次の手順を実行して、サンプルプロジェクトを作成します。

  1. File／New／Project​メニューで、「AEM」セクションを参照して、「AEM Sample Multi-Module Project」を選択します。

    chlimage_1-69

  2. 「次へ」をクリックします。

    メモ

    m2eclipse がアーキタイプカタログをスキャンする必要があるので、この手順にはしばらくかかることがあります。

    chlimage_1-70

  3. メニューから「com.adobe.granite.archetypes：sample-project-archetype：（最も大きい数字）」を選択して、「Next」をクリックします。

    chlimage_1-71

  4. サンプルプロジェクトの​名前、グループ ID および​アーティファクト ID を入力します。いくつかの高度なプロパティを設定することもできます。

    chlimage_1-72

  5. 次に、Eclipse が接続する AEM サーバーを設定します。

    デバッガー機能を使用するには、AEM をデバッグモードで起動する必要があります。コマンドラインに以下を追加するなどして、デバッグモードで起動できます。

        -nofork -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10123

    chlimage_1-73

  6. 「Finish」をクリックします。プロジェクト構造が作成されます。

    メモ

    新規インストールでは（より具体的には、Maven の依存関係をダウンロードしたことがない場合は）、プロジェクトを作成するとエラーが表示されることがあります。その場合は、無効なプロジェクト定義の解決で説明されている手順に従ってください。

トラブルシューティング

無効なプロジェクト定義の解決

無効な依存関係およびプロジェクト定義を解決するには、次の手順を実行します。

  1. 作成したプロジェクトをすべて選択します。
  2. 右クリックします。Maven メニューで「Update Projects」を選択します。
  3. 「Force Updates of Snapshot/Releases」をオンにします。
  4. 「OK」をクリックします。Eclipse が必要な依存関係のダウンロードを試みます。

JSP ファイルでのタグライブラリのオートコンプリートの有効化

適切な依存関係がプロジェクトに追加されていれば、タグライブラリのオートコンプリートはデフォルトで機能します。必要な tld ファイルと TagExtraInfo ファイルが含まれていない AEM Uber Jar を使用する場合、既知の問題が 1 つ存在します。

この問題を回避するには、org.apache.sling.scripting.jsp.taglib アーティファクトを AEM Uber Jar より前のクラスパスに配置します。Maven プロジェクトの場合は、pom.xml 内で、Uber Jar より前に次の依存関係を配置します。

<dependency>
  <groupId>org.apache.sling</groupId>
  <artifactId>org.apache.sling.scripting.jsp.taglib</artifactId>
  <scope>provided</scope>
</dependency>

使用する AEM のデプロイメントに適したバージョンを追加してください。

詳細情報

Apache Sling IDE tooling for Eclipse の公式 Web サイトでは、次の役立つ情報を参照できます。

次の公式の Eclipse ドキュメントは、環境の設定に役立ちます。

このページ