AEM Developer Tools for Eclipse

概覽

AEM Developer Tools for Eclipse是以Apache License 2.0底下發行的適用於Apache Sling🔗的 Eclipse外掛程式為基礎的Eclipse外掛程式。

它提供數種可讓AEM開發更輕鬆的功能:

  • 透過Eclipse Server Connector與AEM執行個體緊密整合
  • 內容和OSGi套件組合的同步
  • 具有程式碼熱交換功能的除錯支援
  • 透過特定專案建立精靈簡單引導AEM專案
  • 輕鬆編輯JCR屬性

需求

使用AEM開發人員工具之前,您需要:

注意

在macOS上,需要按一下右鍵​Eclipse.app,然後選擇​顯示包內容​以查找​eclipse.ini

如何安裝AEM Developer Tools for Eclipse

完成上述要求後,您就可以依照下列方式安裝外掛程式:

  1. 開啟AEM開發人員工具網站。

  2. 複製​安裝連結

    請注意,您也可以下載封存檔,而不是使用安裝連結。 這允許離線安裝,但您會以這種方式遺漏自動更新通知。

  3. 在Eclipse中,開啟​Help​功能表。

  4. 按一下「安裝新軟體」。

  5. 按一下​添加……

  6. 在​名稱​中輸入AEM Developer Tools

  7. 在​Location​中複製安裝URL。

  8. 按一下​「新增」

  9. 檢查​AEM​和​Sling​外掛程式。

  10. 按一下​下一步

  11. 在​安裝詳細資訊​窗口中,再次按一下​Next

  12. 接受許可協定,然後按一下​完成

  13. 按一下​RestartNow​以重新啟動Eclipse。

AEM透視

在Eclipse中,透視可決定視窗中可用的動作和檢視,並啟用以任務為導向的與Eclipse中的資源互動。 如需Perspective的詳細資訊,請參閱Eclipse檔案。

AEM Development Tools for Eclipse提供AEM Perspective,讓您能完整控制AEM專案和例項。 要開啟AEM透視:

  1. 從Eclipse菜單欄中,選擇​Window -> Perspective -> Open Perspective -> Other
  2. 在對話方塊中選取​AEM,然後按一下​開啟

Eclipse中的AEM透視

多模組項目示例

AEM Developer Tools for Eclipse隨附範例多模組專案,可協助您快速上手設定Eclipse中的專案,並提供數種AEM功能的最佳實務指南。 深入了解專案原型

請依照下列步驟建立範例專案:

  1. 在​File > New > Project​菜單中,瀏覽到​AEM​部分並選擇​AEM Sample Multi-Module Project

    AEM範例多模組專案

  2. 按一下​下一步

    注意

    此步驟可能需要一些時間,因為m2eclipse需要掃描原型目錄。

  3. 從菜單中選擇com.adobe.granite.archetypes : sample-project-archetype : <highest-number>,然後按一下​Next

    選取原型版本

  4. 為範例專案提供下列欄位:

    • 名稱
    • 群組Id
    • 工件ID
    • appId — 您可能需要展開進階 ​選項才能設定此值。
    • appTitle — 您可能需要展開進階 ​選項才能設定此值。
    • 套件 — 您可能需要展開進階 ​選項才能設定此值。

    定義原型屬性

  5. 按一下​下一步

  6. 接著,您可以設定AEM伺服器,讓Eclipse連線至該伺服器。

    若要使用除錯程式功能,您必須以除錯模式啟動AEM — 這可以透過將下列項目新增至命令列來達成:

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

    連線至AEM伺服器

  7. 按一下​完成。 項目結構隨即建立。

    注意

    在全新安裝中(更具體地說,當從未下載過maven相依性時),您可能會收到建立有錯誤的專案。 在這種情況下,請按照解決無效項目定義中描述的過程操作。

如何導入現有項目

您可以使用​新建項目​功能為您建立正確的結構:

  1. 請依照指示建立範例多模組專案,並為您建立下列專案,以便妥善分離關注點:

    • PROJECT.ui.apps/apps/etc
    • PROJECT.ui.content/content 製作
    • PROJECT.core (當您想新增Java程式碼時,這些套件就會變得有趣)
    • PROJECT.it.launcherPROJECT.it.tests 整合測試
  2. PROJECT.ui.apps專案的內容替換為套件的appsetc資料夾:

    1. 在「項目資源管理器」面板中,展開PROJECT.ui.apps > src > main > content > jcr_root > apps
    2. 按一下右鍵apps資料夾,然後選擇​顯示在 > 系統資源管理器
    3. 刪除您現在應該看到的appsetc資料夾,並將其放置在內容包的appsetc資料夾中。
    4. 在Eclipse中,按一下右鍵PROJECT.ui.apps項目,然後選擇​刷新
  3. 然後對PROJECT.ui.content執行相同操作,並將其內容資料夾替換為其中一個包:

    1. 在「項目資源管理器」面板中,展開PROJECT.ui.content > src > main > content > jcr_root > content
    2. 按一下右鍵更深的內容資料夾,然後選擇​顯示在 -> 系統資源管理器
    3. 刪除您現在應該看到的內容資料夾,並將其放置在內容套件的內容資料夾中。
    4. 在Eclipse中,按一下右鍵PROJECT.ui.content項目,然後選擇​刷新
  4. 現在,您必須更新這兩個專案的filter.xml檔案,以對應至內容套件的內容。 為此,請在個別的文字/程式碼編輯器中開啟內容套件的META-INF/vault/filter.xml檔案。

    • 以下範例說明您的filter.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>
    
  5. 至於分割為兩個專案的套件內容,您也必須將這些篩選規則分割為兩個,並據以更新這兩個專案的filter.xml檔案。

    1. 在Eclipse中,開啟PROJECT.ui.apps/src/main/content/META-INF/filter.xml

    2. <workspaceFilter>元素的內容替換為以/apps/etc開頭的套件規則

      • 例如:

        <?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>
        
    3. 然後開啟PROJECT.ui.content/src/main/content/META-INF/filter.xml

    4. 將規則替換為以/content開頭的包。

      • 例如:

        <?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>
        
  6. 請務必儲存所有變更。 您現在可以將新內容同步至您的AEM例項。

  7. 在「伺服器」面板中,確定已啟動連接,如果未啟動連接。

  8. 按一下​清除並發佈​圖示。

完成後,您的套件應該會在執行個體上執行,而儲存時,任何變更都會自動同步至執行個體。

如果要從項目中重新生成包,請按一下右鍵PROJECT.ui.appsPROJECT.ui.content並選擇​運行方式 -> Maven安裝

您現在有一個目標資料夾,該資料夾已隨您的套件建立在內(例如PROJECT.ui.apps-0.0.1-SNAPSHOT.zip)。

疑難排解

解決無效的項目定義

要解析無效的依賴項,項目定義將按以下步驟進行:

  1. 選取所有已建立的專案。
  2. 按一下右鍵。
  3. 在上下文菜單中,選擇​Maven -> 更新項目
  4. 檢查​強制更新快照/版本
  5. 按一下​「確定」

Eclipse下載所需的相依性。 這可能需要一些時間。

更多資訊

適用於Eclipse網站的官方Apache Sling IDE工具可提供您實用的資訊:

  • 本檔案提供適用於Eclipse 使用手冊🔗的Apache Sling IDE工具,引導您了解AEM開發工具支援的整體概念、伺服器整合和部署功能。
  • 疑難排解區段
  • 已知問題清單

下列官方的Eclipse檔案可協助您設定環境:

本頁內容