Moa-api：一个基于node express快速开发api类后端的框架
eg756
9年前
目前是让开发可以快速的开发api类后端，开箱即用，可以最大程度发挥node express的威力
技术栈
- express
- mongoose
- bluebird
- res.api
Features
- 自动加载路由
- 支持mongodb配置
- 集成mongoosedao，快速写crud等dao接口
- 自带用户管理
- 使用jsonwebtoken做用户鉴权
- 支持migrate测试
- 支持mocha测试
- 默认集成res.api，便于写接口
- 集成supervisor，代码变动，自动重载
- gulp自动监控文件变动，跑测试
- gulp routes生成路由说明
开发流程
- 确定models内容，如果是已有库或已有模型，可以直接使用
- 编写接口文档
- 通过migrate来测试model里的方法（如果测试熟悉，可以直接写测试）
- 通过supertest来测试接口（R层）是否合法
- 通过mocha测试其他业务代码（C层、S层、M层）
RCSM分层思想
R = routes
路由层，和express的一样，唯一不一样的是只要是在app/routes下面的js都会自动挂载到路由上。
比如app/routes/user.js,它的访问地址是
比如app/routes/api/user.js,它的访问地址是
http://127.0.0.1:3000/api/user
然后路由里面的子地址，参照express路由写法即可。
典型用法是
var express = require('express'); var router = express.Router(); var $ = require('mount-controllers')(__dirname).users_controller; /* GET users listing. */ router.get('/login', $.api.login); router.get('/register', function(req, res, next) { return res.api(200,{ a:'register' }); }); module.exports = router;从使用上来说，router.get('/login', $.api.login);这个是最合理最常用的的。
但如果是逻辑非常简单的路由，随便写写也无妨
C = controllers
控制层，主要是负责接口处理结果如何返回，异常如何处理等逻辑控制，不处理具体逻辑
var users_service = require('mount-services')(__dirname).users_service; // -- custom api exports.api = { login: function (req, res, next) { // var user_id = req.api_user._id; var is_valid = users_service.login_valid('sang', '000000'); if(is_valid == true){ return res.api(200,{ a:'login true' }); }else{ return res.api(200,{ a:'login false ' }); } } }说明：控制层的代码只会在R层里用到
S = services
业务逻辑层，通常业务比较负责才会用到业务逻辑层的，如果是单表能处理的，就没有必要使用services层了，所以S层通常是多个models操作的业务逻辑，为了逻辑清晰，以及防止C层膨胀，和耦合，S层很多时候是必要的。
说明：S层只会出现在C层代码里，是对多个models操作的封装。
M = models
模型层，也就是我们常说的dao层，即data access object，这里采用mongoose + mongoosedao完成model层建模
说明：M层可能出现在S层或C层，不允许出现在其他位置