pomelo sync在lordofpomleo的使用分析

不念不忘少年蓝@ 2022-09-18 12:56 215阅读 0赞

关于pomelo sync的使用其实官方是有一篇文档介绍的，[使劲搓这里][Link 1]，后来看了[lordofpomelo游戏分析][lordofpomelo] 这个文档，发现里面的数据持久化模块也有讲到pomelo sync，但本人对nodejs属于菜鸟级别，居然没看懂，今天抽时间结合lordofpomleo源码好好看了一下，终于弄懂了，特此分享。

话说Lord采用Pomelo-sync从内存同步数据到数据库，是为了减轻数据库压力，它的工作原理是创建一个sql行为处理队列，每隔一段时间轮询一次，执行队列里的sql 操作。那么它在Lord中是如何发挥作用呢？

简单来讲特就是使用了nodjs的EventEmitter，在Lord中很多实体对象都是继承自EventEmitter的，然后都定义了一个save方法用来触发“save”事件，在这些对象加入场景时注册save监听器，监听到"save"事件时就执行sync的exec来添加异步定时执行的数据库更新操作。在场景中，如果需要更新数据，如：增加玩家经验，就直接调用对应实体对象的save方法即可。具体分析如下：

如果你看了 [lordofpomelo游戏分析][lordofpomelo] 这个文档的话，你很容易发现，当用户登录验证完毕之后，客户端web-server/public/js/ui/clientManager.js，就会向场景服务器发请求进入场景：

**\[javascript\]**  [view plain][] [copy][view plain]

1.  **function** enterScene()\{  
2.    pomelo.request("area.playerHandler.enterScene", **null**, **function**(data)\{  
3.      app.init(data);  
4.    \});  
5.  \}

场景服务器game-server/app/servers/\\area/handler/playerHandler.js，会获取玩家及场景，然后将玩家加入到场景对象中：

**\[javascript\]**  [view plain][] [copy][view plain]

1.  handler.enterScene = **function**(msg, session, next) \{  
2.  ...  
3.          **if** (!area.addEntity(player)) \{  
4.        logger.error("Add player to area faild! areaId : " + player.areaId);  
5.      \}  
6.  ...  
7.  \};

这里先看看这个player，在game-server/app/domain/entity/player.js中，其实是继承自character

**\[javascript\]**  [view plain][] [copy][view plain]

1.  util.inherits(Player, Character);

game-server/app/domain/entity/character.js，继承自entity

**\[javascript\]**  [view plain][] [copy][view plain]

1.  util.inherits(Character, Entity);

game-server/app/domain/entity/entity.js，继承自EventEmitter

**\[javascript\]**  [view plain][] [copy][view plain]

1.  **var** Entity = **function**(opts) \{  
2.      EventEmitter.call(**this**);  
3.  ...  
4.    
5.  \};  
6.    
7.  util.inherits(Entity, EventEmitter);

而在game-server/app/domain/entity/player.js中，定义了save方法用来触发“save”事件

**\[javascript\]**  [view plain][] [copy][view plain]

1.  // Emit the event 'save'.  
2.  Player.prototype.save = **function**() \{  
3.      **this**.emit('save');  
4.  \};

有了触发事件，再来看看如何监听事件，看这个area.addEntity，在game-server/app/domain/area.js中，作用是将那个player通过eventManager加进来：

**\[javascript\]**  [view plain][] [copy][view plain]

1.  exp.addEntity = **function**(e) \{  
2.  ...  
3.      eventManager.addEvent(e);  
4.  ...  
5.  \};

然后game-server/app/domain/event/eventManager.js，

**\[javascript\]**  [view plain][] [copy][view plain]

1.  exp.addEvent = **function**(entity)\{  
2.      ...  
3.      addSaveEvent(entity);  
4.      ...  
5.  \};

调用了这个addSaveEvent函数，来注册监听器，监听"save"事件

**\[html\]**  [view plain][] [copy][view plain]

1.  /\*\*  
2.   \* Add save event for player  
3.   \* @param \{Object\} player The player to add save event for.  
4.   \*/  
5.  function addSaveEvent(player) \{  //通过同步工具，回写相关信息到数据库  
6.      var app = pomelo.app;  
7.      player.on('save', function() \{  
8.          app.get('sync').exec('playerSync.updatePlayer', player.id, player.strip());  
9.      \});  
10.   
11.     player.bag.on('save', function() \{  
12.         app.get('sync').exec('bagSync.updateBag', player.bag.id, player.bag);  
13.     \});  
14.   
15.     player.equipments.on('save', function() \{  
16.         app.get('sync').exec('equipmentsSync.updateEquipments', player.equipments.id, player.equipments);  
17.     \});  
18. \}

当player、bag、equipments这三个对象见监听到"save"事件就会执行sync的exec来添加异步定时执行的数据库更新操作。

接下来看如何触发“save”事件，以玩家郑家经验为例，player对象直接调用this.save方法即可。

**\[javascript\]**  [view plain][] [copy][view plain]

1.  //Add experience  
2.  Player.prototype.addExperience = **function**(exp) \{  
3.      **this**.experience += exp;  
4.      **if** (**this**.experience >= **this**.nextLevelExp) \{  
5.          **this**.upgrade();  
6.      \}  
7.      **this**.save();  
8.  \};

最后再来看看pomelo sync是如何配置使用的。

很简单，在game-server/app.js配置

**\[javascript\]**  [view plain][] [copy][view plain]

1.  // Configure database  
2.  app.configure('production|development', 'area|auth|connector|master', **function**() \{  
3.      **var** dbclient = require('./app/dao/mysql/mysql').init(app);  
4.      app.set('dbclient', dbclient);  
5.      app.load(pomelo.sync, \{path:\_\_dirname + '/app/dao/mapping', dbclient: dbclient\});  
6.  \});

app.load(pomelo.sync, \{path:\_\_dirname + '/app/dao/mapping', dbclient: dbclient\});给sync提供了持久化时同步方法的映射及数据库连接dbclient，其中在game-server/app/dao/mapping下定义了同步方法，以bagSync.js为例，直接就是一个update语句：

**\[javascript\]**  [view plain][] [copy][view plain]

1.  module.exports = \{  
2.    updateBag: **function** (dbclient, val, cb) \{  
3.      **var** sql = 'update Bag set items = ? where id = ?';  
4.      **var** items = val.items;  
5.      **if** (**typeof** items !== 'string') \{  
6.        items = JSON.stringify(items);  
7.      \}  
8.      **var** args = \[items, val.id\];  
9.    
10.     dbclient.query(sql, args, **function** (err, res) \{  
11.       **if** (err) \{  
12.         console.error('write mysql failed!　' + sql + ' ' + JSON.stringify(val));  
13.       \}  
14.       cb(!!err);  
15.     \});  
16.   \}  
17. \};

好了最后总结一下，使用流程就是：先在app.js设置app.load(pomelo.sync, \{path:\_\_dirname + '/app/dao/mapping', dbclient: dbclient\});，然后在game-server/app/dao/mapping下定义了同步方法的js脚本，最后使用exec执行即可，如：app.get('sync').exec('bagSync.updateBag', player.bag.id, player.bag);为方便使用exec，Lord引入了EventEmitter来处理。如果你对EventEmitter不熟的话，可以看看下面这个例子：

**\[javascript\]**  [view plain][] [copy][view plain]

1.  **var** util = require("util");  
2.  **var** events = require("events");//EventEmitter通过events模块来访问  
3.    
4.  **function** MyStream() \{ //新建一个类  
5.      events.EventEmitter.call(**this**);  
6.  \}  
7.    
8.  util.inherits(MyStream, events.EventEmitter);//使这个类继承EventEmitter  
9.    
10. MyStream.prototype.write = **function**(data) \{ //定义一个新方法  
11.     **this**.emit("data", data);//在此触发名为"data"事件  
12. \}  
13.   
14. **var** stream = **new** MyStream();  
15.   
16. stream.on("data", **function**(data) \{ //注册监听器，监听名为"data"事件  
17.     console.log('Received data: "' + data + '"');  
18. \})  
19. stream.write("It works!"); // Received data: "It works!"

本人对nodejs仍属于菜鸟级别，pomelo也刚上手不久，有错在所难免请多多指教！

转贴：[http://blog.csdn.net/wangqiuyun/article/details/10083127][http_blog.csdn.net_wangqiuyun_article_details_10083127]

[Link 1]: https://github.com/NetEase/pomelo/wiki/pomelo-sync%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3
[lordofpomelo]: https://github.com/youyudehexie/lordofpomelo/wiki
[view plain]: http://blog.csdn.net/wangqiuyun/article/details/10083127#
[http_blog.csdn.net_wangqiuyun_article_details_10083127]: http://blog.csdn.net/wangqiuyun/article/details/10083127