文章内容整理于互联网,方便学习

一、学前预热

为了做到前后端并行开发,数据mock就成为环境搭建的重要一环

1.1 Web应用前后端分离

  • 后台向前台提供api接口,只负责数据的提供和计算,而完全不处理展现
  • 前台通过Http(Ajax)请求获取数据, 在浏览器端动态构建界面显示数据

1.2 利用node+express提供模拟数据

  • 优点:可以在浏览器端访问
  • 缺点:如果是打包发布就无法访问模拟数据, 只能是测试时使用

修改build/dev-server.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//加载json数据
var apiData = require('../src/mock/data.json')
var home = apiData.home;

//得到路由器
var apiRouter = express.Router()

//注册路由
apiRouter.get('/home', function (req, res) {
res.json({
code: 0, //0代表正确数据
data: seller
})
})
//启用路由
app.use('/api', apiRouter)

//访问http://localhost:8080/api/home

1.3 利用mockjs提供模拟数据

mockjs: 用来拦截ajax请求, 生成随机数据返回

  • 优点:不可以在浏览器端访问
  • 缺点:打包发布运行模拟接口也是可以用的
1
2
3
4
5
6
import mock from 'mockjs'  
import apiData from './data.json'

mock.mock('/api2/seller', {code:0, data:apiData.seller})
mock.mock('/api2/goods', {code:0, data:apiData.goods})
mock.mock('/api2/ratings', {code:0, data:apiData.ratings})

1.4 使用postman工具测试接口

  • postman是用来测试api接口的chrome插件
  • postman也是一个活接口文档

1.5 ajax请求mock数据接口

  • vue-resource是用于ajax请求的vue插件
  • axios是浏览器/服务器端通用的ajax请求库
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//使用示例

import VueResource from 'vue-resource'
Vue.use(VueResource)

//组件对象多了$http属性, 使用它发送ajax请求
this.$http.get('/api2/seller').then((response) => {
console.log(response.body)
}, (response) => {
console.log('失败了')
})

import axios from 'axios'
axios.get('/api2/seller').then((response) => {
console.log(response.body)
}, (response) => {
console.log('失败了')
})

二、数据mock思路

  • client端处数据mock
  • servermock
  • 第一种方式拦截了请求的发出,直接返回mock的数据,而第二种方式请求则真实地发出,只是在server端进行route拦截
  • 前后端分离的方式,就是在传统开发模式中加了一个node层,这样数据mock完全可以在node server端完成,基本思路如下

mock

2.1 mock思路说明

  • 只有线下开发模式,才会需要进行数据mock
  • 根据请求的url,拼接形成一个file path
  • 为了避免node缓存,删除require.cache(path)
  • 读取require(path) ,如果该文件不存在或读取失败,则跳转到失败路由。这样简单的数据mock就实现了

2.2 代码描述

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// 伪代码
if (process.env.NODE_ENV === 'development') {
router.set('/api/*', mockapi)
}

function mockapi(req, res, opts) {
var basePath = url.parse(req.url).pathname;

try {
var findPath = require.resolve(prefixPath + basePath + '.js');
delete require.cache[findPath]
var result = require(findPath);
} catch (err) {
return next(err);
}
if (typeof result === 'function') {
return result(req, res, opts);
}
if (typeof result.status === 'undefined' || typeof result.body === 'undefined') {
next(new Error('status 或 body 不存在'))
return;
}
res.writeHead(result.status, {
'Content-Type': 'application/json;charset=UTF-8'
});

res.write(JSON.stringify(result.body))
res.end();
cb()
}

三、mock.js使用详解

3.1 mock.js实现的功能

  • 让前端攻城师独立于后端进行开发
  • 通过随机数据,模拟各种场景
  • 不需要修改既有代码,就可以拦截 Ajax 请求,返回模拟的响应数据
  • 支持生成随机的文本、数字、布尔值、日期、邮箱、链接、图片、颜色等。

3.2 mock安装

3.2.1 node下使用

1
2
# 安装
npm install mockjs
1
2
3
4
5
6
7
8
9
10
11
// 使用 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))

3.2.2 RequireJS (AMD)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 配置 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>'
})

3.3 使用语法

  • mock.js 的语法规范包括两部分
    • 数据模板定义规范
    • 数据占位符定义规范

3.3.1 数据模板定义规范

  • 数据模板中的每个属性由 3 部分构成:属性名、生成规则、属性值
1
2
3
4
// 属性名   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
  • 生成规则 的 含义 需要依赖 属性值的类型 才能确定

  • 属性值 中可以含有 @占位符
  • 属性值 还指定了最终值的初始值和类型

3.3.2 生成规则和示例

  • 属性值是字符串 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,小数部分保留 dmindmax
1
2
3
4
5
6
7
8
9
10
11
12
13
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中随机选取 minmax 个属性
  • 属性值是数组 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 反向生成可以匹配它的字符串。用于生成自定义格式的字符串
1
2
3
4
5
6
7
8
9
10
11
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"
}

3.3.3 数据占位符定义规范

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

  • 占位符 的格式为
1
2
@占位符
@占位符(参数 [, 参数])
  • @来标识其后的字符串是 占位符
  • 占位符 引用的是 mock.Random 中的方法
  • 通过 mock.Random.extend() 来扩展自定义占位符
  • 占位符 也可以引用 数据模板 中的属性
  • 占位符 会优先引用 数据模板 中的属性
  • 占位符 支持 相对路径 和 绝对路径
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
mock.mock({
name: {
first: '@FIRST',
middle: '@FIRST',
last: '@LAST',
full: '@first @middle @last'
}
})
// =>
{
"name": {
"first": "Charles",
"middle": "Brenda",
"last": "Lopez",
"full": "Charles Brenda Lopez"
}
}

3.4 mock.mock()

3.4.1 mock.mock( template )

  • 根据数据模板生成模拟数据
1
2
<!-- (必选)加载 mock -->
<script src="http://mockjs.com/dist/mock.js"></script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
// mock.mock( template )
var template = {
'title': 'Syntax Demo',

'string1|1-10': '★',
'string2|3': 'value',

'number1|+1': 100,
'number2|1-100': 100,
'number3|1-100.1-10': 1,
'number4|123.1-10': 1,
'number5|123.3': 1,
'number6|123.10': 1.123,

'boolean1|1': true,
'boolean2|1-2': true,

'object1|2-4': {
'110000': '北京市',
'120000': '天津市',
'130000': '河北省',
'140000': '山西省'
},
'object2|2': {
'310000': '上海市',
'320000': '江苏省',
'330000': '浙江省',
'340000': '安徽省'
},

'array1|1': ['AMD', 'CMD', 'KMD', 'UMD'],
'array2|1-10': ['mock.js'],
'array3|3': ['mock.js'],

'function': function() {
return this.title
}
}
var data = mock.mock(template)

$('<pre>').text(JSON.stringify(data, null, 4))
.appendTo('body')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
//res
{
"title": "Syntax Demo",
"string1": "★★★",
"string2": "valuevaluevalue",
"number1": 100,
"number2": 48,
"number3": 99.05,
"number4": 123.6,
"number5": 123.516,
"number6": 123.1236370317,
"boolean1": false,
"boolean2": true,
"object1": {
"120000": "天津市",
"130000": "河北省"
},
"object2": {
"320000": "江苏省",
"330000": "浙江省"
},
"array1": "KMD",
"array2": [
"mock.js"
],
"array3": [
"mock.js",
"mock.js",
"mock.js"
],
"function": "Syntax Demo"
}

3.4.2 mock.mock( rurl, template )

  • 记录数据模板。当拦截到匹配 rurlAjax 请求时,将根据数据模板 template生成模拟数据,并作为响应数据返回
1
2
<!-- (必选)加载 mock -->
<script src="http://mockjs.com/dist/mock.js"></script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// mock.mock(rurl, template)
mock.mock(/\.json/, {
'list|1-10': [{
'id|+1': 1,
'email': '@EMAIL'
}]
})
$.ajax({
url: '1.json',
dataType: 'json'
}).done(function(data, status, jqXHR){
$('<pre>').text(JSON.stringify(data, null, 4))
.appendTo('body')
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"list": [
{
"id": 1,
"email": "k.sejuwxvego@xcwc.中国互联.公司"
},
{
"id": 2,
"email": "f.hjns@rhivyrvhpb.ve"
},
{
"id": 3,
"email": "g.bdwuuhm@czoybmyp.ms"
},
{
"id": 4,
"email": "n.tkgs@javvkxz.bf"
}
]
}

3.4.3 mock.mock( rurl, function( options ) )

  • 记录用于生成响应数据的函数。当拦截到匹配 rurlAjax 请求时,函数 function(options)将被执行,并把执行结果作为响应数据返回
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// mock.mock(rurl, function(options))
mock.mock(/\.json/, function(options) {
return options
})
$.ajax({
url: 'hello.json',
dataType: 'json'
}).done(function(data, status, jqXHR) {
$('<pre>').text(JSON.stringify(data, null, 4))
.appendTo('body')
})
$.ajax({
url: 'hello.json',
dataType: 'json',
data: {
foo: 1,
bar: 2,
faz: 3
}
}).done(function(data, status, jqXHR) {
$('<pre>').text(JSON.stringify(data, null, 4))
.appendTo('body')
})
$.ajax({
url: 'hello.json',
type: 'post',
dataType: 'json',
data: {
foo: 1,
bar: 2,
faz: 3
}
}).done(function(data, status, jqXHR) {
$('<pre>').text(JSON.stringify(data, null, 4))
.appendTo('body')
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"url": "hello.json?foo=1&bar=2&faz=3",
"type": "GET",
"body": null
}
{
"url": "hello.json",
"type": "GET",
"body": null
}
{
"url": "hello.json",
"type": "POST",
"body": "foo=1&bar=2&faz=3"
}

3.4.4 mock.setup()

  • mock.setup( settings )
    • 配置拦截 Ajax 请求时的行为。支持的配置项有:timeout

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

1
2
3
4
5
6
mock.setup({
timeout: 400
})
mock.setup({
timeout: '200-600'
})
  • 目前,接口 mock.setup( settings )仅用于配置 Ajax 请求

3.4.5 mock.Random

  • mock.Random 是一个工具类,用于生成各种随机数据
  • mock.Random的方法在数据模板中称为『占位符』,书写格式为 @占位符(参数 [, 参数])
1
2
3
4
5
6
7
var Random = mock.Random
Random.email()
// => "n.clark@miller.io"
mock.mock('@email')
// => "y.lee@lewis.org"
mock.mock( { email: '@email' } )
// => { email: "v.lewis@hall.gov" }

四、简单构建一套mock-server

为了更好的分工合作,让前端能在不依赖后端环境的情况下进行开发,其中一种手段就是为前端开发者提供一个 web 容器,这个本地环境就是 mock-server

一个比较好的 mock-server 该有的能力

  • 与线上环境一致的接口地址,每次构建前端代码时不需要修改调用接口的代码
  • 所改即所得,具有热更新的能力,每次增加修改 mock 接口时不需要重启 mock 服务,更不用重启前端构建服务
  • 能配合 Webpack
  • mock 数据可以由工具生成不需要自己手动写
  • 能模拟 POSTGET 请求

搭建主要思路

json-server 作为 mock 服务器, mock.js 生成mock 数据,利用 gulp + nodemon + browser-sync 监听mock文件的改动重启 node 服务,刷新浏览器,以此达到一种相对完美的 mock-server要求

4.1 json-server 搭配 mock.js

  • 这里以Webpack 的前端工程为例
1
cnpm install json-server mockjs --save
  • 在项目根目录新建 mock文件夹,新建 mock/db.js 作为 mock 数据源,mock/server.js作为 mock 服务,mock/routes.js重写路由表
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
var mock = require('mockjs');

module.exports = {
getComment: mock.mock({
"error": 0,
"message": "success",
"result|40": [{
"author": "@name",
"comment": "@cparagraph",
"date": "@datetime"
}]
}),
addComment: mock.mock({
"error": 0,
"message": "success",
"result": []
})
};
  • 这里我们利用 mock.js 生成 mock 数据,可以尽可能的还原真实数据,还可以减少数据构造的复杂度
1
2
3
4
5
// routes.js
module.exports = {
"/comment/get.action": "/getComment",
"/comment/add.action": "/addComment"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// server.js
const jsonServer = require('json-server')
const db = require('./db.js')
const routes = require('./routes.js')
const port = 3000;

const server = jsonServer.create()
const router = jsonServer.router(db)
const middlewares = jsonServer.defaults()
const rewriter = jsonServer.rewriter(routes)

server.use(middlewares)
// 将 POST 请求转为 GET
server.use((request, res, next) => {
request.method = 'GET';
next();
})

server.use(rewriter) // 注意:rewriter 的设置一定要在 router 设置之前
server.use(router)

server.listen(port, () => {
console.log('open mock server at localhost:' + port)
})
  • 启动服务
1
$ node mock/server.js
  • 打开 http://localhost:3000/comment/get.action即可查看到我们想要的数据

image.png

是不是这样就算搭建完了我们的 mock-server ?不,并没有。我们可以尝试修改一下 db.js 的文件内容,刷新浏览器发现 mock 数据并没有像我们想象的那样修改。那也就是说每次当我们需要添加 /修改 mock 数据使都需要重启一次 mock 服务

4.2 端口代理

通过 Webpack 配置 proxy 代理

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
module.exports = {

devServer: {
//其实很简单的,只要配置这个参数就可以了
proxy: {
'/api/': {
target: 'http://localhost:3000',
changeOrigin: true,
pathRewrite: {
'^/api': ''
}
}
}
}
}
  • 接着在代码里进行 ajax请求就可以写成,这里以 axios 为例子
1
2
3
4
5
function getComments () {
axios.get('api/comment/get.action', {}).then((res) => {
console.log(res.data)
})
}

4.3 文件改动自动刷新

我们希望更改 mock文件能和 webpack 热更新一样,所改即所得。这里我使用了 nodemon,利用 gulp 建立自动执行的任务。

1
cnpm install gulp gulp-nodemon browser-sync --save
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// gulpfile.js 的代码如下
onst path = require('path');
const gulp = require('gulp');
const nodemon = require('gulp-nodemon');
const browserSync = require('browser-sync').create();
const server = path.resolve(__dirname, 'mock');

// browser-sync 配置,配置里启动 nodemon 任务
gulp.task('browser-sync', ['nodemon'], function() {
browserSync.init(null, {
proxy: "http://localhost:8080", // 这里的端口和 webpack 的端口一致
port: 8081
});
});

// browser-sync 监听文件
gulp.task('mock', ['browser-sync'], function() {
gulp.watch(['./mock/db.js', './mock/**'], ['bs-delay']);
});

// 延时刷新
gulp.task('bs-delay', function() {
setTimeout(function() {
browserSync.reload();
}, 1000);
});

// 服务器重启
gulp.task('nodemon', function(cb) {
// 设个变量来防止重复重启
var started = false;
var stream = nodemon({
script: './mock/server.js',
// 监听文件的后缀
ext: "js",
env: {
'NODE_ENV': 'development'
},
// 监听的路径
watch: [
server
]
});
stream.on('start', function() {
if (!started) {
cb();
started = true;
}
}).on('crash', function() {
console.error('application has crashed!\n')
stream.emit('restart', 10)
})
});
  • 这样以后我们在构建我们 Webpack 工程时只需要先执行 npm run dev
  • 之后新建 terminal 执行 gulp mock
  • 就可以搭建一个随改随变的 mock-server 环境

完整的代码详情 https://github.com/poetries/mock-server

转载请保持原始链接

原始链接: https://ru23.com/note/30ed4e0c.html