datastack - 基於koa的RESTful框架

項目地址: https://github.com/RobinQu/datastackmysql

對開發者友好的輕量級RESTful中間件,基於koa。git

我會陸續放出一下tutorials,這篇文章純屬datastack 101,但願勾起你們的興趣。github

TL;DR

var datastack = require("datastack"),
    koa = require("koa");

var app = koa();
datastack(app, {
  storage: {
    type: "mongodb",
    uri: "mongodb://127.0.0.1:27017/zoo"
  }
});
app.resource("cats");
app.resource("dogs");
app.listen(porcess.env.PORT || 8888);

More fun

Events subscription

https://github.com/RobinQu/datastack/blob/master/spec/ws_subscription_spec.jsredis

datastack自帶的組件便可實現將事件的CRUD操做經過廣播,在客戶端:sql

var client = new Websocket("ws://localhost:8888/books/_subscription");
client.on("message", function(data) {
//json encoded string
var event = JSON.parse(data);
// event.type === "datastack:create"
// event.data === `storeKey`s of created records
});

經過datastack的notifier體系,能夠輕鬆接駁Apple APN、Google Push Service,或者其餘的sass服務(Mailgun、Urban Airship等),讓你快速實現簡潔的消息體系。mongodb

Data store

默認是利用mongo的,但相信不是每一個人都喜歡mongo。事實上,經過實現本身的Storage類,你能夠接入任何持久化方案。json

例如,爲測試而寫的MemoryStore: https://github.com/RobinQu/datastack/tree/master/src/storage/memory緩存

只需在建立datastack時給定storage屬性,sass

var koa = require("koa"),
      datastack = require("datastack"),
      MySuperStorage = require("my-super-storage");

var app = koa();
datastack(app, { storage: new MySuperStorage() });

StackApp

儘管datastack中大部分的組件均可以利用mixin的方式應用到原生的koa應用實例上,咱們也提供一個koa的子類StackApp,它有以下優點:安全

  1. 更多API shortcut
  2. 提供對cluster的一些支持(事件消息傳播等)
  3. 代碼會更簡潔

一個簡單的例子:

var datastack = require("datastack");
var app = datastack.app({
  storage: {
    type: "mongodb",
    uri: "mongodb://127.0.0.1:27017/datastack-test"
  }
});
app.resource("book");
app.resource("author");
var port = process.env.PORT || 8888;
app.listen(port, function() {
  console.log("server is up and running");
});

StackCluster

這是一個基於recluster 的封裝。假如用到了datastack中的一些高級功能(事件訂閱)等,不可避免的涉及到事件在cluster之間同步等問題。而集羣之
間的問題,遠遠不止這一個。StackCluster是爲了解決這些目前我碰到的一些問題,以及將來架構中可能出現的問題而準備的,推薦使用。

一個完整的例子: https://github.com/RobinQu/datastack/tree/master/example/cluster

項目情況

其實在koa出來以後就在計劃這個,可是寫的好沒動力。目前大部分架構已完成,如今的任務:

  1. 寫更多的測試
  2. 更多的存儲方案(redis, mysql, 以及混合存儲,即多級緩存)
  3. 安全認證, 目前僅有有BasicAuth方案
  4. 消息通信
    4.1 更多渠道(APN、mail)
    4.2 更多底層通信方式 (zmq, AMQ)

datastack已經在個人我的項目中使用,但數量級還不夠證實它的穩定性。

貢獻

固然是越多越好了,datastack裏面已經有不少打開的issues了。

相關文章
相關標籤/搜索