yf-fpm-server

CHANGELOG

点击查看更新日志 CHANGELOG

ROADMAP

点击查看 ROADMAP

0.OVERVIEW

yf-fpm-server是一款轻量级的api服务端，可通过插件集成数据库(mysql,mongodb)的数据操作，灵活扩展自定义业务逻辑

• 源码地址: https://github.com/team4yf/yf-fpm-server.git
• 微内核，源码
• 基于koa2框架
• 支持key + secret安全验证
• 支持接口权限验证
• 支持hook钩子扩展
• 支持接口多版本同时在线

设计概要

　背景

团队的产品从单平台，慢慢扩展到多个客户端，且有多个异构系统的数据交互，所以需要一个统一的数据输入输出口。

• Node 作为一个事件驱动的V8服务端语言，非常适合处理高并发，非事务密集型的场景。
• 使用koa2作为http框架，因为它够轻，够简洁，几乎没有学习成本，而且体积小，自然坑也少 [偷笑]。
• 没有使用restful风格，因为业务需要对数据有权限限制，而且业务交集很多，对路由的管理成本就大。
• 采用taobao和jd的开放平台的设计方案，定义统一的入口，通过参数定位业务接口，实现灵活的业务开发。

　定义

　　　　服务只有一个入口 /api ; 只接受application/json方式的请求,定义如下

• 传入参数结构

• 输出参数结构

　　这样的设计不能满足现在的restful范式，但是能满足小规模团队的需求，可提高业务实现的开发效率；

1.Install

$ npm install yf-fpm-server --save

2.Code

$ vi app.js

'use strict';
const { Fpm } = require('yf-fpm-server');
const fpm = new Fpm();
const biz = fpm.createBiz('0.0.1');
biz.addSubModules('test', {
  foo: async (args, ctx, before) => {
    return Promise.reject({errno: -3001})
  }
});
fpm.addBizModules(biz);
fpm.run()
  .then(() => {
    fpm.logger.info('ready ...')
  });

3.Run It

$ node app.js

4.Global Error Define

System 系统错误定义