mockjs使用指南

2023-11-17 13:36:22

mockjs简介

Mock.js 是一款模拟数据生成器，旨在帮助前端攻城师独立于后端进行开发，帮助编写单元测试。提供了以下模拟功能：

根据数据模板生成模拟数据
模拟 Ajax 请求，生成并返回模拟数据
基于 HTML 模板生成模拟数据

在前后端分离式开发中起着很重要的作用。

安装及使用方法

1、node(commenJS)

// 安装
npm install mockjs

// 使用 Mock
var Mock = require('mockjs')
var data = Mock.mock({
    // 属性 list 的值是一个数组，其中含有 1 到 10 个元素
    'list|1-10': [{
        // 属性 id 是一个自增数，起始值为 1，每次增 1
        'id|+1': 1
    }]
})
// 输出结果
console.log(JSON.stringify(data, null, 4))

运行结果会随机生成10个以内的 json 数据，比如第一次生成4个键值对的 JSON 对象，第二次可能为8个。

2、Bower

npm install -g bower
bower install --save mockjs

<script type="text/javascript" src="./bower_components/mockjs/dist/mock.js"></script>

语法规范

Mock.js 的语法规范包括两部分：

数据模板定义（Data Temaplte Definition，DTD）
数据占位符定义（Data Placeholder Definition，DPD）

(1)数据模板定义 DTD

语法格式：

数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：

// 属性名   name
// 生成规则 rule
// 属性值   value
'name|rule': value

注意：

属性名和生成规则之间用 | 分隔。
生成规则是可选的。
生成规则有 7 种格式：
1. ‘name|min-max’: value
2. ‘name|count’: value
3. ‘name|min-max.dmin-dmax’: value
4. ‘name|min-max.dcount’: value
5. ‘name|count.dmin-dmax’: value
6. ‘name|count.dcount’: value
7. ‘name|+step’: value
生成规则的含义需要依赖属性值才能确定。
属性值中可以含有 @占位符。
属性值还指定了最终值的初始值和类型。

示例：

属性值是字符串 String
- ‘name|min-max’: ‘value’ 通过重复 ‘value’ 生成一个字符串，重复次数大于等于 min，小于等于 max。
- ‘name|count’: ‘value’ 通过重复 ‘value’ 生成一个字符串，重复次数等于 count。
属性值是数字 Number
- ‘name|+1’: 100 属性值自动加 1，初始值为 100
- ‘name|1-100’: 100 生成一个大于等于 1、小于等于 100 的整数，属性值 100 只用来确定类型。
- ‘name|1-100.1-10’: 100 生成一个浮点数，整数部分大于等于 1、小于等于 100，小数部分保留 1 到 10 位。

 {
	     '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
	 }

属性值是布尔型 Boolean
- ‘name|1’: value 随机生成一个布尔值，值为 true 的概率是 1/2，值为 false 的概率是 1/2。
- ‘name|min-max’: value 随机生成一个布尔值，值为 value 的概率是 min / (min + max)，值为 !value 的概率是 max / (min + max)。
属性值是对象 Object
- ‘name|min-max’: {} 从属性值 {} 中随机选取 min 到 max 个属性。
- ‘name|count’: {} 从属性值 {} 中随机选取 count 个属性。
属性值是数组 Array
- ‘name|1’: [{}, {} …] 从属性值 [{}, {} …] 中随机选取 1 个元素，作为最终值。
- ‘name|min-max’: [{}, {} …] 通过重复属性值 [{}, {} …] 生成一个新数组，重复次数大于等于 min，小于等于 max。
- ‘name|count’: [{}, {} …] 通过重复属性值 [{}, {} …] 生成一个新数组，重复次数为 count。
属性值是数组 Function
- ‘name’: function(){} 执行函数 function(){}，取其返回值作为最终的属性值，上下文为 ‘name’ 所在的对象。

(2)数据占位符定义 DPD

占位符只是在属性值字符串中占个位置，并不出现在最终的属性值中。占位符的格式为：

@占位符
@占位符(参数 [, 参数])