使用JSON模式创建自适应表单

前提条件

使用JSON模式作为表单模型创作自适应表单需要基本了解JSON模式。 建议在本文之前阅读以下内容。

• 创建自适应表单
• JSON模式

将JSON模式用作表单模型

AEM Forms支持使用现有JSON模式作为表单模型创建自适应表单。 此JSON模式表示组织中的后端系统生成或使用数据的结构。 您使用的JSON模式应符合v4规范。

使用JSON模式的主要功能有：

• 在自适应表单的创作模式下，JSON的结构会在内容查找器选项卡中显示为树。 您可以将元素从JSON层次结构拖放到自适应表单。
• 您可以使用符合关联模式的JSON预填表单。
• 提交时，用户输入的数据将作为符合相关模式的JSON提交。

JSON模式由简单和复杂的元素类型组成。 元素具有向元素添加规则的属性。 当这些元素和属性被拖动到自适应表单上时，它们会自动映射到相应的自适应表单组件。

JSON元素与自适应表单组件的映射如下：

常见模式属性

自适应表单使用JSON模式中的可用信息映射每个生成的字段。 特别是：

• 标题属性用作自适应表单组件的标签。
• description属性设置为自适应表单组件的长描述。
• 默认属性用作自适应表单字段的初始值。
• maxLength属性设置为文本字段组件的maxlength属性。
• “数字”框组件使用minimum、maximum、exclusiveMinimum和exclusiveMaximum属性。
• 为了支持DatePicker组件的范围，还提供了其他JSON模式属性minDate和maxDate。
• minItems和maxItems属性用于限制可从面板组件添加或删除的项目／字段数。
• readOnly属性设置自适应表单组件的只读属性。
• 必需属性将自适应表单字段标记为必需字段，而在面板（其中类型为对象）的情况下，最终提交的JSON数据的字段具有与该对象对应的空值。
• 模式属性以自适应形式设置为验证模式(常规表达式)。
• JSON模式文件的扩展名必须保留为。模式.json。 例如，<filename>.模式.json。

示例JSON模式

以下是JSON模式的示例。

{
 "$schema": "https://json-schema.org/draft-04/schema#",
 "definitions": {
  "employee": {
   "type": "object",
   "properties": {
    "userName": {
     "type": "string"
    },
    "dateOfBirth": {
     "type": "string",
     "format": "date"
    },
    "email": {
     "type": "string",
     "format": "email"
    },
    "language": {
     "type": "string"
    },
    "personalDetails": {
     "$ref": "#/definitions/personalDetails"
    },
    "projectDetails": {
     "$ref": "#/definitions/projectDetails"
    }
   },
   "required": [
    "userName",
    "dateOfBirth",
    "language"
   ]
  },
  "personalDetails": {
   "type": "object",
   "properties": {
    "GeneralDetails": {
     "$ref": "#/definitions/GeneralDetails"
    },
    "Family": {
     "$ref": "#/definitions/Family"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "projectDetails": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projects": {
      "$ref": "#/definitions/projects"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projects": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projectsAdditional": {
      "$ref": "#/definitions/projectsAdditional"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projectsAdditional": {
   "type": "array",
   "items": {
    "properties": {
     "Additional_name": {
      "type": "string"
     },
     "Additional_areacode": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "GeneralDetails": {
   "type": "object",
   "properties": {
    "age": {
     "type": "number"
    },
    "married": {
     "type": "boolean"
    },
    "phone": {
     "type": "number",
     "aem:afProperties": {
      "sling:resourceType": "/libs/fd/af/components/guidetelephone",
      "guideNodeClass": "guideTelephone"
     }
    },
    "address": {
     "type": "string"
    }
   }
  },
  "Family": {
   "type": "object",
   "properties": {
    "spouse": {
     "$ref": "#/definitions/spouse"
    },
    "kids": {
     "$ref": "#/definitions/kids"
    }
   }
  },
  "Income": {
   "type": "object",
   "properties": {
    "monthly": {
     "type": "number"
    },
    "yearly": {
     "type": "number"
    }
   }
  },
  "spouse": {
   "type": "object",
   "properties": {
    "name": {
     "type": "string"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "kids": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  }
 },
 "type": "object",
 "properties": {
  "employee": {
   "$ref": "#/definitions/employee"
  }
 }
}

可重用模式定义

定义密钥用于识别可重用模式。 可重用的模式定义用于创建片段。 它类似于在XSD中识别复杂类型。 下面给出了具有定义的示例JSON模式:

{
  "$schema": "https://json-schema.org/draft-04/schema#",
 
  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },
 
  "type": "object",
 
  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" }
  }
}

上例定义了客户记录，其中每个客户同时具有发运地址和开单地址。 两个地址的结构相同——地址有街道地址、城市地址和州地址——因此最好不要重复地址。 它还使添加和删除字段变得很容易，以便将来进行任何更改。

预配置JSON模式定义中的字段

您可以使用​aem:afProperties​属性预配置JSON模式字段以映射到自定义自适应表单组件。 下面列出了一个示例：

{
    "properties": {
        "sizeInMB": {
            "type": "integer",
            "minimum": 16,
            "maximum": 512,
            "aem:afProperties" : {
                 "sling:resourceType" : "/apps/fd/af/components/guideTextBox",
                 "guideNodeClass" : "guideTextBox"
             }
        }
    },
    "required": [ "sizeInMB" ],
    "additionalProperties": false
}

限制自适应表单组件的可接受值

您可以向JSON模式元素添加以下限制以限制自适应表单组件可接受的值：

不支持的构造

自适应表单不支持以下JSON模式构造：

• Null类型
• 合并类型（如任何）和
• OneOf、AnyOf、AllOf和NOT
• 仅支持同质阵列。 因此，项目约束必须是对象而不是数组。

常见问题

为什么我无法拖动子表单的单个元素（从任何复杂类型生成的结构）以用于可重复的子表单（minOccours或maxOccurs值大于1）?

在可重复的子表单中，必须使用完整的子表单。 如果只想选择字段，请使用整个结构并删除不需要的字段。

我在内容查找器中有一个很长的复杂结构。如何找到特定元素？

您有两种选择：

• 滚动浏览树结构
• 使用“搜索”框查找元素