适用于 Eclipse 的 AEM 开发人员工具

概述

AEM Developer Tools for Eclipse是一个基于 适用于Apache Sling的Eclipse插件 已根据Apache许可证2发布。

它提供了以下几项功能,可简化AEM开发:

  • 通过Eclipse Server Connector与AEM实例无缝集成
  • 内容和OSGi包的同步
  • 具有代码热交换功能的调试支持
  • 通过特定项目创建向导简单引导AEM项目
  • 轻松编辑JCR属性

要求

在使用AEM开发人员工具之前,您需要:

注意

在macOS上,您需要右键单击 Eclipse.app 然后选择 显示包内容 以找到 eclipse.ini.

如何安装AEM Developer Tools for Eclipse

当您完成 要求 在上面,您可以按如下方式安装插件:

  1. 打开 AEM Developer Tools网站.

  2. 复制 安装链接.

    请注意,或者,您也可以下载存档文件,而不是使用安装链接。 这允许离线安装,但您将无法通过这种方式接收自动更新通知。

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

  4. 单击 安装新软件.

  5. 单击 添加…….

  6. 名称 enter AEM Developer Tools.

  7. 位置 复制安装URL。

  8. 单击​添加

  9. 同时检查 AEMSling 插件。

  10. 单击​下一步

  11. 安装详细信息 窗口,单击 下一个 再次。

  12. 接受许可协议并单击 完成.

  13. 单击 RestartNow 以便重新启动Eclipse。

AEM透视

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

AEM Development Tools for Eclipse提供了AEM Perspective,它使您能够完全控制AEM项目和实例。 要打开AEM透视图,请执行以下操作:

  1. 从Eclipse菜单栏中,选择 窗口 -> 透视 -> 开放透视 -> 其他.
  2. 选择 AEM ,然后单击 打开.

Eclipse中的AEM视角

示例多模块项目

AEM Developer Tools for Eclipse附带一个示例的多模块项目,该项目可帮助您快速掌握Eclipse中项目设置的速度,并且是一些AEM功能的最佳实践指南。 进一步了解项目原型.

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

  1. 文件 > 新建 > 项目 菜单,浏览到 AEM 选择 AEM多模块项目示例.

    AEM多模块项目示例

  2. 单击​下一步

    注意

    此步骤可能需要一些时间,因为m2eclipse需要扫描原型目录。

  3. 选择 com.adobe.granite.archetypes : sample-project-archetype : <highest-number> ,然后单击 下一个.

    选择原型版本

  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 并将其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. 在上下文菜单中,选择 马文 -> 更新项目.
  4. 检查 强制更新快照/版本.
  5. 单击​确定

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

更多信息

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

以下官员 Eclipse 文档可帮助设置您的环境:

在此页面上