pomelo sync在lordofpomleo的使用分析

最新推荐文章于 2024-08-07 10:26:26 发布

转载最新推荐文章于 2024-08-07 10:26:26 发布 · 519 阅读

文章标签：

#c++ #class #cocos2d-x #cocos2d-x3.x #cocostudio

Pomelo 专栏收录该内容

12 篇文章

订阅专栏

本文详细介绍了PomeloSync在LordOfPomelo游戏中的应用，包括其工作原理、配置方法及如何通过EventEmitter实现数据的异步更新。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

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

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

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

[javascript]view plaincopy 
   
 function enterScene(){  
   pomelo.request("area.playerHandler.enterScene", null, function(data){  
     app.init(data);  
   });  
 }  

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

[javascript]view plaincopy 
   
 handler.enterScene = function(msg, session, next) {  
 ...  
         if (!area.addEntity(player)) {  
       logger.error("Add player to area faild! areaId : " + player.areaId);  
     }  
 ...  
 };  

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

[javascript]view plaincopy 
   
 util.inherits(Player, Character);  

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

[javascript]view plaincopy 
   
 util.inherits(Character, Entity);  

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

[javascript]view plaincopy 
   
 var Entity = function(opts) {  
     EventEmitter.call(this);  
 ...  
   
 };  
   
 util.inherits(Entity, EventEmitter);  

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

[javascript]view plaincopy 
   
 // Emit the event 'save'.  
 Player.prototype.save = function() {  
     this.emit('save');  
 };  

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

[javascript]view plaincopy 
   
 exp.addEntity = function(e) {  
 ...  
     eventManager.addEvent(e);  
 ...  
 };  

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

[javascript]view plaincopy 
   
 exp.addEvent = function(entity){  
     ...  
     addSaveEvent(entity);  
     ...  
 };  

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

[html]view plaincopy 
   
 /**  
  * Add save event for player  
  * @param {Object} player The player to add save event for.  
  */  
 function addSaveEvent(player) {  //通过同步工具，回写相关信息到数据库  
     var app = pomelo.app;  
     player.on('save', function() {  
         app.get('sync').exec('playerSync.updatePlayer', player.id, player.strip());  
     });  
   
     player.bag.on('save', function() {  
         app.get('sync').exec('bagSync.updateBag', player.bag.id, player.bag);  
     });  
   
     player.equipments.on('save', function() {  
         app.get('sync').exec('equipmentsSync.updateEquipments', player.equipments.id, player.equipments);  
     });  
 }  

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

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

[javascript]view plaincopy 
   
 //Add experience  
 Player.prototype.addExperience = function(exp) {  
     this.experience += exp;  
     if (this.experience >= this.nextLevelExp) {  
         this.upgrade();  
     }  
     this.save();  
 };  

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

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

[javascript]view plaincopy 
   
 // Configure database  
 app.configure('production|development', 'area|auth|connector|master', function() {  
     var dbclient = require('./app/dao/mysql/mysql').init(app);  
     app.set('dbclient', dbclient);  
     app.load(pomelo.sync, {path:__dirname + '/app/dao/mapping', dbclient: dbclient});  
 });  

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

[javascript]view plaincopy 
   
 module.exports = {  
   updateBag: function (dbclient, val, cb) {  
     var sql = 'update Bag set items = ? where id = ?';  
     var items = val.items;  
     if (typeof items !== 'string') {  
       items = JSON.stringify(items);  
     }  
     var args = [items, val.id];  
   
     dbclient.query(sql, args, function (err, res) {  
       if (err) {  
         console.error('write mysql failed!　' + sql + ' ' + JSON.stringify(val));  
       }  
       cb(!!err);  
     });  
   }  
 };  

好了最后总结一下，使用流程就是：先在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 plaincopy 
   
 var util = require("util");  
 var events = require("events");//EventEmitter通过events模块来访问  
   
 function MyStream() {//新建一个类  
     events.EventEmitter.call(this);  
 }  
   
 util.inherits(MyStream, events.EventEmitter);//使这个类继承EventEmitter  
   
 MyStream.prototype.write = function(data) {//定义一个新方法  
     this.emit("data", data);//在此触发名为"data"事件  
 }  
   
 var stream = new MyStream();  
   
 stream.on("data", function(data) {//注册监听器，监听名为"data"事件  
     console.log('Received data: "' + data + '"');  
 })  
 stream.write("It works!"); // Received data: "It works!"  