5分钟教你用nodeJS手写一个mock数据服务器的方法
对于前端开发者而言，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);
添加控制台日志 我们使用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('路由地图生成成功！')
}
});
基本目录结构
完整代码
clone地址 github地址
https://github.com/MrXujiang/openCoder/tree/master/mockServer
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
从目前我了解的情况来看，前后端跨域使用的方式有很多种，这里记录我使用最顺手的一种，即在后端使用cors跨域，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-08-08
这篇文章主要给大家介绍了关于利用node转发请求的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-09-09
基于NodeJS的前后端分离的思考与实践（四）安全问题解决方案
本文就在前后端分离模式的架构下，针对前端在Web开发中，所遇到的安全问题以及应对措施和注意事项，并提出解决方案。2014-09-09
Linux下为Node.js程序配置MySQL或Oracle数据库的方法
这篇文章主要介绍了Linux下为Node.js程序配置MySQL或Oracle数据库的方法,这里默认已经装配好了Node环境然后我们利用npm包管理工具来进行配置,需要的朋友可以参考下2016-03-03
这篇文章主要介绍了koa-passport实现本地验证的方法示例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-02-02
Mongoose 是在nodejs环境下，对mongodb进行便捷操作的对象模型工具。本文介绍解（翻）密（译）Mongoose插件。这篇文章给大家详细介绍了Nodejs mongoose 的相关知识，感兴趣的朋友一起看看吧2018-06-06
大家都知道在yarn发布之前，所有Nodejs开发者用的都是npm包管理工具，而npm工具存在挺多难以忍受的诟病，包括安装速度慢、每次都要在线重新安装等问题，而yarn也是为了解决npm当前所存在的问题而出现的。本文给大家介绍了包管理器Yarn，以及安装方法。下面来一起看看。2016-10-10
这篇文章主要介绍了使用Node.js为其他程序编写扩展的基本方法 ,文中示例是通过Node让JavaScript代码与C++应用产生交互,需要的朋友可以参考下2015-06-06
NVM是Node.js的版本管理工具,可以方便地在不同版本的Node.js之间切换,本文主要介绍了简单易懂的nvm和Node.js版本控制的实现,具有一定的参考价值,感兴趣的可以了解一下2023-10-10
Yarn是facebook发布的一款取代npm的包管理工具,本文给大家介绍yarn的安装和使用全网最详细教程,感兴趣的朋友一起看看吧2023-12-12
最新评论