在AEM自适应Forms中添加自定义错误处理程序 error-handlers-in-adaptive-form

AEM Forms 为表单提交提供现成的成功和错误处理程序。它还提供用于自定义错误处理函数的功能。例如，可在后端为特定的错误代码调用自定义工作流或通知客户服务已停止。处理程序是根据服务器响应执行的客户端函数。在使用 API 调用外部服务时，数据会传输到服务器以进行验证，这会向客户端返回响应，其中包含有关提交的成功或错误事件的信息。该信息作为参数传递给相关处理程序以执行该函数。错误处理程序可帮助管理和显示遇到的错误或验证问题。

自适应表单根据预设验证标准验证您在字段中提供的输入，并检查为调用外部服务而配置的 REST 端点所返回的各种错误。您可以根据用于自适应表单的数据源设置验证标准。例如，如果您使用 RESTful Web 服务作为数据源，则可以在 Swagger 定义文件中定义验证标准。

如果输入值满足验证标准，则将值提交到数据源，否则自适应表单将使用错误处理程序显示错误消息。与此方法类似，自适应表单与自定义错误处理程序集成以执行数据验证。如果输入值未满足验证标准，错误消息将在自适应表单的字段级别显示。当服务器返回的验证错误消息采用标准消息格式时，会发生此情况。

错误处理程序的用途 uses-of-error-handler

错误处理程序具有多种用途。下面列出了错误处理程序函数的一些用途：

失败/错误响应格式 failure-response-format

如果服务器验证错误消息采用以下标准格式，则自适应表单会在字段级别显示错误。
以下代码说明了现有的失败响应结构：

   {
    errorCausedBy : "SERVER_SIDE_VALIDATION/SERVICE_INVOCATION_FAILURE"
    errors : [
        {
             somExpression  : <somexpr>
             errorMessage / errorMessages : <validationMsg> / [<validationMsg>, <validationMsg>]
        }
    ]
    originCode : <target error Code>
    originMessage : <unstructured error message returned by service>
    }

其中：

随着 AEM Forms 版本的功能改进和后续更新，现有的失败响应结构变成了基于 RFC7807 的新格式，可向后兼容现有的失败响应结构：

    {
        "type": "SERVER_SIDE_VALIDATION/FORM_SUBMISSION/SERVICE_INVOCATION/FAILURE/VALIDATION_ERROR", (required)
        "title": "Server side validation failed/Third party service invocation failed", (optional)
        "detail": "", (optional)
        "instance": "", (optional)
        "validationErrors" : [ (required)
            {
                "fieldName":"<SOM expression of the field whose data sent is invalid>",
                "dataRef":<JSONPath (or XPath) of the data element which is invalid>
                "details": ["Error Message(s) for the field"] (required)

            }
        ],
        "originCode": <Origin http status code>, (optional - in case of SERVER_SIDE_VALIDATION)
        "originMessage" : "<unstructured error message returned by service>" (optional - in case of SERVER_SIDE_VALIDATION)
    }

其中：

错误响应格式示例 sample-error-response-format

用于显示错误响应的一些选项是：

使用规则编辑器添加错误处理程序 add-error-handler-using-rule-editor

通过使用规则编辑器的调用服务操作，可以根据用于自适应表单的数据源来定义验证标准。如果您使用 RESTful Web 服务作为数据源，则可以在 Swagger 定义文件中定义验证标准。通过在自适应表单中使用错误处理函数和规则编辑器，可以有效地管理和自定义错误处理。可以使用规则编辑器定义条件，并配置在触发规则时要执行的所需操作。自适应表单根据预设验证标准验证您在字段中输入的信息。如果输入值未达到验证标准，则将在自适应表单的字段级别显示错误消息。

利用规则编辑器，您可以：

添加默认错误处理程序函数 add-default-errror-handler

如果错误响应处于标准架构或服务器端验证失败，则支持默认错误处理程序以在字段上显示错误消息。
为了了解如何通过规则编辑器的调用服务操作来使用默认错误处理程序，以具有​ 宠物 ID 和​ 宠物名称 ​这两个字段的简单自适应表单为例，并在​ 宠物 ID 字段上使用默认错误处理程序，以检查为调用外部服务而配置的 REST 端点所返回的各种错误，例如 200 - OK、404 - Not Found、400 - Bad Request。要使用规则编辑器的调用服务操作添加默认错误处理程序，请执行以下步骤：

根据此规则，将使用 REST 端点所调用的外部服务针对您为​ 宠物 ID 输入的值来检查验证​ 宠物名称。如果未达到基于数据源的验证标准，错误消息将在字段级别显示。

添加自定义错误处理程序函数

您可以添加自定义错误处理程序函数来执行一些操作，例如：

除了提及的操作之外，自定义错误处理程序还可用于执行满足特定用户要求的自定义函数。

自定义错误处理程序是一个函数（客户端库），旨在响应由外部服务返回的错误并向最终用户提供自定义响应。任何带注释 @errorHandler 的客户端库均被视为自定义错误处理程序函数。该注释有助于识别 .js 文件中指定的错误处理程序函数。
为了了解如何通过规则编辑器的调用服务操作来创建和使用自定义错误处理程序，我们以具有​ 宠物 ID 和​ 宠物名称 ​这两个字段的简单自适应表单为例，并在​ 宠物 ID 字段上使用自定义错误处理程序，以检查为调用外部服务而配置的 REST 端点所返回的各种错误，例如 200 - OK、404 - Not Found、400 - Bad Request。

要在自适应表单中添加和使用自定义错误处理程序，请执行以下步骤：

1.添加错误处理程序的自定义函数

要了解如何添加自定义函数，请单击在基于核心组件的自适应表单中创建自定义函数。

成功执行管道后，便能在自适应表单规则编辑器中使用自定义错误处理程序。现在，让我们了解如何使用 AEM Forms 中规则编辑器的调用服务来配置和使用自定义错误处理程序。

2. 使用规则编辑器配置自定义错误处理程序 use-custom-error-handler

在自适应表单中实施自定义错误处理程序之前，请确保​ 客户端库类别 ​中的客户端库名称与 .content.xml 文件的类别选项中指定的名称一致。

在这种情况下，客户端库名称在.content.xml文件中提供为customfunctionsdemo。

要通过​ 规则编辑器的调用服务 ​操作使用自定义错误处理程序，请执行以下操作：

根据此规则，将使用 REST 端点所调用的外部服务针对您为​ 宠物 ID 输入的值来检查验证​ 宠物名称。如果未达到基于数据源的验证标准，错误消息将在字段级别显示。

打开浏览器控制台，并检查从 REST 服务端点接收的响应和标头中是否有验证错误消息。

自定义错误处理程序函数负责根据错误响应来执行其他操作，例如显示模式对话框或发送分析事件。利用自定义错误处理程序函数，可以灵活地处理错误以满足具体用户要求。

另请参阅 see-also