这是我参与更文挑战的第2天,活动详情查看: 更文挑战
模拟后端接口数据Mock.js
Mock解决的问题
前端在开发时,后端接口数据还没完成数据输出,这时候前端可以用mock.js在后台接口未开发完成之前模拟数据,并返回,完成前台的交互。
优点
- 前后端分离 让前端攻城师独立于后端进行开发。
- 开发无侵入 不需要修改既有代码,就可以拦截 Ajax 请求,返回模拟的响应数据。
- 数据类型丰富 支持生成随机的文本、数字、布尔值、日期、邮箱、链接、图片、颜色等。
- 增加单元测试的真实性 通过随机数据,模拟各种场景。
- 用法简单 符合直觉的接口。
- 方便扩展 支持支持扩展更多数据类型,支持自定义函数和正则。
安装
npm install mockjs
语法规范
数据模板定义规范 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
}
- 属性值是布尔型 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"
}
数据占位符定义规范 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"
}
}
vue中使用mock.js
- src新建文件家mock,mock下新建index.js
import Mock from 'mockjs'
const data={
"id":"@guid",
"name":"@cname",
};
Mock.mock('/api/test', 'post', data)
export default Mock;
- 在main.js中引入
import Mock from '@/mock'
- .App.vue中使用
<template>
<div id="app">
<img src="./assets/logo.png">
<span>{{$t("global.test")}}</span>
<button @click="testReq">测试请求</button>
<router-view/>
</div>
</template>
<script>
import Cookie from './util/cookie'
import Axios from 'axios'
export default {
name: 'App',
methods:{
testReq:function(){
Axios.post('/api/test').then((res) => {
console.log(res)
}).catch((err) => {
console.log(err)
})
}
}
}
</script>
<style>
#app {
font-family: 'Avenir', Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
常用数据占位符
//数据占位符使用
{
"integer": "@integer(10, 30)", //随机生成一个10~30之间的正整数
"float": "@float(60, 100, 2, 2)", //随机生成浮点数,参数分别为整数部分最小值和最大值、小数部分保留最小位数和最大位数
"boolean": "@boolean", //随机生成boolean
"string|1-2": "@string", //随机生成字符串
"name":"@cname", //随机生成名字
"date": "@date(yyyy-MM-dd)", //按照格式随机生成时间
"datetime": "@datetime", //随机生成时间
"now": "@now", //当前时间
"id": "@id", //随机生成一个 18 位身份证
"guid": "@guid", //随机生成一个 GUID
"url": "@url", //随机生成url字符串
"email": "@email", //随机生成邮箱
"image": "@image(200x200)", //随机生成一个大小为200x200的图片链接
"title": "@title", //随机生成一句标题,其中每个单词的首字母大写
"upper": "@upper(@title)", //把生随机成的标题全部转为大写
"cparagraph": "@cparagraph", //随机生成一段中文文本
"csentence": "@csentence", //随机生成一段中文文本
"range": "@range(2, 10)" , //返回一个内容从2开始到9的整型数组
"region": "@region", //随机生成地区 华中
"province": "@province", //随机生成省会 省
"city": "@city", //随机生成城市 市
"county": "@county", //随机生成一个(中国)县
}