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请求，测试是否可正常返回数据

  
  Postman测试

总结

简单上手后，发现node.js实现后台开发比较便捷、轻巧。对简单后台需求（尤其对于前端人员）比较友好，值得学习。

Tip

• 理解原生JS中require的使用
• 掌握 async awiat 异步请求方式的使用
• 后续可加入权限校验等优化功能
• 使用Node.js进行企业级web后台开发，可参考egg.js

参考资料

Koa官网
廖雪峰Koa教程