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

作者:慢半拍时间:2026-10-23 10:59:07浏览:405

本文详细介绍如何使用Node.js和Koa框架搭建一个轻量级的Mock数据服务器。通过结合koa-router、glob模块以及fs文件系统API,实现根据JSON文件自动注册路由并返回数据的功能。教程涵盖服务搭建、路由配置、日志记录及目录遍历等核心步骤,帮助前端开发者提升调试效率与项目健壮性。

Node.js Mock服务器概述

对于前端开发者而言,JavaScript正扮演着越来越重要的角色。它不仅能为浏览器端赋能,在Web服务器方面也有很大价值,例如我们可以使用Node.js编写服务端代码并启动Web服务器。因此,本文旨在探讨JavaScript在服务端的应用,具体介绍如何使用Node.js搭建一个Mock服务器,以便前端开发者自定义Mock数据请求,从而提高前端开发的主观能动性以及对项目健壮性的探索能力。

我们将学习以下内容:

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

Mock服务器设计思路

Mock服务器基本设计思路

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

Node.js Mock服务器概述

具体实现步骤

具体实现步骤如下:

搭建Node服务

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的自动注册。

自动注册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('路由地图生成成功!')
  }
});

目录结构与完整代码

基本目录结构

Node.js Mock服务器概述

完整代码

Clone地址 GitHub地址

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

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

作者最新文章