适用于 Eclipse 的 AEM 开发人员工具 aem-developer-tools-for-eclipse

Experience ManagerEclipse徽标的开发人员工具

概述 overview

适用于Eclipse的Experience Manager开发人员工具 ​是一个基于Apache许可证2下发布的适用于Apache Sling🔗的Eclipse插件的Eclipse插件。

它提供了几项使AEM开发更轻松的功能:

  • 通过Eclipse服务器连接器与AEM实例无缝集成
  • 内容和OSGi捆绑包的同步
  • 使用代码热插拔功能调试支持
  • 通过特定项目创建向导简单BootstrapAEM项目
  • 轻松编辑JCR属性

要求 requirements

在使用AEM Developer Tools之前,您需要:

  • 下载并安装适用于Enterprise Java™开发人员的Eclipse IDE
  • 按照Eclipse常见问题解答中的说明,通过编辑eclipse.ini配置文件来配置Eclipse安装,确保您至少有1 GB的栈内存。
NOTE
在macOS上,您需要右键单击​ Eclipse.app,然后选择​ 显示包内容 ​以查找您的​eclipse.ini

如何安装适用于Eclipse的AEM开发人员工具 how-to-install-the-aem-developer-tools-for-eclipse

当您满足上述要求后,可以按如下方式安装插件:

  1. 打开AEM Developer Tools网站

  2. 复制​ 安装链接

    或者,您可以下载归档文件,而不是使用安装链接。 此方法允许脱机安装,但您不会以这种方式接收未通过自动更新通知。

  3. 在Eclipse中,打开​ 帮助 ​菜单。

  4. 单击​ 安装新软件

  5. 单击​ 添加……

  6. 在​ 名称 ​字段中,输入AEM Developer Tools

  7. 在​ 位置 ​字段中,复制安装URL。

  8. 单击​ 添加

  9. 检查​ AEM ​和​ Sling ​插件。

  10. 单击​ 下一步

  11. 在​ 安装详细信息 ​窗口中,再次单击​ 下一步

  12. 接受许可协议,然后单击​ 完成

  13. 单击​ 立即重新启动 ​以重新启动Eclipse。

AEM视角 the-aem-perspective

在Eclipse中,透视可确定窗口内可用的操作和视图,并支持与Eclipse中的资源进行面向任务的交互。 有关透视的更多详细信息,请参阅Eclipse文档。

Eclipse的Experience Manager开发工具 ​提供了AEM Perspective,可让您完全控制AEM项目和实例。 要打开AEM Perspective,请执行以下操作:

  1. 从Eclipse菜单栏中选择​ 窗口 > 透视 > 打开透视 > 其他
  2. 在对话框中选择​ AEM,然后单击​ 打开

Eclipse中的AEM透视

示例多模块项目 sample-multi-module-project

适用于Eclipse的Experience Manager开发人员工具 ​附带了一个示例的多模块项目,可帮助您快速掌握Eclipse中的项目设置。 它还可用作几项AEM功能的最佳实践指南。 了解有关项目原型的更多信息

按照以下步骤创建示例项目:

  1. 在​ 文件 > 新建 > 项目 ​菜单中,浏览到​ AEM ​部分并选择​ AEM示例多模块项目

    AEM示例多模块项目

  2. 单击​ 下一步

    note note
    NOTE
    此步骤可能需要花些时间,因为m2eclipse必须扫描原型目录。
  3. 从菜单中选择com.adobe.granite.archetypes : sample-project-archetype : <highest-number>,然后单击​ 下一步

    选择原型版本

  4. 为示例项目提供以下字段:

    • 名称
    • 组ID
    • 项目ID
    • appId — 您可能需要展开​ 高级 ​选项来设置此值。
    • appTitle — 您可能需要展开​ 高级 ​选项以设置此值。
    • — 您可能需要展开​ 高级 ​选项来设置此值。

    定义原型属性

  5. 单击​ 下一步

  6. 然后,配置Eclipse连接的AEM服务器。

    要使用Debugger功能,您需要以调试模式启动AEM — 这可以通过在命令行中添加以下内容来实现:

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

    连接到AEM服务器

  7. 单击​ 完成。 将创建项目结构。

    note note
    NOTE
    在全新安装中(更具体地说,当从未下载maven依赖项时),您可能会创建项目,但出现错误。 在这种情况下,请按照解析无效项目定义中所述的过程操作。

如何导入现有项目 how-to-import-existing-projects

您可以使用​ 新建项目 ​功能为您创建正确的结构:

  1. 按照说明创建示例多模块项目,您已为您创建了以下项目,这些项目允许健康地分离问题:

    • /apps/etc内容的PROJECT.ui.apps
    • 已创作的/contentPROJECT.ui.content
    • Java™捆绑包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文件外观的示例:
    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>
    
  5. 对于已拆分为两个项目的包内容,还必须将这些筛选规则拆分为两个并相应地更新两个项目的filter.xml文件。

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

    2. <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>
        
    3. 然后打开PROJECT.ui.content/src/main/content/META-INF/filter.xml

    4. 将规则替换为以/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>
        
  6. 确保保存所有更改。 您现在可以将该新内容同步到您的AEM实例。

  7. 在“服务器”面板中,确保连接已启动,如果未启动,则确保连接已启动。

  8. 单击​ 清理和Publish ​图标。

完成后,您应在实例上运行包,保存后,任何更改都会自动同步到实例。

如果要从项目中重新生成包,请右键单击PROJECT.ui.appsPROJECT.ui.content,然后选择​ 运行方式 > Maven安装

现在,您已经创建了一个目标文件夹,其中包含了您的包(例如,PROJECT.ui.apps-0.0.1-SNAPSHOT.zip)。

疑难解答 troubleshooting

解析无效的项目定义 resolving-invalid-project-definition

要解决无效依赖项和项目定义,请按照以下步骤操作:

  1. 选择所有已创建的项目。
  2. 右键单击。
  3. 在上下文菜单中,选择​ Maven > 更新项目
  4. 检查​ 强制更新快照/版本
  5. 单击​ 确定

Eclipse下载所需的依赖项。 这可能需要花些时间。

更多信息 more-information

适用于Eclipse网站的官方Apache Sling IDE工具为您提供有用信息:

以下官方Eclipse文档可以帮助设置环境:

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab