快捷導(dǎo)航

5分鐘教你用nodeJS手寫(xiě)一個(gè)mock數(shù)據(jù)服務(wù)器的方法

更新時(shí)間：2019年09月10日 14:18:40 作者：趣談前端

這篇文章主要介紹了5分鐘教你用nodeJS手寫(xiě)一個(gè)mock數(shù)據(jù)服務(wù)器的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

對(duì)于前端開(kāi)發(fā)者而言，javascript正扮演著越來(lái)越重要的地位，它不僅能為瀏覽器端賦能，在web服務(wù)器方面也有很大的價(jià)值（我們可以用nodeJS來(lái)寫(xiě)服務(wù)端代碼，啟動(dòng)web服務(wù)器），因此本文所要描述的，便是javascript在服務(wù)端的應(yīng)用。我將介紹如何使用nodeJS來(lái)搭建一個(gè)mock服務(wù)器，方便前端自定義mock數(shù)據(jù)請(qǐng)求，提高前端開(kāi)發(fā)的主觀能動(dòng)性和對(duì)項(xiàng)目健壯性的探索。

我們將學(xué)到

koa基本使用
koa-router的基本用法
koa-logger的使用
glob支持文件遍歷查尋
node幾個(gè)核心api的使用
使用nodemon做自動(dòng)重啟

mock服務(wù)器基本設(shè)計(jì)思路

通過(guò)目錄路徑和服務(wù)端api的映射關(guān)系來(lái)實(shí)現(xiàn)我們的api訪問(wèn)，比如我們?cè)L問(wèn)接口/api/article/122，我們只需要在mock服務(wù)器目錄的api的article目錄下，創(chuàng)建122.json文件即可，json文件的數(shù)據(jù)可以自定義，方便前端調(diào)試。

具體實(shí)現(xiàn)

1.搭建一個(gè)node服務(wù)

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

2.注冊(cè)路由我們使用koa-router來(lái)實(shí)現(xiàn)后臺(tái)服務(wù)的路由功能，并通過(guò)koa提供的上下文ctx將讀取到的數(shù)據(jù)返回給前端：

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)

這樣我們就能實(shí)現(xiàn)一個(gè)勉強(qiáng)能用的基本的后臺(tái)api服務(wù)器了，當(dāng)我們請(qǐng)求/api/name時(shí)，會(huì)返回相應(yīng)的數(shù)據(jù)給前臺(tái)，這一步是我們實(shí)現(xiàn)mock服務(wù)的關(guān)鍵一步，接下來(lái)我們具體來(lái)實(shí)現(xiàn)目錄的遍歷和api的自動(dòng)注冊(cè)。

3.自動(dòng)注冊(cè)api接口并返回?cái)?shù)據(jù) 我們將在這個(gè)階段實(shí)現(xiàn)api服務(wù)的自動(dòng)注冊(cè)，這里我們使用glob這個(gè)第三方模塊來(lái)遍歷目錄，并通過(guò)node的fs模塊讀取api文件的數(shù)據(jù)并返回給前臺(tái)。glob的使用很簡(jiǎn)單，感興趣的朋友可以自行學(xué)習(xí)，這里就不做過(guò)多介紹了。具體實(shí)現(xiàn)如下：

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'});
 
// 注冊(cè)路由
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' // 自定義響應(yīng)體
      }
    }catch(err) {
      ctx.throw('服務(wù)器錯(cuò)誤', 500);
    }
   });
});
 
app
 .use(router.routes())
 .use(router.allowedMethods());
 
app.listen(3000);

添加控制臺(tái)日志我們使用koa-logger實(shí)現(xiàn)在終端打印node日志，方便調(diào)試，雖然這不是該文章的重點(diǎn)，但是對(duì)于想做node開(kāi)發(fā)的前端從業(yè)者，還是很有必要了解的。

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

這樣，我們每個(gè)請(qǐng)求都會(huì)在終端打印出來(lái)。

路由映射文件的生成該功能也不是本文的重點(diǎn)，但是會(huì)極大的方便前端開(kāi)發(fā)者調(diào)試請(qǐng)求，因?yàn)槿绻鸻pi路徑很長(zhǎng)，我們需要一個(gè)個(gè)查找，但是有了這個(gè)map文件，我們只需要拷貝自動(dòng)生成的路徑即可。具體實(shí)現(xiàn)如下：

//...
const routerMap = {}; // 存放路由映射
 
// 注冊(cè)路由
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('路由地圖生成成功！')
  }
});

基本目錄結(jié)構(gòu)