# 语法规范
Mock.js 的语法规范包括两部分:
- 数据模板定义规范(Data Template Definition,DTD)
- 数据占位符定义规范(Data Placeholder Definition,DPD)
# 数据模板定义规范 DTD
数据模板中的每个属性由 3 部分构成:属性名、生成规则、属性值:
| // 属性名   name | |
| // 生成规则 rule | |
| // 属性值   value | |
| 'name|rule': value | 
注意:
- 属性名 和 生成规则 之间用竖线 - |分隔。
- 生成规则 是可选的。 
- 生成规则 - 有 7 种格式: - 'name|min-max': value
- 'name|count': value
- 'name|min-max.dmin-dmax': value
- 'name|min-max.dcount': value
- 'name|count.dmin-dmax': value
- 'name|count.dcount': value
- 'name|+step': value
 
- * 生成规则 * 的 含义 需要依赖 * 属性值的类型 * 才能确定。 
- 属性值 中可以含有 - @占位符。
- 属性值 还指定了最终值的初始值和类型。 
生成规则和示例:
# 1. 属性值是字符串 String
- 'name|min-max': string- 通过重复 - string生成一个字符串,重复次数大于等于- min,小于等于- max。
- 'name|count': string- 通过重复 - string生成一个字符串,重复次数等于- count。
# 2. 属性值是数字 Number
- 'name|+1': number- 属性值自动加 1,初始值为 - number。
- 'name|min-max': number- 生成一个大于等于 - min、小于等于- max的整数,属性值- number只是用来确定类型。
- 'name|min-max.dmin-dmax': number- 生成一个浮点数,整数部分大于等于 - min、小于等于- max,小数部分保留- dmin到- dmax位。
| Mock.mock({ | |
| 'number1|1-100.1-10': 1, | |
| 'number2|123.1-10': 1, | |
| 'number3|123.3': 1, | |
| 'number4|123.10': 1.123 | |
| }) | |
| // => | |
| { | |
| "number1": 12.92, | |
| "number2": 123.51, | |
| "number3": 123.777, | |
| "number4": 123.1231091814 | |
| } | 
# 3. 属性值是布尔型 Boolean
- 'name|1': boolean- 随机生成一个布尔值,值为 true 的概率是 1/2,值为 false 的概率同样是 1/2。 
- 'name|min-max': value- 随机生成一个布尔值,值为 - value的概率是- min / (min + max),值为- !value的概率是- max / (min + max)。
# 4. 属性值是对象 Object
- 'name|count': object- 从属性值 - object中随机选取- count个属性。
- 'name|min-max': object- 从属性值 - object中随机选取- min到- max个属性。
# 5. 属性值是数组 Array
- 'name|1': array- 从属性值 - array中随机选取 1 个元素,作为最终值。
- 'name|+1': array- 从属性值 - array中顺序选取 1 个元素,作为最终值。
- 'name|min-max': array- 通过重复属性值 - array生成一个新数组,重复次数大于等于- min,小于等于- max。
- 'name|count': array- 通过重复属性值 - array生成一个新数组,重复次数为- count。
# 6. 属性值是函数 Function
- 'name': function- 执行函数 - function,取其返回值作为最终的属性值,函数的上下文为属性- 'name'所在的对象。
# 7. 属性值是正则表达式 RegExp
- 'name': regexp- 根据正则表达式 - regexp反向生成可以匹配它的字符串。用于生成自定义格式的字符串。- Mock.mock({ - 'regexp1': /[a-z][A-Z][0-9]/, - 'regexp2': /\w\W\s\S\d\D/, - 'regexp3': /\d{5,10}/ - }) - // =>- {- "regexp1": "pJ7", - "regexp2": "F)\fp1G", - "regexp3": "561659409" - }
# 数据占位符定义规范 DPD
占位符 只是在属性值字符串中占个位置,并不出现在最终的属性值中。
占位符 的格式为:
| @占位符 | |
| @占位符(参数 [, 参数]) | 
注意:
- 用 @来标识其后的字符串是 占位符。
- 占位符 引用的是 Mock.Random中的方法。
- 通过 Mock.Random.extend()来扩展自定义占位符。
- 占位符 也可以引用 数据模板 中的属性。
- 占位符 会优先引用 数据模板 中的属性。
- 占位符 支持 相对路径 和 绝对路径。
| Mock.mock({ | |
| name: { | |
| first: '@FIRST', | |
| middle: '@FIRST', | |
| last: '@LAST', | |
| full: '@first @middle @last' | |
|     } | |
| }) | |
| // => | |
| { | |
| "name": { | |
| "first": "Charles", | |
| "middle": "Brenda", | |
| "last": "Lopez", | |
| "full": "Charles Brenda Lopez" | |
|     } | |
| } | 
