5分钟教你用nodeJS手写一个mock数据服务器的方法


Posted in NodeJs onSeptember 10, 2019

对于前端开发者而言,javascript正扮演着越来越重要的地位,它不仅能为浏览器端赋能,在web服务器方面也有很大的价值(我们可以用nodeJS来写服务端代码,启动web服务器),因此本文所要描述的,便是javascript在服务端的应用。我将介绍如何使用nodeJS来搭建一个mock服务器,方便前端自定义mock数据请求,提高前端开发的主观能动性和对项目健壮性的探索。

我们将学到

  • koa基本使用
  • koa-router的基本用法
  • koa-logger的使用
  • glob支持文件遍历查寻
  • node几个核心api的使用
  • 使用nodemon做自动重启

mock服务器基本设计思路

通过目录路径和服务端api的映射关系来实现我们的api访问,比如我们访问接口/api/article/122,我们只需要在mock服务器目录的api的article目录下,创建122.json文件即可,json文件的数据可以自定义,方便前端调试。

5分钟教你用nodeJS手写一个mock数据服务器的方法

具体实现

1.搭建一个node服务

const Koa = require('koa');
const app = new Koa();
app.listen(3000)

2.注册路由 我们使用koa-router来实现后台服务的路由功能,并通过koa提供的上下文ctx将读取到的数据返回给前端:

const Koa = require('koa');
const Router = require('koa-router');
 
const app = new Koa();
const router = new Router({prefix: '/api'});
 
router.get('/name', (ctx, next) => {
  ctx.body = {
    name: 'xuxiaoxi'
  }
 });
 
app
 .use(router.routes())
 .use(router.allowedMethods());
 
app.listen(3000)

这样我们就能实现一个勉强能用的基本的后台api服务器了,当我们请求/api/name时,会返回相应的数据给前台,这一步是我们实现mock服务的关键一步,接下来我们具体来实现目录的遍历和api的自动注册。

3.自动注册api接口并返回数据 我们将在这个阶段实现api服务的自动注册,这里我们使用glob这个第三方模块来遍历目录,并通过node的fs模块读取api文件的数据并返回给前台。glob的使用很简单,感兴趣的朋友可以自行学习,这里就不做过多介绍了。具体实现如下:

const Koa = require('koa');
const Router = require('koa-router');
const glob = require("glob");
const { resolve } = require('path');
const fs = require('fs');
 
const app = new Koa();
const router = new Router({prefix: '/api'});
 
// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
  let apiJsonPath = item && item.split('/api')[1];
  let apiPath = apiJsonPath.replace('.json', '');
  
  router.get(apiPath, (ctx, next) => {
    try {
      let jsonStr = fs.readFileSync(item).toString();
      ctx.body = {
        data: JSON.parse(jsonStr),
        state: 200,
        type: 'success' // 自定义响应体
      }
    }catch(err) {
      ctx.throw('服务器错误', 500);
    }
   });
});
 
app
 .use(router.routes())
 .use(router.allowedMethods());
 
app.listen(3000);

添加控制台日志 我们使用koa-logger实现在终端打印node日志,方便调试,虽然这不是该文章的重点,但是对于想做node开发的前端从业者,还是很有必要了解的。

const logger = require('koa-logger')
app.use(logger());

这样,我们每个请求都会在终端打印出来。

路由映射文件的生成 该功能也不是本文的重点,但是会极大的方便前端开发者调试请求,因为如果api路径很长,我们需要一个个查找,但是有了这个map文件,我们只需要拷贝自动生成的路径即可。具体实现如下:

//...
const routerMap = {}; // 存放路由映射
 
// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
  // ...
  
  // 记录路由
  routerMap[apiJsonPath] = apiPath;
});
 
fs.writeFile('./routerMap.json', JSON.stringify(routerMap, null , 4), err => {
  if(!err) {
    console.log('路由地图生成成功!')
  }
});

基本目录结构

5分钟教你用nodeJS手写一个mock数据服务器的方法

完整代码

clone地址  github地址 

https://github.com/MrXujiang/openCoder/tree/master/mockServer

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

NodeJs 相关文章推荐
NodeJS与Mysql的交互示例代码
Aug 18 NodeJs
Nodejs初级阶段之express
Nov 23 NodeJs
基于nodejs+express(4.x+)实现文件上传功能
Nov 23 NodeJs
详解nodejs与javascript中的aes加密
May 22 NodeJs
Nodejs进阶:基于express+multer的文件上传实例
Nov 21 NodeJs
用nodejs实现json和jsonp服务的方法
Aug 25 NodeJs
Nodejs Express 通过log4js写日志到Logstash(ELK)
Aug 30 NodeJs
Nodejs实现用户注册功能
Apr 14 NodeJs
NodeJS 文件夹拷贝以及删除功能
Sep 03 NodeJs
nodejs实现UDP组播示例方法
Nov 04 NodeJs
Nodejs封装类似express框架的路由实例详解
Jan 05 NodeJs
浅谈Node的内存泄露问题
May 06 NodeJs
NodeJS 文件夹拷贝以及删除功能
Sep 03 #NodeJs
纯异步nodejs文件夹(目录)复制功能
Sep 03 #NodeJs
nodejs文件夹深层复制功能
Sep 03 #NodeJs
Nodejs中使用puppeteer控制浏览器中视频播放功能
Aug 26 #NodeJs
nodejs简单抓包工具使用详解
Aug 23 #NodeJs
nodejs使用node-xlsx生成excel的方法示例
Aug 22 #NodeJs
Nodejs libuv运行原理详解
Aug 21 #NodeJs
You might like
用libtemplate实现静态网页生成
2006/10/09 PHP
不重新编译PHP为php增加openssl模块的方法
2011/06/14 PHP
php实现监听事件
2013/11/06 PHP
PHP使用CURL获取302跳转后的地址实例
2014/05/04 PHP
PHP用FTP类上传文件视频等的简单实现方法
2016/09/23 PHP
php使用高斯算法实现图片的模糊处理功能示例
2016/11/11 PHP
js函数的延迟加载实现代码
2012/10/11 Javascript
Egret引擎开发指南之视觉编程
2014/09/03 Javascript
Node.js实现兼容IE789的文件上传进度条
2016/09/02 Javascript
浅谈jQuery操作类数组的工具方法
2016/12/23 Javascript
Vue监听数据对象变化源码
2017/03/09 Javascript
Vue.js中的图片引用路径的方式
2017/07/28 Javascript
详解vue 数组和对象渲染问题
2018/09/21 Javascript
JS 验证码功能的三种实现方式
2018/11/26 Javascript
vue的keep-alive中使用EventBus的方法
2019/04/23 Javascript
vue学习笔记之过滤器的基本使用方法实例分析
2020/02/01 Javascript
浅析JavaScript 函数防抖和节流
2020/07/13 Javascript
python中使用xlrd、xlwt操作excel表格详解
2015/01/29 Python
Python批处理删除和重命名文件夹的实例
2018/07/11 Python
WIn10+Anaconda环境下安装PyTorch(避坑指南)
2019/01/30 Python
Python测试模块doctest使用解析
2019/08/10 Python
Python简易版图书管理系统
2019/08/12 Python
python3.7将代码打包成exe程序并添加图标的方法
2019/10/11 Python
使用css3背景渐变中的透明度来设置不同颜色的背景渐变
2014/03/31 HTML / CSS
Java程序员常见面试题
2015/07/16 面试题
幼儿教师自我鉴定
2013/11/02 职场文书
致200米运动员广播稿
2014/02/06 职场文书
转预备党员政审材料
2014/02/06 职场文书
给校长的建议书500字
2014/05/15 职场文书
交通文明倡议书
2014/05/16 职场文书
民警群众路线教育实践活动对照检查材料
2014/10/04 职场文书
2014年人事部工作总结
2014/12/03 职场文书
青年岗位能手事迹材料(2016推荐版)
2016/03/01 职场文书
浅谈pytorch中的dropout的概率p
2021/05/27 Python
使用python求解迷宫问题的三种实现方法
2022/03/17 Python
PYTHON基于Pyecharts绘制常见的直角坐标系图表
2022/04/28 Python