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

徐小夕 等级 89 0 0

对于前端开发者而言,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文件的数据可以自定义,方便前端调试。

具体实现

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

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

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

  2. 路由映射文件的生成 该功能也不是本文的重点,但是会极大的方便前端开发者调试请求,因为如果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('路由地图生成成功!') } });


### 基本目录结构

![](https://img-hello-world.oss-cn-beijing.aliyuncs.com/imgs/c6dc64f16e1526f8c74486a3a3ef7125.png)

### 完整代码
clone地址     [github地址](https://github.com/MrXujiang/openCoder/tree/master/mockServer)

欢迎大家相互学习交流,一起探索前端的边界。


### 更多推荐
* [笛卡尔乘积的javascript版实现和应用](https://juejin.im/post/6844903928577048583)
* [JavaScript 中的二叉树以及二叉搜索树的实现及应用](https://juejin.im/post/6844903906166718471)
* [用 JavaScript 和 C3 实现一个转盘小游戏](https://juejin.im/post/6844903895668375566)
* [教你用200行代码写一个爱豆拼拼乐H5小游戏(附源码)](https://juejin.im/post/6844903893961293831)
* [基于react/vue生态的前端集成解决方案探索与总结](https://juejin.im/post/6844903891893485576)
* [9012教你如何使用gulp4开发项目脚手架](https://juejin.im/post/6844903882124967949)
* [如何用不到200行代码写一款属于自己的js类库)](https://juejin.im/post/6844903880707293198)
* [让你瞬间提高工作效率的常用js函数汇总(持续更新)](https://juejin.im/post/6844903878362660878)
* [一张图教你快速玩转vue-cli3](https://juejin.im/post/6844903877133729799)
* [3分钟教你用原生js实现具有进度监听的文件上传预览组件](https://juejin.im/post/6844903875632168968)
* [3分钟教你用原生js实现具有进度监听的文件上传预览组件](https://juejin.im/post/6844903875632168968)
* [使用Angular8和百度地图api开发《旅游清单》](https://juejin.im/post/6844903873212055560)
* [js基本搜索算法实现与170万条数据下的性能测试](https://juejin.im/post/6844903866610221064)
* [《前端算法系列》如何让前端代码速度提高60倍](https://juejin.im/post/6844903865553256461)
* [《前端算法系列》数组去重](https://juejin.im/post/6844903863674208269)
*   [vue高级进阶系列——用typescript玩转vue和vuex](https://juejin.im/post/6844903831956897806)
* [前端三年,谈谈最值得读的5本书籍](https://juejin.im/post/6844903824788815879)
预览图
收藏
评论区