AEM Sites环境中的创作模式错误处理差异

在较低级别的环境中,组件级别的失败将以内联方式显示,从而允许呈现页面的其余部分。 在更高的环境中,类似的错误会导致整个页面无法呈现。

描述 description

在Adobe Experience Manager Sites中,同一页面在创作模式下根据环境显示不同的错误处理行为。 在较低级别的环境中,组件级别的失败将以内联方式显示,从而允许呈现页面的其余部分。 在更高的环境中,类似的错误会导致整个页面无法呈现或变得不可创作,即使各个环境中的代码库都相同。

环境

Adobe Experience Manager as a Cloud Service(所有版本)

症状

  • 在较低的环境中,组件错误会内联显示,并且页面会继续加载。
  • 在更高环境中,相同的错误会导致页面在创作模式下完全失败。
  • 根本原因通常是缺少组件类引用,这会在每个环境中引发异常,但生成的用户体验有所不同。

原因

此差异是由于WCMDeveloperModeFilter的默认配置造成的。 此过滤器在较低环境中启用,在较高环境中禁用。 启用后,它会捕获组件异常,并允许页面呈现内联错误消息。 在禁用时,组件异常会导致整个页面失败。

解决方法 resolution

按照以下步骤解决问题。

  1. 了解WCMDeveloperModeFilter行为:在较低的环境中,WCMDeveloperModeFilter默认处于启用状态。 它捕获组件异常并显示内联错误消息,允许呈现页面的其余部分。 在更高的环境中,过滤器默认处于禁用状态,因此组件异常会导致整个页面失败。
  2. 请勿在较低级别环境中禁用开发人员模式: Adobe建议在较低级别环境中保持启用开发人员模式,以帮助识别和修复组件错误,然后再将代码提升到较高环境。 在较低级别环境中禁用开发人员模式可能会隐藏组件级别的故障,导致更难以及早检测到问题。
  3. 检查开发人员模式状态:查看环境中com.day.cq.wcm.core.impl.WCMDeveloperModeFilter的配置。 配置文件通常名为com.day.cq.wcm.core.impl.WCMDeveloperModeFilter.cfg.json。 属性enabled应设置为false以禁用筛选器。 如果文件不存在或enabled未设置为false,则默认情况下在较低环境中启用开发人员模式。
  4. 使用AEM编辑器侧面板中的 错误 选项卡查看组件级问题。 只有管理员组的成员才能访问开发人员模式。
  5. 作为最佳实践,开发人员应在将代码升级到更高环境之前,在较低环境中使用开发人员模式来识别和解决组件错误。

更改配置后,在每个受影响的创作环境中测试包含已知组件错误的页面,以确认预期的错误处理行为。

相关阅读

recommendation-more-help
experience-cloud-kcs-help-kbarticles