【前言】

mockjs生成随机数据，实现前后端分离。此文章详细介绍mock的基本用法及所有语法规则。

【基本用法】

安装

npm install mockjs

此处简单说明下，npm安装包时--save-dev、--dev、-S、-D的区别。熟悉者可略过。

--save-dev：安装的包出现在package.json文件dependencies对象中
-S：安装的包出现在package.json文件dependencies对象中
-D：安装的包出现在package.json文件devDependencies对象中
--dev：安装的包出现在package.json文件devDependencies对象中

总结：

--save-dev和-S都有字母s，可理解为save，即为生产依赖dependencies
--dev和-D都有字母d，可理解为*develop*，即为开发依赖devDependencies
webpack不会打包开发依赖
安装依赖后面不加时，默认为安装生产依赖

mock的使用

依据官网的例子，可以总结下：

使用commonjs的require引入mockjs
定义好所需要的数据模板
使用Mock.mock()方法基于数据模板生成所需数据

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

【数据模板-语法】

数据模板语法分类两种：

数据模板定义规范
数据占位符定义规范

一、数据模板定义规范

此部分内容摘抄官方文档，主要用于自己日后查看，记录笔记。熟悉者可跳过。勿喷。

数据模板中的每个属性由 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
生成规则 rule 的含义需要依赖 属性值的类型 才能确定。
属性值 中可以含有 @占位符。
属性值 还指定了最终值的初始值和类型。

生成规则和示例：### 属性值是字符串 String

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,  //生成一个浮点数，整数部分大于等于1、小于等于100，小数部分保留 1 到10位。
    'number2|123.1-10': 1, //生成一个浮点数，整数部分等于123，小数部分保留 1到10 位。
    'number3|123.3': 1, //生成一个浮点数，整数部分大于等于123、小于等于123，小数部分保留 3 位。
    'number4|123.10': 1.123 //生成一个浮点数，整数部分等于123，小数部分保留 10 位。
})
// =>
{
    "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"
}

二、数据占位符定义规范

占位符只是在熟悉值字符中占个位置，最终属性值中不显示

占位符 的格式为：

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

注意：

用 @ 来标识其后的字符串是 占位符。
占位符 引用的是 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"
    }
}

Mock API方法介绍

Mock.mock() 依据数据模板生成数据
Mock.setup() 配置拦截 Ajax 请求时的行为
Mock.Random() 配合占位符语法规范使用

Mock.Random

这里主要记录下 Mock.Random()

语法说明：

? 代表为可选。

1. Random.Basic

Random.boolean( min?, max?, current? ) 返回一个随机的布尔值。可使用参数设置boolean的概率。
Random.natural( min?, max? ) 返回一个随机的自然数（没有min、max时为大于等于 0 的整数）。否则为（大于min小于max的整数）
Random.integer( min?, max? ) 返回一个随机的整数。
Random.float( min?, max?, dmin?, dmax? ) 返回一个随机的浮点数。
Random.character( pool? ) 返回一个随机字符。
Random.string( pool?, min?, max? ) 返回一个随机字符串。pool：表示字符池，将从中选择一个字符返回。min、max字符串长度
Random.range( start, stop?, step? ) 返回一个整型数组。start:必选。数组中整数的起始值。stop：结束。step：步数

2. Random.date

Random.date## ( format? ) 返回一个随机的日期字符串

format 有很多格式可以选择，具体见文档

Random.time( format? ) 时间字符串
Random.datetime( format? ) 返回一个随机的日期和时间字符串
Random.now(unit?, format?) 返回当前的日期和时间字符串

3. Random.image

官方文档

Random.image( size?, background?, foreground?, format?, text? ) 生成图片
Random.dataImage( size?, text? ) 生成一段随机的 Base64 图片编码

4. color

Random.color() 随机生成一个有吸引力的颜色，格式为 '#RRGGBB'
Random.hex() 随机生成一个有吸引力的颜色，格式为 '#RRGGBB'
Random.rgb() 随机生成一个有吸引力的颜色，格式为 'rgb(r, g, b)'
Random.rgba() 随机生成一个有吸引力的颜色，格式为 'rgb(r, g, b, a)'
Random.hsl() 随机生成一个有吸引力的颜色，格式为 'hsl(h, s, l)'

4. Text 文本

Random.paragraph( min?, max? ) 随机生成一段文本。 Random.paragraph( len ) 指示文本中句子的个数。默认值为 3 到 7 之间的随机数。 min,max,文本句子最大个数、最小个数
Random.cparagraph( min, max ) 随机生成一段中文文本 Random.cparagraph( len ) 中文文本的数量。 min,max,文本句子最大个数、最小个数
Random.sentence( min?, max? ) 随机生成一个句子，第一个单词的首字母大写。
Random.csentence( min?, max? ) 随机生成一段中文文本。 Random.csentence(len?)
Random.word( min?, max? ) 随机生成一个单词。
Random.cword( pool?, min?, max? ) 随机生成一个汉字。 pool 汉字池、可以从汉字池中选择一个汉字字符返回。
Random.title( min?, max? ) 随机生成一句标题，其中每个单词的首字母大写。
Random.ctitle( min, max ) 随机生成一句中文标题。

5. Name 姓名

官方文档

Random.first() 随机生成一个常见的英文名。
Random.last() 随机生成一个常见的英文姓。
Random.name( middle ) 随机生成一个常见的英文姓名。
Random.cfirst() 随机生成一个常见的中文名。
Random.clast() 随机生成一个常见的中文姓。
Random.cname()随机生成一个常见的中文姓名。

6. Web Url

Random.url( protocol, host ) 随机生成一个 URL。

protocol：指定 URL 协议。例如 http。

host ：指定 URL 域名和端口号。例如 nuysoft.com。

Random.protocol()

随机生成一个 URL 协议。返回以下值之一：'http'、'ftp'、'gopher'、'mailto'、'mid'、'cid'、'news'、'nntp'、'prospero'、'telnet'、'rlogin'、'tn3270'、'wais'。

Random.domain() 随机生成一个域名。
Random.tld() 随机生成一个顶级域名
Random.email( domain ) 随机生成一个邮件地址。domain 指定邮件地址的域名
Random.ip() 随机生成一个 IP 地址

7. Address 地址

Random.region() 随机生成一个（中国）大区。
Random.province() 随机生成一个（中国）省（或直辖市、自治区、特别行政区）。
Random.city( prefix ) 随机生成一个（中国）市。

prefix，可选。布尔值。指示是否生成所属的省。
Random.county( prefix ) 随机生成一个（中国）县。 prefix可选。布尔值。指示是否生成所属的省、市。
Random.zip()

随机生成一个邮政编码（六位数字）。

8.helper 辅助函数

Random.capitalize(word) 把字符串的第一个字母转换为大写。
Random.upper( str ) 把字符串转换为大写。
Random.lower( str ) 把字符串转换为小写。
Random.pick( arr ) 从数组中随机选取一个元素，并返回。
Random.shuffle( arr ) 打乱数组中元素的顺序，并返回。

9. Miscellaneous 其他

Random.guid() 随机生成一个 GUID
Random.id() 随机生成一个 18 位身份证。
Random.increment( step )生成一个全局的自增整数。

Mock.valid()

Mock.valid( template, data )

校验真实数据 data 是否与数据模板 template 匹配。

template必选。表示数据模板，可以是对象或字符串。例如 { 'list|1-10':[{}] }、'@EMAIL'。

data必选。表示真实数据。

Mock.toJSONSchema( template )

Mock.toJSONSchema( template ) 把 Mock.js 风格的数据模板 template 转换成 JSON Schema。

template

必选。

表示数据模板，可以是对象或字符串。例如 { 'list|1-10':[{}] }、'@EMAIL'。

【总结】

mock主要依据数据模板生成数据
mock的模板语法规范有两种：一、数据模板。二、数据占位符。数据模板的格式为：

'name|string':value

属性名|数据规则：值。数据规则依据值的类型来推定，例如:

'name|min-max':value

数据规则rule为min-max，

当数据值value为string时表示字符的长度，

当数据值为number时表示数值的取值范围。

数据占位符使用的就是Mock.Random()中的方法，在Mock.Random()提供了boolean、number等基本数据类型的规范、Date、Time、文本、段落、姓名、Url、地址等，可灵活配置生成所需数据。

【往期精彩文章】

# 【实操】使用thread-load替换happyPack实现loader多线程

mockjs 零基础、零门槛、一看就会使用指南