最適化表單中的錯誤處理常式 (核心元件) error-handlers-in-adaptive-form

版本
文章連結
AEM as a Cloud Service
按一下這裡
AEM 6.5
本文章

AEM Forms 為表單提交提供現成可用的成功和錯誤處理常式。這還可提供自訂錯誤處理常式函數的功能。例如,您可以針對特定錯誤程式碼在後端叫用自訂的工作流程,或通知客戶服務已關閉。處理常式是根據伺服器回應執行的用戶端函數。當使用 API 調用外部服務時,資料會傳輸至伺服器進行驗證,伺服器會向用戶端傳回回應,其中包含有關提交成功或錯誤事件的資訊。這項資訊可以參數傳遞至相關處理常式以執行該函數。錯誤處理常式有助於管理和顯示遇到的錯誤或驗證問題。

錯誤處理常式工作流程,可了解如何在表單中新增自訂錯誤處理程序

最適化表單會根據預設的驗證標準來驗證您在欄位中輸入的數值,並查看為調用外部服務所設定 REST 端點傳回的各種錯誤。您可以根據與最適化表單一起使用的資料來源設定驗證標準。例如,如果您以資料來源來使用 RESTful Web 服務,則可以在 Swagger 定義檔案中定義驗證標準。

如果輸入值符合驗證標準,則將輸入值提交到資料來源,否則最適化表單會使用錯誤處理常式來顯示錯誤訊息。與此方法類似,最適化表單會與自定義錯誤處理常式整合以執行資料驗證。如果輸入值不符合驗證標準,則錯誤訊息會在最適化表單的欄位層級來顯示。當伺服器傳回的驗證錯誤訊息採用標準訊息格式時,就會發生這種情況。

錯誤處理常式的用途 uses-of-error-handler

錯誤處理常式有多種用途。下面列出了錯誤處理常式函數的一些用途:

  • 執行驗證:錯誤處理首先會根據預定義的規則或標準來驗證使用者的輸入值。當用戶填寫最適化表單時,錯誤處理常式會驗證輸入值,以確保符合規定的格式、長度或任何其他限制。

  • 提供即時意見回饋:當檢測到任何錯誤時,錯誤處理常式會立即向使用者顯示意見回饋,例如對應表單欄位下方的內聯錯誤訊息。此意見回饋可幫助使用者識別並糾正錯誤,而無需提交表單並等待回應。

  • 顯示錯誤訊息:當最適化表單提交遇到任何驗證錯誤時,錯誤處理常式會顯示正確的錯誤訊息。錯誤訊息應該清晰、簡潔,並醒目顯示需要注意的特定欄位。

  • 醒目顯示錯誤欄位:為了吸引用戶注意特定的不正確欄位,錯誤處理常式會醒目顯示或以視覺效果區分相應的欄位。執法方法是改變背景顏色、新增圖示或邊框或,或新增任何有助使用者快速找出和解決錯誤的其他視覺提示。

失敗/錯誤回應格式 failure-response-format

如果伺服器驗證錯誤訊息採用以下標準格式,則最適化表單會在欄位層級顯示錯誤。
以下代碼旨在解說現有失敗回應的結構:

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

其中:

  • errorCausedBy 說明失敗的原因。
  • errors 提及未通過驗證條件的欄位之合格欄位名稱以及驗證錯誤訊息。
  • originCode 由 AEM 新增的欄位,並包含外部服務傳回的 http 狀態代碼。
  • originMessage由 AEM 新增的欄位,並包含外部服務傳回的原始錯誤資料。

隨著 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":"<qualified fieldname 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 - if there is SERVER_SIDE_VALIDATION)
        "originMessage" : "<unstructured error message returned by service>" (optional - if there is SERVER_SIDE_VALIDATION)
    }
NOTE
  • 確保錯誤回應結構包括 fieldNamedataRef
  • 確保 ContentType 標頭是 應用程式/問題+json

其中:

  • type (required) 是指定失敗類型。這可以是以下其中一個值:

    • SERVER_SIDE_VALIDATION 是指由於伺服器端驗證的失敗。
    • FORM_SUBMISSION 是指表單提交期間的失敗
    • SERVICE_INVOCATION 是指第三方服務調用期間的失敗。
    • FAILURE 是指一般失敗。
    • VALIDATION_ERROR 是指由於驗證錯誤的失敗。
  • title (optional) 會提供失敗的標題或簡要說明。

  • detail (optional) 會提供有關失敗的其他詳細資訊 (若需要)。

  • instance (optional) 會表示與失敗相關的執行個體或識別碼,有助於追蹤或識別失敗的具體情況。

  • validationErrors (required) 包含有關驗證錯誤的資訊。其中包含下列欄位:

    • fieldname 提及未通過驗證標準欄位的合資格欄位名稱。
    • dataRef 表示驗證失敗欄位的 JSON 路徑或 XPath。
    • details 包含帶有錯誤欄位的驗證錯誤訊息。
  • originCode (optional) 由 AEM 新增的欄位,並包含外部服務傳回的 http 狀態代碼

  • originMessage (optional)由 AEM 新增的欄位,並包含外部服務傳回的原始錯誤資料。

錯誤回應格式範例 sample-error-response-format

顯示錯誤回應的一些選項是:

以調適型單為主的 fieldName 屬性
  • Header: content-type:application/problem+json

  • Response:

    code language-javascript
            {
                "type": "VALIDATION_ERROR",
                "validationErrors": [
                {
                "fieldName": "$form.PetId",
                "dataRef": "",
                "details": [
                "Invalid ID supplied. Provided value is not correct!"
            ]
            }
            ]}
    
根據最適化表單dataRef屬性
  • Header: content-type:application/problem+json

  • Response:

    code language-javascript
        {
            "type": "VALIDATION_ERROR",
            "validationErrors": [
            {
                "fieldName": "",
                "dataRef": "$.Pet.id",
                "details": [
                "Invalid ID supplied. Provided value is not correct!"
                ]
                }
        ]}
    

先決條件 prerequisites

在最適化Forms中使用錯誤處理常式之前:

使用規則編輯器新增錯誤處理常式 add-error-handler-using-rule-editor

透過使用規則編輯器調用服務的動作,您可以根據與最適化表單一起使用的資料來源來定義驗證標準。如果您以資料來源來使用 RESTful Web 服務,則可以在 Swagger 定義檔案中定義驗證標準。透過使用最適化表單中的錯誤處理常式函數和規則編輯器,您可以有效地管理和自訂錯誤處理。您可以使用規則編輯器來定義條件,並設定觸發規則時要執行的必要動作。調適型單會根據預設的驗證標準來驗證您在欄位中輸入的資料。如果輸入值不符合驗證標準,最適化表單的欄位層級會顯示錯誤訊息。

NOTE
  • 若要透過規則編輯器的調用服務動作來使用錯誤處理常式,請使用表單資料模型來設定調適型自表單。
  • 如果錯誤回應是在標準結構描述中,則系統會提供預設的錯誤處理常式以顯示欄位的錯誤訊息。您還可以從自訂錯誤處理常式函數來呼叫預設的錯誤處理常式。

使用規則編輯器可以:

新增預設錯誤處理常式函數 add-default-errror-handler

如果錯誤回應是在標準結構描述中或是伺服器端驗證失敗,則系統會支援預設錯誤處理常式以顯示欄位的錯誤訊息。
若要了解如何使用採用規則編輯器調用服務動作的預設錯誤處理常式,請以含有兩個欄位的簡單最適化表單為例 (寵物 ID 和​ 寵物名稱),並在「寵物 ID」欄位使用預設的錯誤處理常式,查看為調用外部服務所設定 REST 端點傳回的各種錯誤,例如 200 - OK404 - Not Found400 - Bad Request。要使用規則編輯器的調用服務操作添加默認錯誤處理程序,請執行以下步驟:

  1. 在撰寫模式中開啟最適化表單,選取表單元件,然後選取 規則編輯器 以開啟規則編輯器。
  2. 選取「建立」。
  3. 在「何時」規則部分中建立條件。例如,[寵物 ID 欄位名稱​]​ ​何時變更。「選取」從「選取狀態」下拉式清單變更「選取」。
  4. 在「然後」部分,從「選取動作」下拉式清單中選取「調用服務」。
  5. 選取「郵遞服務」,及其自「輸入」部分的對應資料綁定。例如,要驗證​ 寵物 ID,選取「郵遞服務」作為​ GET /pet/{petId},並選取「寵物 ID」(在「輸入」部分)。
  6. 從「輸出」部分,選取資料綁定。選取「寵物名稱」(在「輸出」部分)。
  7. 選取「預設錯誤處理常式」(來自「錯誤處理常式」部分)。
  8. 按一下​ 「完成」

新增預設錯誤處理常式,以便在表單中進行欄位驗證檢查

根據此規則,您輸入的「寵物 ID」值會使用 REST 端點調用的外部服務檢查​ 寵物名稱 ​的驗證。如果根據資料來源的驗證標準失敗,欄位層級將顯示錯誤訊息。

當您在表單中新增預設錯誤處理常式來處理錯誤回應時會顯示預設錯誤訊息

新增自訂錯誤處理常式函數 add-custom-errror-handler

您可以新增自訂錯誤處理常式函數來執行一些動作,例如:

  • 處理使用非標準或標準錯誤回應的錯誤回應。要特別注意,這些非標準錯誤回應不符合錯誤回應的標準結構描述
  • 將分析事件發送到任何分析平台。(例如,Adobe Analytics。)
  • 顯示有錯誤訊息的模式對話框。

除了上述動作,還可使用自訂錯誤處理常式來執行符合特定使用者需求的自訂函式。

自訂錯誤處理常式是一個函數 (用戶端資料庫),旨在回應外部服務傳回的錯誤並向一般使用者提供自訂回應。任何有附註 @errorHandler 的用戶端資料庫會被視為是自訂錯誤處理常式函數。此註解有助於識別 .js 檔案。

若要了解如何建立和使用採用規則編輯器調用服務動作的自訂錯誤處理常式,讓我們以含有兩個欄位的簡單最適化表單為例 (寵物 ID 和​ 寵物名稱),並在「寵物 ID」欄位使用自訂的錯誤處理程式,查看為調用外部服務所設定 REST 端點傳回的各種錯誤,例如 200 - OK404 - Not Found400 - Bad Request

若要在最適化表單中新增和使用自訂錯誤處理常式,請執行以下步驟:

1. 建立自訂錯誤處理常式 create-custom-error-message

若要建立自訂錯誤函數,請執行以下步驟:

  1. 登入 http://server:port/crx/de/index.jsp#.

  2. /apps 檔案夾中建立一個檔案夾。例如,建立名為的資料夾 experience-league.

  3. 儲存您的變更。

  4. 導覽至建立的資料夾並建立型別節點 cq:ClientLibraryFolder 作為 clientlibs.

  5. 導覽至新建立的 clientlibs 資料夾並新增 allowProxycategories 屬性:

    自訂程式庫節點屬性

    note note
    NOTE
    您可以提供任何名稱來取代 customfunctionsdemo.
  6. 儲存您的變更。

  7. 建立名為的資料夾 jsclientlibs 資料夾。

  8. 建立名為的JavaScript檔案 functions.jsjs 資料夾

  9. 建立名為的檔案 js.txtclientlibs 資料夾。

  10. 儲存您的變更。
    已建立的檔案夾結構如下所示:

    已建立的用戶端資料庫檔案夾結構

  11. 按兩下 functions.js 檔案以開啟編輯器。 該檔案包含自訂錯誤處理常式的代碼。
    讓我們將以下代碼新增至 JavaScript 檔案中,以便在瀏覽器主控台中顯示從 REST 服務端點接收到的回應和標頭。

    code language-javascript
        /**
        Custom Error handler
        * @name customErrorHandler Custom Error Handler Function
        * @errorHandler
        */
        function customErrorHandler(response, headers, globals)
        {
            console.log("Custom Error Handler processing start...");
            console.log("response:"+JSON.stringify(response));
            console.log("headers:"+JSON.stringify(headers));
            alert("CustomErrorHandler - Please enter valid PetId.")
            globals.invoke('defaultErrorHandler',response, headers)
            console.log("Custom Error Handler processing end...");
        }
    

    若要從自訂錯誤處理常式調用預設的錯誤處理常式,請使用以下範例代碼行:
    globals.invoke('defaultErrorHandler',response, headers)

  12. 儲存 function.js.

  13. 瀏覽至 js.txt 並新增下列程式碼:

    code language-javascript
        #base=js
        functions.js
    
  14. 儲存 js.txt 檔案。

現在,讓我們了解如何使用 AEM Forms 規則編輯器的調用服務來設定和使用自訂錯誤處理常式。

2. 使用規則編輯器設定自訂錯誤處理常式 use-custom-error-handler

在最適化表單中實施自訂錯誤處理常式之前,請確保​ 用戶端資料庫類別 ​中的用戶端資料庫名稱符合 .content.xml 檔案類別選項所指定的名稱。

在最適化表單容器設定中新增用戶端資料庫的名稱

在此情況下,使用者端程式庫名稱提供為 customfunctionsdemo.content.xml 檔案。

若要使用自訂錯誤處理常式,請使用​ 規則編輯器調用服務 ​行動:

  1. 在撰寫模式中開啟最適化表單,選取表單元件,然後選取 規則編輯器 以開啟規則編輯器。
  2. 選取「建立」。
  3. 在「何時」規則部分中建立條件。例如,當​ [寵物 ID 欄位名稱] ​已變更,請從「選擇狀態」下拉式清單選取「已變更」。
  4. 在「然後」部分,從「選取動作」下拉式清單中選取「調用服務」。
  5. 選取「郵遞服務」,及其自「輸入」部分的對應資料綁定。例如,要驗證​ 寵物 ID,選取「郵遞服務」作為​ GET /pet/{petId},並選取「寵物 ID」(在「輸入」部分)。
  6. 從「輸出」部分,選取資料綁定。例如,選取「寵物名稱」(在「輸出」部分)。
  7. 選取「自訂錯誤處理程式」(來自「錯誤處理程式」部分)。
  8. 按一下​ 「完成」

在表單中新增自訂錯誤處理常式,以處理錯誤回應

根據此規則,您輸入的「寵物 ID」值會使用 REST 端點調用的外部服務檢查​ 寵物名稱 ​的驗證。如果根據資料來源的驗證標準失敗,欄位層級將顯示錯誤訊息。

在表單中新增自訂錯誤處理常式以處理錯誤回應 s

開啟瀏覽器主控台,並查看從 REST 服務端點接收的回應和標頭是否有驗證錯誤訊息。

自訂錯誤處理常式函數負責根據錯誤回應執行其他動作,例如顯示模式對話框或發送分析事件。自訂錯誤處理常式函數可提供靈活性,會根據特定使用者需求來訂制錯誤處理行動。

另請參閱 see-also

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2