CQRS框架（nodejs的DDD開發落地框架）初識感想

Ephraim發表於2019-02-16
框架NodeJS

CQRS是啥？DDD又是啥？

這兩個概念其實沒什麼神祕的，當然此文章中的這兩個概念以曾老師的課程為準（關於CQRS和DDD的標準概念，google上已經很多了，不再贅述。）

DDD(Domain Driven Design)，領域驅動設計開發。

DDD和OOP有什麼同嗎？其實就我個人經驗來說，沒有任何不同（當然你可以反駁我），DDD就是OOP。這裡以曾老師課上的概念為準，domain就是世界，包含了當前所有actor的一個域，這個域是一個上帝視角，可以監聽每一個域中發生的事件，並且記錄。

CQRS，既命令和查詢職責分離（Command Query Responsibility Segregation）。

在普通mvc架構中，對於資料庫的CRUD基本都是寫在controller層，這樣一來路由非常臃腫，而且維護起來簡直是噩夢。

CQRS將查詢與職責分離。簡單說來，就是寫操作和讀操作分離，讀操作寫在路由中，寫操作通過物件導向寫入類的業務方法中，這樣路由中的查詢部分薄了，而且對於寫操作的可讀性，重用性和維護性大大提高。

相比較於普通mvc，cqrs分為核心層Core（及核心層擴充套件Core Extension）應用層（Application），UI層，看起來3層，其實是四層，但是由於核心層與核心層擴充套件的伸縮性很強，並且針對專案的大小來決定，所以就我覺得用3.5層來描述比較合適。

取cqrs文件中的例子

const {Actor} = require("cqrs");

module.exports = class User extends Actor{
  constructor(data){
     const {name} = data;
     super({
       name,
       createTime: Date.now(),
       stars:[], // 被關注明星的 ids
       watchers:[] //  關注者的 ids
     });
  }

  // 關注某位明星
  async follow(starId){
    const service = this.service;
    const star = await service.get("User",starId);
    if(starId !== this.id && star){
      await star.addWatcher(this.id);
      this.$(starId)
    }
  }

  // 取消關注某位明星
  async unFollow(starId){
    const star = await this.service.get("User",starId);
    if(star){
      await star.deleteWatcher(this.id);
      this.$(starId);
    }
  }

  // 加入關注者 watcher
  addWatcher(watcherId){
    if(watcherId !== this.id)
    this.$(watcherId);
  }

  // 取消被關
  deleteWatcher(watcherId){
    this.$(watcherId);
  }

  get updater(){
    return {
      follow(json, event){
        const stars = json.stars;
        stars.push(event.data);
        return {
          stars
        }
      },
      unFollow(json, event){
        const stars = json.stars;

        var set = new Set(stars);
        set.delete(event.data);

        return {
          stars:[...set]
        }
      },
      addWatcher(json,event){
        const watchers = json.watchers;
        watchers.push(event.data);
        return {
          watchers
        }
      },
      deleteWatcher(json,event){
        const watchers = json.watchers;
        const set = new Set(watchers);
        set.delete(event.data);
        return {
          watchers:[...set]
        }
      }
    }
  }
}

以上例子是一個cqrs (傳送門）Actor的實現，通過this.$產生一個事件，事件由updater接收，進行資料的真正修改。

const {Domain} = require("cqrs");
const User = require("./User");
const domain = new Domain();

// 註冊 User Actor 類
domain.register(User);

// 即時非同步執行函式
(async function () {

  // 建立使用者1
  let user1 = await domain.create("User",{
    name:"leo"
  });

  // 建立使用者2
  let user2 = await domain.create("User",{
    name:"zengliang"
  })

  // user1 關注 user2
  await user1.follow(user2.id);

  console.log(user1.json.stars); // 列印一下 user1 監聽所有 ids
  console.log(user2.json.watchers);  // 列印一下 user2 追隨者的所有 ids

  user1.unFollow(user2.id);  // user1 取消關注 user2

  // 重新載入 user1 和 user2
  user1 = await domain.get("User",user1.id);
  user2 = await domain.get("User",user2.id);

  console.log(user1.json.stars); // 列印一下 user1 監聽所有 ids
  console.log(user2.json.watchers);  // 列印一下 user2 追隨者的所有 ids

})();

以上是在執行中對User例項物件的操作，關注與取關的操作。

Any fool can write code that a computer can understand. Good programmers write code that humans can understand. — 某位大牛

以上的例子很好的詮釋了可讀性還有重用性。對於寫操作來說，完全用業務方法來實現，那麼路由中可以僅包含cqrs中Q的部分，這樣做到了業務和查詢分離，那麼迷惑也開始解開了。

  • 寫操作，用業務方法來完成，屬於核心層
  • query，既查詢操作，寫在router中，是應用層變薄

在使用普通mvc的時候，邏輯和查詢通常都會放在路由當中，這樣造成的高耦合性（coupling）讓程式碼的重用性，可讀性，可伸縮性很差。維護起來簡直噩夢連連。我的第一個專案是用標準mvc完成，後期加新需求的時候基本山就是牽一髮動全身，也是我的經驗確實不夠對於很多地方沒有對程式碼進行可重用的封裝。

現在淺談一下 Auxo（傳送門）

Auxo框架整合了Nuxt(Vue)，Vuex，Express，cqrs四個重要框架。這樣在開發時就不用再辛苦搭建開發環境了，直截了當。Auxo是約定式的框架，關於檔案結構是根據Nuxt（傳送門）的，所以有必要讀一讀Nuxt的文件，對Nuxt有一定了解之後就可以用了而且上手很快，因為基本上不需要配置什麼東西。

在Auxo框架中，資料遵循Event Sourcing原則，分兩個collection。

  • 一個是事件資料庫記錄在domain中發生的所有事件，讓事件回溯、長故事（saga）和事件鎖（lock）成為可能；
  • 另外一個是查詢資料庫，記錄普通資料，我自己的理解就是面向資料庫開發的那種最基本的資料庫。

eventstore

記錄事件物件的資料庫，可以通過該資料庫的資料進行資料回溯。

snap

事件快照。domain中的事件的一個snapshot，我暫且理解為一個log

server/index.js 中的 req.dbs 和 req.$domain

這兩個屬性已經在框架中直接掛載在了req物件上，歸功於曾老師。在server/index.js中，已經定義好了，這個檔案相當於express的app.js，只是檔名不一樣。
req.dbs就是上述的查詢資料庫，可以使用mongojs來query。
req.$domain就是domain，即上帝視角，可以用以下語句

req.$domain.get(`User`, uid); // 獲取User物件
req.$domain.create(`User`, {username: `ephraimguo`, password:`*******`}); // 建立user物件

等domain物件的方法進行資料操作。

在Vue元件中的axios 和 domain

這兩個物件已經寫在plugins/資料夾裡面，可以直接在Vue元件中引用如下

<template>
    <!-- Vue Template -->
</template>
<script>
    import axios from `@/plugins/aixos`
    import domain from `@/plugins/domain`
    // ... codes ...
</script>
<style>
    /* some style sheet */
</style>

Listener 核心層擴充套件 (有個小坑)

起初看到曾老師用listener但是不明白怎麼監聽，而且去看epxress-cqrs的原始碼的時候，看到listener的路徑是作引數與傳入了的。

擷取一段express-cqrs的原始碼

// Register Actors Class from actors folder
ActorList.filter(Actor => /.*.js$/.test(Actor)).
    forEach(Actor => domain.register(require(path.join(actorPath, Actor))));
    
// Get Listener from listener folder
listeners.filter(listener => /.*.js$/.test(listener)).
    forEach(listener => require(path.join(listenerPath, listener))(domain));
  • 第一步，在根目錄下新增listener資料夾
  • 第二部，建立新的監聽js檔案，

Listener 內部寫法，如下（個人經驗）


module.exports = function(domain){ 
    // Utilise domain.on(...) to make onAction listening
}

這次先暫時聊這麼多，cqrs還有很多好用的方法和思想可以慢慢琢磨，而且這種程式設計思想易實踐，並且對全域性的把控更精準，心有猛虎細嗅薔薇，當然這篇文章也是針對上過曾老師課的童鞋們，不算是掃盲，過後會繼續寫一些關於cqrs框架應用的文章，也歡迎大家提問，並且一起討論。如果有錯誤，也請大家指正，我會馬上修改。

相關文章