Mockjs

Mockjs 是一种用于前端开发的数据模拟工具,支持 Node.js、Bower 和 RequireJS。它包含数据模板定义(DTD)和数据占位符定义(DPD)规范。DTD 规范包括字符串、数字、布尔值、对象、数组、函数和正则表达式的生成规则。Mock.setup 方法用于配置 Ajax 请求的拦截行为,如响应时间和自定义设置。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

开始 & 安装

Node (CommonJS)

# 安装
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))

Bower

# 安装
npm install -g bower
bower install --save mockjs
<script type="text/javascript" src="./bower_components/mockjs/dist/mock.js"></script>

RequireJS (AMD)

// 配置 Mock 路径
require.config({
    paths: {
        mock: 'http://mockjs.com/dist/mock'
    }
})
// 加载 Mock
require(['mock'], function(Mock){
    // 使用 Mock
    var data = Mock.mock({
        'list|1-10': [{
            'id|+1': 1
        }]
    })
    // 输出结果
    document.body.innerHTML +=
        '<pre>' +
        JSON.stringify(data, null, 4) +
        '</pre>'
})
// ==>
{
    "list": [
        {
            "id": 1
        },
        {
            "id": 2
        },
        {
            "id": 3
        }
    ]
}

语法规范

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

  1. 数据模板定义规范(Data Template Definition,DTD)
  2. 数据占位符定义规范(Data Placeholder Definition,DPD)

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

生成规则和示例:

1. 属性值是字符串 String

  1. 'name|min-max': string

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

  2. 'name|count': string

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

2. 属性值是数字 Number

  1. 'name|+1': number

    属性值自动加 1,初始值为 number

  2. 'name|min-max': number

    生成一个大于等于 min、小于等于 max 的整数,属性值 number 只是用来确定类型。

  3. '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

  1. 'name|1': boolean

    随机生成一个布尔值,值为 true 的概率是 1/2,值为 false 的概率同样是 1/2。

  2. 'name|min-max': value

    随机生成一个布尔值,值为 value 的概率是 min / (min + max),值为 !value 的概率是 max / (min + max)

4. 属性值是对象 Object

  1. 'name|count': object

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

  2. 'name|min-max': object

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

5. 属性值是数组 Array

  1. 'name|1': array

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

  2. 'name|+1': array

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

  3. 'name|min-max': array

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

  4. 'name|count': array

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

6. 属性值是函数 Function

  1. 'name': function

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

7. 属性值是正则表达式 RegExp

  1. '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

占位符 只是在属性值字符串中占个位置,并不出现在最终的属性值中。

占位符 的格式为:

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

注意:

  1. 用 @ 来标识其后的字符串是 占位符
  2. 占位符 引用的是 Mock.Random 中的方法。
  3. 通过 Mock.Random.extend() 来扩展自定义占位符。
  4. 占位符 也可以引用 数据模板 中的属性。
  5. 占位符 会优先引用 数据模板 中的属性。
  6. 占位符 支持 相对路径 和 绝对路径
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.setup( settings )

  • Mock.setup( settings )

配置拦截 Ajax 请求时的行为。支持的配置项有:timeout

settings

必选。

配置项集合。

timeout

可选。

指定被拦截的 Ajax 请求的响应时间,单位是毫秒。值可以是正整数,例如 400,表示 400 毫秒 后才会返回响应内容;也可以是横杠 '-' 风格的字符串,例如 '200-600',表示响应时间介于 200 和 600 毫秒之间。默认值是'10-100'

Mock.setup({
    timeout: 400
})
Mock.setup({
    timeout: '200-600'
})

目前,接口 Mock.setup( settings ) 仅用于配置 Ajax 请求,将来可能用于配置 Mock 的其他行为。

### 如何使用 Mock.js 进行数据模拟 #### 安装 Mock.js 库 为了能够在项目中使用 Mock.js,首先需要安装该库。可以通过 npm 或者 yarn 来安装: ```bash npm install mockjs --save-dev ``` 或者 ```bash yarn add mockjs --dev ``` #### 配置 Mock 数据文件 在 Vue 项目的 `src` 文件夹下创建一个新的名为 `mock` 的目录,并在此目录内建立一个 JavaScript 文件用于配置所有的 API 模拟逻辑。 ```javascript // src/mock/index.js import Mock from 'mockjs'; const data = Mock.mock({ 'list|1-10': [{ 'id|+1': 1, 'name': '@cname', 'age|18-60': 1 }] }); Mock.mock('/api/users', 'get', () => { return { code: 200, message: 'success', result: data.list }; }); ``` 这段代码定义了一个简单的用户列表接口 `/api/users` ,它会返回一组由 Mock.js 自动生成的数据[^1]。 #### 导入 Mock 到主程序入口处 为了让整个应用程序能够识别到这些模拟的 API 路径,在 main.js 中引入刚刚创建好的 index.js 文件即可让其生效。 ```javascript // src/main.js import './mock'; // 加载mock服务 ... new Vue({...}) ``` 通过这种方式设置后,当发起 GET 请求至 `/api/users` 地址时就会触发上述自定义的响应处理函数。 #### Axios 实践中的应用 如果正在使用的 HTTP 工具是 axios,则可以进一步优化以确保每次请求都能被拦截下来并通过 Mock 处理。可以在 axios 默认配置里加入如下所示的内容: ```javascript // src/utils/axios.js import axios from 'axios'; import MockAdapter from 'axios-mock-adapter'; import { userLogin } from '../mock/api'; const instance = new axios.create(); if (process.env.NODE_ENV === 'development') { let mock = new MockAdapter(instance); mock.onPost('/login').reply(config => { return Promise.resolve([200, userLogin()]); }); } export default instance; ``` 这里展示了如何利用 `MockAdapter` 对象来监听特定 URL 并给予预设的回答。注意这里的条件判断是为了保证只在开发环境中启用此功能[^3]。 #### 总结与优势分析 采用 Mock.js 不仅可以让前端开发者摆脱对于实际服务器环境依赖的问题,而且还可以轻松实现各种复杂场景下的测试需求。由于支持多种类型的动态生成机制以及良好的兼容性和易用性等特点使得这项技术成为现代 Web 开发过程中不可或缺的一部分[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值