mockjs语法

Mockjs依赖于Node (CommonJS)平台
Node.js 是一个基于Chrome JavaScript 运行时建立的一个平台
mockjs是Node.js中的一个模块

安装

npm install mockjs

NPM是随同NodeJS一起安装的包管理工具

语法规范

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

生成规则的含义需要依赖属性值的类型才能确定。
属性值中可以含有 @占位符。
属性值还指定了最终值的初始值和类型。

生成规则和示例：

属性值是字符串 String

'name|min-max': string

通过重复 string 生成一个字符串，重复次数大于等于 min，小于等于 max。

'name|count': string

通过重复 string 生成一个字符串，重复次数等于 count。

属性值是数字 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)。

属性值是对象 Object

'name|count': object

从属性值 object 中随机选取 count 个属性。

'name|min-max': object

从属性值 object 中随机选取 min 到 max 个属性。

属性值是数组 Array

'name|1': array

从属性值 array 中随机选取 1 个元素，作为最终值。

'name|+1': array

从属性值 array 中顺序选取 1 个元素，作为最终值。

'name|min-max': array

通过重复属性值 array 生成一个新数组，重复次数大于等于 min，小于等于 max。

'name|count': array

通过重复属性值 array 生成一个新数组，重复次数为 count。

属性值是函数 Function

'name': function

执行函数 function，取其返回值作为最终的属性值，函数的上下文为属性 'name' 所在的对象。

属性值是正则表达式 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
var Mock = require('mockjs')
var Random = Mock.Random
var data = Mock.mock({
   'number1|1-100.1-10': 1,
    'number2|123.1-10': 1,
    'number3|123.3': 1,
    'number4|123.10': 1.123,
name: {
        first: '@FIRST',
        middle: '@FIRST',
        last: '@LAST',
        full: '@first @middle @last'
    }
})
// 输出结果
console.log(JSON.stringify(data, null, 4))
console.log("------------------------------")
console.log(data)
console.log("------------------------------")
console.log(Random.image('200x100', '#ffcc33', '#FFF', 'png', '!'))
console.log("------------------------------")
console.log(Random.character( 'lower/upper/number/symbol' ))
console.log("------------------------------")
console.log(Random.string())

输出结果：

image.png

数据占位符定义规范 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"
}}

Mock.mock( rurl?, rtype?, template|function( options ) )

当拦截到匹配 rurl 和 rtype 的 Ajax 请求时，将根据数据模板 template 生成模拟数据，并作为响应数据返回或者函数 function(options) 将被执行，并把执行结果作为响应数据返回。

rurl

可选。
表示需要拦截的 URL，可以是 URL 字符串或 URL 正则。例如 //domain/list.json/、'/domian/list.json'。

rtype

可选。
表示需要拦截的 Ajax 请求类型。例如 GET、POST、PUT、DELETE 等。

template

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

function(options)

可选。
表示用于生成响应数据的函数。

options

指向本次请求的 Ajax 选项集，含有 url、type 和 body 三个属性。

Mock.Random

Mock.Random 是一个工具类，用于生成各种随机数据。
Mock.Random 的方法在数据模板中称为『占位符』，书写格式为 @占位符(参数 [, 参数]) 。

var Random = Mock.RandomRandom.email()
// => ["[email protected]"](mailto:\)
Mock.mock('@email')
// => ["[email protected]"](mailto:\)
Mock.mock( { email: '@email' } )
// => { email: "[email protected]" }

方法
Mock.Random 提供的完整方法（占位符）如下：

Type	Method
Basic	boolean, natural, integer, float, character, string, range, date, time, datetime, now
Image	image, dataImage
Color	color
Text	paragraph, sentence, word, title, cparagraph, csentence, cword, ctitle
Name	first, last, name, cfirst, clast, cname
Web	url, domain, email, ip, tld
Address	area, region
Helper	capitalize, upper, lower, pick, shuffle
Miscellaneous	guid, id

Basic

Random.boolean( min?, max?, current? )

返回一个随机的布尔值。

Random.natural( min?, max? )

返回一个随机的自然数（大于等于 0 的整数）。

Random.integer( min?, max? )

返回一个随机的整数。

Random.float( min?, max?, dmin?, dmax? )

返回一个随机的浮点数。

Random.character( pool? )

返回一个随机字符。

Random.string( pool?, min?, max? )

返回一个随机字符串。

Random.range( start?, stop, step? )

返回一个整型数组。

Date

Random.date( format? )

返回一个随机的日期字符串。

Random.time( format? )

返回一个随机的时间字符串

Random.datetime( format? )

返回一个随机的日期和时间字符串。

Random.now( unit?, format? )

返回当前的日期和时间字符串

Image

Random.image( size?, background?, foreground?, format?, text? )

生成一个随机的图片地址。

Random.dataImage( size?, text? )

生成一段随机的 Base64 图片编码。

Color

Random.color()

随机生成一个有吸引力的颜色，格式为 '#RRGGBB'。

Random.hex()

随机生成一个有吸引力的颜色，格式为 '#RRGGBB'。

Random.rgb()

随机生成一个有吸引力的颜色，格式为 'rgb(r, g, b)'。

Random.rgba()

随机生成一个有吸引力的颜色，格式为 'rgba(r, g, b, a)'。

Random.hsl()

随机生成一个有吸引力的颜色，格式为 'hsl(h, s, l)'。

Text

Random.paragraph( min?, max? )

随机生成一段文本。

Random.cparagraph( min?, max? )

随机生成一段中文文本。

Random.sentence( min?, max? )

随机生成一个句子，第一个单词的首字母大写。

Random.csentence( min?, max? )

随机生成一段中文文本。

Random.word( min?, max? )

随机生成一个单词。

Random.cword( pool?, min?, max? )

随机生成一个汉字。

Random.title( min?, max? )

随机生成一句标题，其中每个单词的首字母大写。

Random.ctitle( min?, max? )

随机生成一句中文标题。

Name

Random.first()

随机生成一个常见的英文名。

Random.last()

随机生成一个常见的英文姓。

Random.name( middle? )

随机生成一个常见的英文姓名

Random.cfirst()

随机生成一个常见的中文名。

Random.clast()

随机生成一个常见的中文姓。

Random.cname()

随机生成一个常见的中文姓名。

Web

Random.url( protocol?, host? )

随机生成一个 URL。

Random.protocol()

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

Random.domain()

随机生成一个域名。

Random.tld()

随机生成一个顶级域名（Top Level Domain）。

Random.email( domain? )

随机生成一个邮件地址。

Random.ip()

随机生成一个 IP 地址。

Address

Random.region()

随机生成一个（中国）大区。

Random.province()

随机生成一个（中国）省（或直辖市、自治区、特别行政区）。

Random.city( prefix? )

随机生成一个（中国）市。

Random.county( prefix? )

随机生成一个（中国）县。

Random.zip()

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

Helper

Random.capitalize( word )

把字符串的第一个字母转换为大写。

Random.upper( str )

把字符串转换为大写。

Random.lower( str )

把字符串转换为小写。

Random.pick( arr )

从数组中随机选取一个元素，并返回。

Random.shuffle( arr )

打乱数组中元素的顺序，并返回。

Miscellaneous

Random.guid()

随机生成一个 GUID。

Random.id()

随机生成一个 18 位身份证。

Random.increment( step? )

生成一个全局的自增整数。

Mock.valid( template, data )

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

Mock.toJSONSchema( template )

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

更多示例请查看如下地址:
http://mockjs.com/examples.html