使用自适应表单的最佳实践 best-practices-for-working-with-adaptive-forms

使用Apache Maven aem-project-archetype创建和管理AEM项目的结构。 它可为您的AEM项目创建推荐的结构和模板。 此外，它还提供构建自动化和更改控制系统，以帮助管理项目。

• 使用maven archetype:generate命令生成初始结构。
• 使用maven eclipse:eclipse命令生成eclipse项目文件并将项目导入eclipse。

FileVault工具或VLT可帮助您将CRX或AEM实例的内容映射到文件系统。 它提供变更控制管理操作，如AEM项目内容的签入和签出。 请参阅如何使用VLT工具。

如果您使用集成了Eclipse的开发环境，则可以使用AEM开发人员工具将Eclipse IDE与AEM实例无缝集成以创建AEM应用程序。 有关详细信息，请参阅适用于Eclipse的AEM开发人员工具。

请勿在/libs文件夹中存储任何内容或进行任何修改。 在/app文件夹中创建叠加以扩展或覆盖默认功能。

在创建包以移动内容时，请确保包过滤器路径正确，并且只引用所需路径。

请勿在/libs文件夹中存储任何内容或进行任何修改。 在/app文件夹中创建叠加以扩展或覆盖默认功能。

为软件包定义正确的依赖关系，以强制预先确定的安装顺序/顺序。

请勿在/libs或/apps中创建任何可引用的节点。

自适应表单模板是一种专门的AEM页面，用于定义自适应表单的结构和页眉页脚信息。 模板具有预配置的自适应表单布局、样式和基本结构。 AEM Forms提供了可用于创作自适应表单的开箱即用模板和组件。 但是，您可以根据需要创建自定义模板和组件。 建议收集在自适应表单中所需的其他模板和组件的要求。 有关详细信息，请参阅自定义自适应表单和组件。

建议使用表单管理器用户界面而不是CRX包管理器用户界面上传表单包，因为通过CRX包管理器上传包有时可能会导致异常。

AEM Forms允许您基于以下表单模型创建自适应表单。 表单模型用作表单与AEM系统之间数据交换的接口，并为自适应表单内外的数据流提供基于XML的结构。 此外，表单模型以模式和XFA约束的形式对自适应表单施加规则和约束。

• 无：使用此选项创建的自适应表单不使用任何表单模型。 从此类表单生成的数据 XML 具有带字段和相应值的平面结构。
• XML或JSON架构： XML和JSON架构表示组织中的后端系统生成或使用数据的结构。 您可以将架构关联到自适应表单，并使用其元素将动态内容添加到自适应表单。 架构的元素在内容浏览器的数据模型对象选项卡中可用，用于创作自适应表单。 您可以拖放架构元素来构建表单。
• XFA表单模板：如果您在基于XFA的HTML5表单中有投资，则它是理想的表单模型。 它提供了一种将您的基于XFA的表单转换为自适应表单的直接方法。 任何现有XFA规则都会保留在关联的自适应表单中。 生成的自适应表单支持XFA构造，例如验证、事件、属性和模式。
• 表单数据模型：如果您希望集成后端系统(如数据库、Web服务和AEM用户配置文件)以预填充自适应表单并将提交的表单数据写回后端系统，则它是首选表单模型。 利用表单数据模型编辑器，可在可用于创建自适应表单的表单数据模型中定义和配置实体和服务。 有关详细信息，请参阅AEM Forms数据集成。

AEM Forms提供了可用于创建自适应表单的现成自适应表单模板。 您还可以创建自己的模板。 AEM提供静态和可编辑的模板。

• 静态模板由开发人员定义和配置。
• 可编辑模板由作者使用模板编辑器创建。 利用模板编辑器，可在模板中定义基本结构和初始内容。 结构层中的任何修改都会反映在使用该模板的所有表单中。 初始内容可包括预配置的主题、预填充服务、提交操作等。 但是，可以使用表单编辑器为表单修改这些设置。 有关详细信息，请参阅自适应表单模板。

若要设置特定字段或面板实例的样式，请使用内联样式。 或者，您可以在CSS文件中定义类，并在组件的CSS Class属性中指定类名称。

在组件中包含客户端库，以便在使用该组件的自适应表单或片段中始终应用样式。 有关详细信息，请参阅创建自适应表单页面组件。

通过在自适应表单容器属性的CSS文件路径字段中指定客户端库的路径，应用客户端库中定义的样式来选择自适应表单。

要创建样式的客户端库，您可以在主题编辑器基本clientlib中或表单容器属性中配置自定义CSS文件。

自适应表单提供面板布局（如响应式、选项卡式、折叠和向导）以控制表单组件在面板中的布局方式。 您可以创建自定义面板布局，并使其可供表单作者使用。 有关详细信息，请参阅为自适应表单创建自定义布局组件。

您还可以自定义特定的自适应表单组件，如字段和面板布局。

• 使用AEM的叠加功能修改组件的副本。 不建议修改默认组件。
• 要在/libs中自定义现成自适应表单组件的布局，除默认布局之外，还创建自定义布局组件。
• 通过创建自定义小部件或外观引入自定义交互。 不建议修改默认组件。 有关详细信息，请参阅外观框架。

有关处理PII数据的建议，请参阅处理个人身份信息。

使用侧栏中的对象浏览器快速访问表单层次结构中较深的字段。 您可以使用搜索框搜索表单或对象树中的对象，以便从一个对象导航到另一个对象。

若要在侧栏的组件浏览器中查看和编辑组件的属性，请选择该组件，然后单击 。 也可以双击组件以在属性浏览器中查看其属性。

使用键盘快捷键可对表单执行快速操作。 请参阅AEM Forms键盘快捷键。

建议仅在自适应表单页面中使用自适应表单组件。 组件依赖其父层次结构。 因此，请勿在AEM页面中使用它们。

为表单字段和组件使用有意义、唯一的名称，以避免在编写规则时可能产生的任何冲突。

对组件使用this运算符以在规则表达式中引用自身。 这可确保即使组件名称发生更改，规则仍保持有效。 例如：field1.valueCommit script: this.value > 10。

引用其他表单组件时，请使用组件名称。 使用value属性获取字段或组件的值。 例如：field1.value。

按相对唯一层次结构引用组件以避免任何冲突。 例如：parentName.fieldName。

处理复杂或常用的规则时，请考虑将业务逻辑作为函数写入单独的客户端库中，以便您可以在自适应表单中指定并重用这些函数。 客户端库应为自包含库，并且不应具有任何外部依赖项，但jQuery和Underscore.js除外。 您还可以使用客户端库强制执行已提交表单数据的服务器端重新验证。

自适应表单提供了一组API，您可以使用这些API与自适应表单通信并对自适应表单执行操作。 一些关键API如下所示。 有关详细信息，请参阅自适应JavaScript的Forms库API参考。

• guideBridge.reset()：重置表单。

• guideBridge.submit()：提交表单。

• guideBridge.setFocus(somExp, focusOption, runCompletionExp)：将焦点设置为字段。

• guideBridge.validate(errorList, somExpression, focus)：验证表单。

• guideBridge.getDataXML(options)：以XML格式获取表单数据。

• guideBridge.resolveNode(somExpression)：获取表单对象。

• guideBridge.setProperty(somList, propertyName, valueList)：设置表单对象的属性。

• 此外，您还可以使用以下字段属性：

  • field.value以更改字段的值。
  • field.enabled以启用/禁用字段。
  • field.visible以更改字段的可见性。

自适应表单作者可能需要编写JavaScript代码，才能在表单中构建业务逻辑。 虽然JavaScript功能强大且有效，但它有可能降低安全预期。 因此，您必须确保表单作者是受信任的角色，并且在表单投入生产之前具有审查和批准JavaScript代码的流程。 管理员可以根据用户组的角色或职能，限制用户组对规则编辑器的访问权限。 请参阅向选定的用户组授予规则编辑器访问权限。

您可以在规则中使用表达式以使自适应表单成为动态表单。 所有表达式都是有效的JavaScript表达式，都使用自适应表单脚本模型API。 这些表达式返回某些类型的值。 有关表达式及其相关最佳实践的更多信息，请参阅自适应表单表达式。

Adobe建议在使用规则编辑器创建规则时，对异步操作使用JavaScript同步操作。 强烈建议不要使用异步操作。 但是，如果您无法避免异步操作，则实施JavaScript关闭函数至关重要。 这样，您就可以有效地防止任何潜在的竞争情况，从而确保您的规则实施提供最佳性能并在整个过程中保持稳定性。

例如，假设我们需要从外部API获取数据，然后根据该数据应用一些规则。 我们使用关闭来处理异步API调用，并确保在获取数据后应用规则。 以下是示例代码：

     function fetchDataFromAPI(apiEndpoint, callback) {
      // Simulate asynchronous API call with setTimeout
      setTimeout(() => {
        // Assuming the API call is successful, we receive some data
        const data = {
          someValue: 42,
        };
        // Invoke the callback with the fetched data
        callback(data);
      }, 2000); // Simulate a 2-second delay for the API call
    }
    // Rule implementation using Closure
    function ruleImplementation(apiEndpoint) {
      // Using a closure to handle the asynchronous API call and rule application
      // say you have set this value in street field inside address panel
      var streetField = address.street;
      fetchDataFromAPI(apiEndpoint, (data) => {
        streetField.value = data.someValue;
      });
    }
    // Example usage of the rule implementation
    const apiEndpoint = "https://example-api.com/data";
    ruleImplementation(apiEndpoint);

在此示例中，fetchDataFromAPI使用setTimeout模拟异步API调用。 在获取数据后，它会调用提供的回调函数，该函数是处理后续规则应用的闭包。 ruleImplementation函数包含规则逻辑。

建议使用XSD表单数据模型创建自适应表单，即使可能的情况下也将XFA转换为自适应表单。

仅包括自适应表单中从用户捕获信息的那些字段和面板。 请考虑将静态内容保持为最小或使用URL在单独的窗口中打开它们。

虽然每个表单都针对特定目的而设计，但大多数表单中都存在一些通用区段。 例如，个人详细信息、地址、雇用详细信息等。 为通用表单元素和节创建自适应表单片段，并在表单间使用它们。 您还可以将现有表单中的面板另存为片段。 片段中的任何更改都会反映在所有关联的自适应表单中。 它促进了协作创作，因为多个作者可以同时处理构成表单的不同片段。

• 与自适应表单类似，建议使用片段容器对话框在客户端库中定义所有特定于片段的样式和自定义脚本。 此外，尝试创建不依赖于外部对象的自给自足的片段。
• 避免使用跨片段脚本。 如果片段外有任何您必须引用的对象，请尝试将该对象作为父表单的一部分。 如果对象必须仍然驻留在另一个片段中，请在脚本中按其名称引用它。

使用自动保存并恢复可定期保存自适应表单，并允许用户稍后重新访问以完成表单。

配置片段以延迟加载。 在运行时，标记为延迟加载的片段仅在需要时才会呈现。 它显着缩短了大型表单的加载时间。 带有可重复面板的片段也支持此功能。 有关详细信息，请参阅配置延迟加载。

• 请勿在响应式网格布局或第一个面板中配置对片段的延迟加载。
• 延迟加载的片段不支持文件附件和条款和条件组件。
• 如果延迟加载面板中的某个值在表单的其他部分中使用，请将该值标记为“全局使用值”，以便在卸载包含的面板时使用该值。
• 考虑为应根据条件显示或隐藏的片段编写可见性规则。

将​ Apache Sling主Servlet ​中每个请求​ 的 ​调用数的值设置为相当大的数值。 它允许Forms服务器进行其他调用。 配置显示默认值1500。 值“1500调用”适用于其他Experience Manager组件，如Sites和Assets。 自适应表单的默认值集为20000。 如果您在日志中遇到too many calls错误或表单无法呈现，请尝试将该值增大到较大的数字来解决问题。 如果调用的数量超过20000，则意味着表单非常复杂，在浏览器中呈现表单可能需要一些时间。 这仅在首次加载表单时发生，之后将缓存表单，并且一旦缓存表单，对性能没有重大影响。

AEM Forms提供预填充服务，用于从预定义的数据XML文件中读取数据，并使用预填充XML文件中的内容预填充自适应表单的字段。

预填充数据XML必须与与自适应表单关联的表单模型的架构兼容。

在预填充XML中包括afBoundedData和afUnBoundedData部分，以便在自适应表单中预填充绑定和未绑定字段。

对于基于表单数据模型的自适应表单，AEM Forms提供现成的表单数据模型预填充服务。 预填充服务在自适应表单中查询数据模型对象的数据源，并在呈现表单时预填充字段值。

您还可以使用文件、crx、服务或http协议预填充自适应表单。

AEM Forms支持自定义预填充服务，您可以将这些服务作为OSGi服务插入以预填充自适应表单。

根据自适应表单所基于的表单数据模型，您可以为DoR配置模板，如下所示：

• XFA表单模板：使用关联的XDP文件作为DoR模板。
• XSD架构：使用与自适应表单使用相同XML架构的关联XFA模板。
• 无：使用自动生成的DoR。

直接从自适应表单编辑器的“记录文档”选项卡配置页眉、页脚、图像、颜色、字体等。

使用DoRService以编程方式生成记录文档。

从记录文档排除隐藏字段。

使用afAcceptLang请求参数在另一个区域设置中查看DoR。

将自适应表单片段用于各个表单中的常用元素并将片段本地化。 它确保您将片段本地化一次，并在使用本地化片段的所有表单中反映出来。

任何修改（如添加新组件或以本地化的形式应用脚本）都不会自动本地化。 因此，在本地化表单之前必须先完成该表单，以避免多个本地化周期。

使用afAcceptLang请求参数覆盖浏览器区域设置并以指定的区域设置呈现表单。 例如，无论浏览器设置中指定的区域设置如何，以下URL都会强制以日语区域设置呈现表单：

https://'[server]:[port]'/<contextPath>/<formFolder>/<formName>.html?wcmmode=disabled&afAcceptLang=ja

AEM Forms当前支持英语(en)、西班牙语(es)、法语(fr)、意大利语(it)、德语(de)、日语(ja)、葡萄牙语 — 巴西语(pt-BR)、中文(zh-CN)、中文 — 台湾(zh-TW)和韩语(ko-KR)本地化自适应表单内容。 但是，您可以在运行时为自适应表单添加新区域设置支持。 有关详细信息，请参阅支持自适应表单本地化的新区域设置。

从Felix控制台为JavaScript和CSS启用HTML客户端库压缩。

在AEM Dispatcher上缓存/etc.clientlibs/fd的所有客户端库和任何其他自定义客户端库，以提高已发布表单的响应速度和安全性。 有关详细信息，请参阅Dispatcher。

不缓存/content/forms/af/和/content/dam/formsanddocuments/*路径。 有关配置自适应表单缓存的详细信息，请参阅缓存自适应表单。

通过Web服务器HTML模块启用压缩。 有关详细信息，请参阅AEM Forms服务器的性能优化。

增加大型表单的每个请求配置的调用。 请参阅优化大型复杂表单的性能。

创建由错误处理程序🔗显示的自定义错误页面。

安全的AEM Forms服务器。

• 使用nosamplecontent运行模式以确保在生产服务器上没有部署示例内容和示例用户。 请参阅在生产就绪模式下运行AEM。

将栈大小保持为最小8 GB。 有关其他设置，请参阅AEM Forms服务器的性能优化。

使用服务用户会话而不是管理会话来执行服务级别任务。 有关详细信息，请参阅服务身份验证。

存储草稿数据：如果使用自适应表单的草稿功能，则应实施自定义服务提供接口(SPI)，以将草稿数据存储到更安全的存储（如数据库）。 有关详细信息，请参阅将草稿和提交组件与数据库集成的示例。

存储提交数据：如果您使用表单门户提交存储，则应该实施自定义SPI以将提交数据存储在数据库中。 有关示例集成，请参阅将草稿和提交组件与数据库🔗集成的示例。

您还可以编写自定义提交操作，将表单数据和附件存储在安全存储中。 有关详细信息，请参阅为自适应表单编写自定义提交操作。

草稿ID的长度：将自适应表单另存为草稿时，将生成草稿ID以唯一标识草稿。 草稿ID字段的最小长度值为26个字符。 Adobe建议将草稿ID长度设置为26个或更多字符。

无缝使用版本控制，如Git：

• 从内容中分离代码可显着减少内容管理期间的Git冲突，并提升组织良好的存储库。
• 自定义函数对于有多个参与者同时工作的项目非常有用。

技术优势：

• 自定义函数提供了模块性和封装。
• 模块可以独立开发、测试和维护。
• 增强了代码的可重用性和可维护性。

高效开发流程：

• 模块化允许开发人员专注于特定功能。
• 通过降低整个代码库的复杂程度来降低开发人员的负担，从而实现更有效的开发过程。