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

时间 2019-11-05

标签 5分 nodejs 手写一个 mock 数据服务器繁體版

原文原文链接

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

咱们将学到

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

mock服务器基本设计思路

经过目录路径和服务端api的映射关系来实现咱们的api访问，好比咱们访问接口/api/article/122，咱们只须要在mock服务期目录的api的article目录下，建立122.json文件便可，json文件的数据能够自定义，方便前端调试。前端

具体实现

1.搭建一个node服务vue

const Koa = require('koa');
const app = new Koa();
app.listen(3000)
复制代码

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

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

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

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());
复制代码

这样，咱们每一个请求都会在终端打印出来。git

路由映射文件的生成该功能也不是本文的重点，可是会极大的方便前端开发者调试请求，由于若是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('路由地图生成成功！')
    }
});

复制代码

基本目录结构

完整代码

clone地址 github地址github

欢迎你们相互学习交流，一块儿探索前端的边界。web