Node後臺開發

前言

• 有時需要實現對公網接口進行轉發的操作，使用Java + SpringBoot可能會變得簡單需求變得更加繁瑣，針對這種輕量級後臺開發，Node.js不失爲一種優秀的解決方案。
• 對於前端開發人員，使用原生JS + Node.js即可實現簡單的後臺開發，上手速度快，也可以鍛鍊自己成爲全站(棧)工程師。

開發環境

• Node.js環境（v7.6.0+）
• Koa2框架（Koa 依賴 node v7.6.0 或 ES2015及更高版本和 async 方法支持）
• 原生JS語法（ES6+ 較好）

起步

於吾言，較喜歡將項目標準化，一方面加深對項目運行的理解，另一方面使後續開發更加便捷、易於擴展。

開發簡單標準化後臺可遵循以下步驟（針對簡單Node起步項目）：

• 創建package.json（引入項目所需依賴庫，配置項目基本信息）
• 創建app.js啓動文件（項目入口文件）
• 創建controller.js及controllers目錄下index.js（實現對前端訪問接口映射，以調用對應方法返回數據）
• 創建axiosHttp.js（該項目需要實現接口轉發，採用axios庫來發起http請求）
• 實現現有文件的相關功能（可根據實際需求繼續擴展功能模塊）

具體實現

• package.json

{
  "name": "hello-koa2",
  "version": "1.0.0",
  "description": "Hello Koa 2 example with async",
  "main": "app.js",
  "scripts": {
    "start": "node app.js"
  },
  "author": "Da Jiangyou",
  "dependencies": {
    "koa": "^2.7.0",
    "koa2-cors": "^2.0.6",
    "koa-router": "7.0.0",
    "koa-bodyparser": "3.2.0",
    "axios": "^0.19.0"
  }
}

koa             Koa框架基礎核心組件庫
koa2-cors       Koa跨域等參數設置組件庫
koa-router      Koa處理URL映射組件庫
koa-bodyparser  Koa解析Post攜帶表單、JSON組件庫

• app.js

const Koa = require('koa')
const Cors = require('koa2-cors')
const controller = require('./controller');
const app = new Koa()
// 允許跨域
app.use(Cors({
  origin: function (ctx) {
    return "*" //允許所有跨域
  },
  maxAge: 5,
  // credentials: true,
  allowMethods: ['GET', 'POST'] // 允許請求方法
}))
// 使用控制器
app.use(controller())
// 監聽端口
app.listen(3000)
console.log('app started at port 3000...')

• index.js

const axiosHttp = require('../axios/axiosHttp')
// 處理URL請求，返回結果
const getPicture_infinity = async (ctx, next) => {
  const res = await axiosHttp.getInfinityPicture()
  ctx.response.body = res.data
};

module.exports = {
  'POST /winter/infinity/getPictures': getPicture_infinity
}

• controller.js

const fs = require('fs'); // 文件操作庫
// 處理請求種類
function addMapping(router, mapping) {
    for (var url in mapping) {
        if (url.startsWith('GET ')) {
            var path = url.substring(4);
            router.get(path, mapping[url]);
            console.log(`register URL mapping: GET ${path}`);
        } else if (url.startsWith('POST ')) {
            var path = url.substring(5);
            router.post(path, mapping[url]);
            console.log(`register URL mapping: POST ${path}`);
        } else {
            console.log(`invalid URL: ${url}`);
        }
    }
}

function addControllers(router) {
    var files = fs.readdirSync(__dirname + '/controllers');
    var js_files = files.filter((f) => {
        return f.endsWith('.js');
    });

    for (var f of js_files) {
        console.log(`process controller: ${f}...`)
        let mapping = require(__dirname + '/controllers/' + f)
        addMapping(router, mapping);
    }
}

module.exports = function (dir) {
    let
        controllers_dir = dir || 'controllers', // 如果不傳參數，掃描目錄默認爲'controllers'
        router = require('koa-router')();
    addControllers(router, controllers_dir);
    return router.routes();
};

• axiosHttp.js

const axios = require('axios')

// Infinity相關
const infinityPictureUrl = 'https://infinity-api.infinitynewtab.com/get-wallpaper?page=0&source=Infinity'

// 獲取Infinity圖片
function getInfinityPicture () {
  return axios.get(infinityPictureUrl)
}

module.exports = {
  'getInfinityPicture': getInfinityPicture
}

測試

• 在項目目錄下運行 node app.js或npm run start（package.json中可配置）運行項目

  
  

• 使用Postman發送post請求，測試是否可正常返回數據

  
  

總結

簡單上手後，發現node.js實現後臺開發比較便捷、輕巧。對簡單後臺需求（尤其對於前端人員）比較友好，值得學習。

Tip

• 理解原生JS中require的使用
• 掌握 async awiat 異步請求方式的使用
• 後續可加入權限校驗等優化功能
• 使用Node.js進行企業級web後臺開發，可參考egg.js

參考資料

Koa官網
廖雪峯Koa教程