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