基于JSON 数据结构化规范

 本文是基于JSON 格式定义的数据结构标准规范（阅读时间约为10分钟）

规范主要作用

• 描述现有的数据含义。可以一目了然的阅读每个表、每个字段的用途。

• 设定数据操作权限(permission)。什么样的角色可以读/写哪些数据，都在这里配置。

• 设定字段值域能接受的格式(validator)，比如不能为空、需符合指定的正则格式。

• 设定字段之间的约束关系(fieldRules)，比如字段结束时间需要晚于字段开始时间。

• 设置数据的默认值(defaultValue/forceDefaultValue)，比如服务器当前时间、用户id等。

• 设定多个表的字段间映射关系(foreignKey)，将多个表按一个虚拟联表直接查询，简化联表查询。

• 根据schema自动生成前端界面，包括列表、详情、新建和编辑页面，自动处理校验规则。

MongoDB支持通过 $jsonSchema 操作符在插入和更新文档时进行结构验证（非空、类型校验等）， $jsonSchema 支持 JSON Schema的草案4，包括core specification和validation specification。

如何编写

Schema的一级节点

{
      
	"bsonType": "object", // 固定节点
	"description": "表的描述",
	"required": [], // 必填字段
	"permission": { 
		"read": false, // 前端非admin的读取记录权限控制。默认值是false，即可以不写。可以简单的true/false，也可以写表达式
		"create": false, // 前端非admin的新增记录权限控制。默认值是false，即可以不写。可以简单的true/false，也可以写表达式 
		"update": false, // 前端非admin的更新记录权限控制。默认值是false，即可以不写。可以简单的true/false，也可以写表达式
		"delete": false, // 前端非admin的删除记录权限控制。默认值是false，即可以不写。可以简单的true/false，也可以写表达式
		"count": false // 前端非admin的求数权限控制。默认值是true，即可以不写。可以简单的true/false，也可以写表达式
	},
	"properties": { // 表的字段清单
		"_id": { // 字段名称，每个表都会带有_id字段
			"description": "ID，系统自动生成"
			// 这里还有很多字段属性可以设置
		}
	},
	"fieldRules":[
		// 字段之间的约束关系。比如字段开始时间小于字段结束时间。也可以只校验一个字段。支持表达式
	]
}

字段的属性清单

properties里的字段列表，每个字段都有很多可以设置的属性，如下：

属性	类型	描述
bsonType	any	字段类型，如json object、字符串、数字、bool值、日期、时间戳，具体见下表bsonType可用类型
title	string	标题，开发者维护时自用。如果不填label属性，将在生成前端表单代码时，默认用于表单项前面的label
description	string	描述，开发者维护时自用。在生成前端表单代码时，如果字段未设置componentForEdit，且字段被渲染为input，那么input的placehold将默认为本描述
required	array	是否必填。支持填写必填的下级字段名称。required可以在表级的描述出现，约定该表有哪些字段必填。也可以在某个字段中出现，如果该字段是一个json，可以对这个json中的哪些字段必填进行描述。详见下方示例
enum