设置本地 AEM SDK

上次更新: 2024-01-26
  • 创建对象:
  • Beginner
    Developer

Adobe Experience Manager (AEM) 可以使用 AEM as a Cloud Service SDK 的快速入门 Jar 在本地运行。这样开发人员即可先部署到和测试自定义代码、配置和内容,然后再将它提交到源代码管理以及将它部署到 AEM as a Cloud Service 环境。

请注意 ~ 用作用户目录的简写。 在Windows中,这等同于 %HOMEPATH%.

安装Java™

Experience Manager是一种Java™应用程序,因此需要OracleJava™ SDK支持开发工具。

  1. 下载并安装最新的Java™ SDK 11
  2. 通过运行以下命令验证是否安装了OracleJava™ 11 SDK:
$ java --version
$ java -version
$ java --version

Java

下载AEMas a Cloud ServiceSDK

AEMas a Cloud ServiceSDK(或AEM SDK)包含用于在本地运行AEM创作和发布以进行开发的快速入门Jar,以及兼容版本的Dispatcher工具。

  1. 登录 https://experience.adobe.com/#/downloads 使用您的Adobe ID
    • 请注意,您的Adobe组织 必须 配置AEMas a Cloud Service以下载AEMas a Cloud ServiceSDK。
  2. 导航至 AEMas a Cloud Service 选项卡
  3. 排序方式 发布日期降序 订购
  4. 单击最新的 AEM SDK 结果行
  5. 查看并接受EULA ,然后点击 下载 按钮

从AEM SDK zip文件中提取快速入门Jar

  1. 解压缩下载的 aem-sdk-XXX.zip 文件

设置本地AEM创作服务

本地AEM创作服务为开发人员提供了一个本地体验,数字营销人员/内容作者可以共享该体验来创建和管理内容。 AEM Author Service设计作为创作和预览环境,允许可以针对它执行大多数功能开发验证,使其成为本地开发过程的重要元素。

  1. 创建文件夹 ~/aem-sdk/author

  2. 复制 快速入门JAR 文件到 ~/aem-sdk/author 并将其重命名为 aem-author-p4502.jar

  3. 通过从命令行执行以下命令来启动本地AEM Author Service:

    • java -jar aem-author-p4502.jar
      • 提供管理员密码作为 admin. 可接受任何管理员密码,但建议对本地开发使用默认密码以减少重新配置的需要。

    无法 启动AEM作为Cloud Service快速入门Jar 通过双击.

  4. 访问本地AEM创作服务,网址为 http://localhost:4502 在Web浏览器中

$ mkdir -p ~/aem-sdk/author
$ cp aem-sdk-Quickstart-XXX.jar ~/aem-sdk/author/aem-author-p4502.jar
$ cd ~/aem-sdk/author
$ java -jar aem-author-p4502.jar
$ mkdir -p c:\Users\<My User>\aem-sdk\author
$ copy aem-sdk-Quickstart-XXX.jar c:\Users\<My User>\aem-sdk\author\aem-author-p4502.jar
$ cd c:\Users\<My User>\aem-sdk\author
$ java -jar aem-author-p4502.jar
$ mkdir -p ~/aem-sdk/author
$ cp aem-sdk-Quickstart-XXX.jar ~/aem-sdk/author/aem-author-p4502.jar
$ cd ~/aem-sdk/author
$ java -jar aem-author-p4502.jar

设置本地AEM Publish服务

本地AEM Publish Service为开发人员提供了AEM的本地体验最终用户,例如浏览基于AEM的网站。 本地AEM发布服务非常重要,因为它与AEM SDK的集成 Dispatcher工具 并允许开发人员对面向最终用户的体验进行抽烟测试和微调。

  1. 创建文件夹 ~/aem-sdk/publish

  2. 复制 快速入门JAR 文件到 ~/aem-sdk/publish 并将其重命名为 aem-publish-p4503.jar

  3. 通过从命令行执行以下操作来启动本地AEM Publish Service:

    • java -jar aem-publish-p4503.jar
      • 提供管理员密码作为 admin. 可接受任何管理员密码,但建议对本地开发使用默认密码以减少重新配置的需要。

    无法 启动AEM作为Cloud Service快速入门Jar 通过双击.

  4. 访问本地AEM发布服务,网址为 http://localhost:4503 在Web浏览器中

$ mkdir -p ~/aem-sdk/publish
$ cp aem-sdk-Quickstart-XXX.jar ~/aem-sdk/publish/aem-publish-p4503.jar
$ cd ~/aem-sdk/publish
$ java -jar aem-publish-p4503.jar
$ mkdir -p c:\Users\<My User>\aem-sdk\publish
$ copy aem-sdk-Quickstart-XXX.jar c:\Users\<My User>\aem-sdk\publish\aem-publish-p4503.jar
$ cd c:\Users\<My User>\aem-sdk\publish
$ java -jar aem-publish-p4503.jar
$ mkdir -p ~/aem-sdk/publish
$ cp aem-sdk-Quickstart-XXX.jar ~/aem-sdk/publish/aem-publish-p4503.jar
$ cd ~/aem-sdk/publish
$ java -jar aem-publish-p4503.jar

在预发行模式中设置本地AEM服务

可以在中启动本地AEM运行时 预发行模式 允许开发人员针对AEMas a Cloud Service的下一个版本的功能进行构建。 通过传递 -r prerelease 本地AEM运行时的第一个启动时的参数。 这可以同时用于本地AEM Author和AEM Publish服务。

# For AEM Author service in prerelease mode
$ java -jar aem-author-p4502.jar -r prerelease

# For AEM Publish service in prerelease mode
$ java -jar aem-publish-p4503.jar -r prerelease
# For AEM Author service in prerelease mode
$ java -jar aem-author-p4502.jar -r prerelease

# For AEM Publish service in prerelease mode
$ java -jar aem-publish-p4503.jar -r prerelease
# For AEM Author service in prerelease mode
$ java -jar aem-author-p4502.jar -r prerelease

# For AEM Publish service in prerelease mode
$ java -jar aem-publish-p4503.jar -r prerelease

模拟内容分发

在真实的Cloud Service环境中,使用将内容从Author服务分发到Publish服务 Sling内容分发 和Adobe管道。 此 Adobe管道 是一个仅在云环境中可用的独立微服务。

在开发期间,可能需要使用本地Author和Publish服务模拟内容的分发。 这可以通过启用旧版复制代理来实现。

注意

复制代理只能在本地Quickstart JAR中使用,并且只能提供内容分发的模拟。

  1. 登录到 作者 服务并导航到 http://localhost:4502/etc/replication/agents.author.html.

  2. 单击 默认代理(发布) 以打开默认复制代理。

  3. 单击 编辑 以打开代理的配置。

  4. 设置 选项卡,更新以下字段:

    • 已启用 — 检查true
    • 代理用户ID — 将此字段留空

    复制代理配置 — 设置

  5. 传输 选项卡,更新以下字段:

    • URI - http://localhost:4503/bin/receive?sling:authRequestLogin=1
    • 用户 - admin
    • 密码 - admin

    复制代理配置 — 传输

  6. 单击 确定 保存配置并启用 默认 复制代理。

  7. 您现在可以更改Author服务上的内容并将其发布到Publish服务。

发布页面

快速入门Jar启动模式

快速入门Jar的命名, aem-<tier>_<environment>-p<port number>.jar 指定启动方式。 AEM在特定层、创作层或发布层启动后,无法更改为备用层。 要执行此操作, crx-Quickstart 必须删除首次运行时生成的文件夹,并且必须再次运行快速入门Jar。 可以更改环境和端口,但是它们需要停止/启动本地AEM实例。

不断变化的环境, devstageprod,对于开发人员而言,能够确保AEM正确定义并解析特定于环境的配置。 建议主要针对默认情况执行本地开发 dev 环境运行模式。

可用的排列如下:

快速入门Jar文件名 模式描述
aem-author-p4502.jar 作为作者,在端口4502上处于开发运行模式
aem-author_dev-p4502.jar 作为作者,在端口4502上处于开发运行模式(与 aem-author-p4502.jar)
aem-author_stage-p4502.jar 作为作者,在端口4502上处于暂存运行模式
aem-author_prod-p4502.jar 作为作者,在端口4502上处于生产运行模式
aem-publish-p4503.jar 在端口4503上以开发运行模式作为发布
aem-publish_dev-p4503.jar 在端口4503上作为开发运行模式下的发布(与 aem-publish-p4503.jar)
aem-publish_stage-p4503.jar 在端口4503上以暂存运行模式作为发布
aem-publish_prod-p4503.jar 在端口4503上以生产运行模式作为发布

请注意,端口号可以是本地开发计算机上的任何可用端口,但按照惯例可以:

  • 端口 4502 用于 本地AEM Author服务
  • 端口 4503 用于 本地AEM Publish服务

更改这些配置文件可能需要调整AEM SDK配置

停止本地AEM运行时

要停止本地AEM运行时(AEM Author或Publish服务),请打开用于启动AEM运行时的命令行窗口,然后点击 Ctrl-C. 等待AEM关闭。 当关闭过程完成时,命令行提示符可用。

可选的本地AEM运行时设置任务

何时更新快速入门Jar

在每月的最后一个星期四或之后不久,至少每月更新AEM SDK,这是AEMas a Cloud Service“功能发布”的发布节奏。

警告

将快速入门Jar更新为新版本需要替换整个本地开发环境,从而导致本地AEM存储库中所有代码、配置和内容丢失。 确保任何不应销毁的代码、配置或内容都会安全提交到Git,或从本地AEM实例导出为AEM包。

如何避免在升级AEM SDK时丢失内容

升级AEM SDK会有效地创建一个全新的AEM运行时,其中包括一个新的存储库,这意味着对先前AEM SDK的存储库所做的任何更改都将丢失。 以下是帮助在AEM SDK升级之间保留内容的可行策略,可以单独或一致使用:

  1. 创建一个专门用于包含“示例”内容的内容包,以帮助进行开发,并在Git中对其进行维护。 任何应通过AEM SDK升级保留的内容将保留在此包中,并在升级AEM SDK后重新部署。
  2. 使用 oak-upgrade 使用 includepaths 指令,将内容从之前的AEM SDK存储库复制到新的AEM SDK存储库。
  3. 使用以前的AEM SDK上的AEM包管理器和内容包备份任何内容,并在新的AEM SDK上重新安装它们。

请记住,在AEM SDK升级之间使用上述方法维护代码,表明开发存在反模式。 非一次性代码应源自开发IDE,并通过部署流入AEM SDK。

疑难解答

双击快速入门Jar文件会导致错误

双击快速入门Jar启动时,显示错误模式,阻止AEM本地启动。

故障排除 — 双击“快速入门Jar”文件

这是因为AEMas a Cloud Service快速入门Jar不支持双击快速入门Jar以本地启动AEM。 相反,必须从该命令行运行Jar文件。

要启动AEM Author服务, cd 进入包含Quickstart Jar的目录并执行命令:

$ java -jar aem-author-p4502.jar
$ java -jar aem-author-p4502.jar
$ java -jar aem-author-p4502.jar

或者,要启动AEM Publish服务, cd 进入包含Quickstart Jar的目录并执行命令:

$ java -jar aem-publish-p4503.jar
$ java -jar aem-publish-p4503.jar
$ java -jar aem-publish-p4503.jar

从命令行启动快速入门Jar会立即中止

从命令行启动快速入门Jar时,进程立即中止,AEM服务未启动,并出现以下错误:

➜  ~/aem-sdk/author: java -jar aem-author-p4502.jar
Loading quickstart properties: default
Loading quickstart properties: instance
java.lang.Exception: Quickstart requires a Java Specification 11 VM, but your VM (Java HotSpot(TM) 64-Bit Server VM / Oracle Corporation) reports java.specification.version=1.8
  at com.adobe.granite.quickstart.base.impl.Main.checkEnvironment(Main.java:1046)
  at com.adobe.granite.quickstart.base.impl.Main.<init>(Main.java:646)
  at com.adobe.granite.quickstart.base.impl.Main.main(Main.java:981)
Quickstart: aborting

这是因为AEMas a Cloud Service需要Java™ SDK 11,而您运行的是其他版本,很可能是Java™ 8。 要解决此问题,请下载并安装 oracleJava™ SDK 11.

安装OracleJava™ 11 SDK后,通过从命令行运行命令来验证它是活动版本:

$ java --version
$ java -version
$ java --version

其他资源

在此页面上