自定义错误页面

上次更新: 2023-11-18

AEM附带了用于处理HTTP错误的标准错误处理程序;例如,通过显示:

标准错误消息

为了响应错误,AEM提供了 404.jsp 下的脚本 /libs/sling/servlet/errorhandler.

小贴士

由于AEM基于Apache Sling,因此提供了更多信息 (在Apache错误处理文档中)。

注意

在创作实例上, CQ WCM调试过滤器 默认处于启用状态。 这始终导致响应代码200。 默认错误处理程序通过向响应写入完整栈栈跟踪来响应。

在发布实例上,CQ WCM调试过滤器为 始终 已禁用(即使配置为已启用)。

如何自定义错误处理程序显示的页面

您可以开发自己的脚本,以自定义遇到错误时错误处理程序显示的页面。 为此,请使用 AEM标准叠加机制 以便您的自定义页面创建在 /apps 并覆盖下的默认页面 /libs.

  1. 在存储库中,复制默认脚本:

    • /libs/sling/servlet/errorhandler/
    • /apps/sling/servlet/errorhandler/

    默认情况下,目标路径不存在,因此,在首次执行该操作时,您需要创建该路径。

  2. 导航到 /apps/sling/servlet/errorhandler。在此,您可以:

    • 编辑相应的现有脚本以提供所需的信息。 或者
    • 为所需代码创建和编辑新脚本。
  3. 保存更改并进行测试。

注意

404.jsp 脚本已专门设计用于满足AEM身份验证;特别是允许在出现这些错误时进行系统登录。

因此,替换此脚本时应非常小心。

自定义对HTTP 500错误的响应

HTTP 500内部服务器错误 表示服务器端错误,例如服务器遇到阻止其完成请求的意外情况。

当请求处理导致异常时,Apache Sling框架(AEM构建于之上):

  • 记录异常
  • 并在响应正文中返回:
    • HTTP响应代码500
    • 异常栈栈跟踪

自定义错误处理程序显示的页面 a 500.jsp 可以创建脚本。 但是,它仅在 HttpServletResponse.sendError(500) 显式执行;即从异常捕获器执行。

否则,响应代码将设置为500,但 500.jsp 不执行脚本。

要处理500个错误,错误处理程序脚本的文件名必须与异常类(或超类)相同。 要处理所有此类例外,您可以创建脚本 /apps/sling/servlet/errorhandler/Throwable.jsp/apps/sling/servlet/errorhandler/Exception.jsp.

注意

在AEMCloud Service中,当从后端收到5XX错误时,CDN会提供一个通用错误页面。 要允许后端的实际响应通过,您需要将以下标头添加到响应: x-aem-error-pass: true.
这仅适用于来自AEM或Apache/Dispatcher层的响应。 来自中间基础架构层的其他意外错误仍会显示常规错误页面。

注意

在创作实例上, CQ WCM调试过滤器 默认处于启用状态。 这始终导致响应代码200。 默认错误处理程序通过向响应写入完整栈栈跟踪来响应。

对于自定义错误处理程序,需要代码为500的响应,因此 必须禁用CQ WCM调试过滤器. 这可确保返回响应代码500,这反过来会触发正确的Sling错误处理程序。

在发布实例上,CQ WCM调试过滤器为 始终 已禁用(即使配置为已启用)。

在此页面上