基于python yield機(jī)制的異步操作同步化編程模型

本文總結(jié)下如何在編寫(xiě)python代碼時(shí)對(duì)異步操作進(jìn)行同步化模擬，從而提高代碼的可讀性和可擴(kuò)展性。

游戲引擎一般都采用分布式框架，通過(guò)一定的策略來(lái)均衡服務(wù)器集群的資源負(fù)載，從而保證服務(wù)器運(yùn)算的高并發(fā)性和CPU高利用率，最終提高游戲的性能和負(fù)載。由于引擎的邏輯層調(diào)用是非搶占式的，服務(wù)器之間都是通過(guò)異步調(diào)用來(lái)進(jìn)行通訊，導(dǎo)致游戲邏輯無(wú)法同步執(zhí)行，所以在代碼層不得不人為地添加很多回調(diào)函數(shù)，使一個(gè)原本完整的功能碎片化地分布在各個(gè)回調(diào)函數(shù)中。

異步邏輯

以游戲中的副本評(píng)分邏輯為例，在副本結(jié)束時(shí)副本管理進(jìn)程需要收集副本中每個(gè)玩家的戰(zhàn)斗信息，再結(jié)合管理進(jìn)程內(nèi)部的統(tǒng)計(jì)信息最終給出一個(gè)副本評(píng)分，發(fā)放相應(yīng)獎(jiǎng)勵(lì)。因?yàn)槊總€(gè)玩家實(shí)體都隨機(jī)分布在不同進(jìn)程中，所以管理進(jìn)程需要通過(guò)異步調(diào)用來(lái)獲取玩家身上的戰(zhàn)斗信息。

實(shí)現(xiàn)代碼如下所示：

# -*- coding: gbk -*-
import random
 
# 玩家實(shí)體類(lèi)
class Player(object):
  def __init__(self, entityId):
    super(Player, self).__init__()
    # 玩家標(biāo)識(shí)
    self.entityId = entityId
 
  def onFubenEnd(self, mailBox):
    score = random.randint(1, 10)
    print "onFubenEnd player %d score %d"%(self.entityId, score)
 
    # 向副本管理進(jìn)程發(fā)送自己的id和戰(zhàn)斗信息
    mailBox.onEvalFubenScore(self.entityId, score)
 
# 副本管理類(lèi)
class FubenStub(object):
  def __init__(self, players):
    super(FubenStub, self).__init__()
    self.players = players
 
  def evalFubenScore(self):
    self.playerRelayCnt = 0
    self.totalScore = 0
 
    # 通知每個(gè)注冊(cè)的玩家，副本已經(jīng)結(jié)束，索取戰(zhàn)斗信息
    for player in self.players:
      player.onFubenEnd(self)
 
  def onEvalFubenScore(self, entityId, score):
    # 收到其中一個(gè)玩家的戰(zhàn)斗信息
    print "onEvalFubenScore player %d score %d"%(entityId, score)
    self.playerRelayCnt += 1
    self.totalScore += score
 
    # 當(dāng)收集完所有玩家的信息后，打印評(píng)分
    if len(self.players) == self.playerRelayCnt:
      print 'The fuben totalScore is %d'%self.totalScore
 
if __name__ == '__main__':
  # 模擬創(chuàng)建玩家實(shí)體
  players = [Player(i) for i in xrange(3)]
 
  # 副本開(kāi)始時(shí)，每個(gè)玩家將自己的MailBox注冊(cè)到副本管理進(jìn)程
  fs = FubenStub(players)
 
  # 副本進(jìn)行中
  # ....
 
  # 副本結(jié)束，開(kāi)始評(píng)分
  fs.evalFubenScore()

代碼簡(jiǎn)化了副本評(píng)分邏輯的實(shí)現(xiàn)，其中Player類(lèi)表示游戲的玩家實(shí)體，在游戲運(yùn)行時(shí)無(wú)縫地在不同服務(wù)器中切換，F(xiàn)ubenStub表示副本的管理進(jìn)程，在副本剛開(kāi)始的時(shí)候該副本內(nèi)所有玩家會(huì)將自己的MailBox注冊(cè)到管理進(jìn)程中，其中MailBox表示各個(gè)實(shí)體的遠(yuǎn)程調(diào)用句柄。在副本結(jié)束時(shí)，F(xiàn)ubenStub首先向各個(gè)玩家發(fā)送副本結(jié)束消息，同時(shí)請(qǐng)求玩家的戰(zhàn)斗信息，玩家在得到消息后，將自己的戰(zhàn)斗信息發(fā)送給FubenStub；然后當(dāng)FubenStub收集完所有玩家的信息后，最終打印副本評(píng)分。

同步邏輯

如果Player和FubenStub在同一進(jìn)程中的話(huà)，那所有的操作都可以同步完成，在FubenStub向玩家發(fā)送副本結(jié)束消息的同時(shí)可以馬上得到該玩家的戰(zhàn)斗信息，實(shí)現(xiàn)代碼如下所示：

從以上兩份代碼可以看到由于異步操作，F(xiàn)ubenStub中的評(píng)分邏輯人為地分成兩個(gè)功能點(diǎn)：1）向玩家發(fā)送副本結(jié)束消息；2）接受玩家的戰(zhàn)斗信息；并且兩個(gè)功能點(diǎn)分布在兩個(gè)不同的函數(shù)中。如果游戲邏輯一旦復(fù)雜，勢(shì)必會(huì)造成功能點(diǎn)分散，出現(xiàn)過(guò)多onXXX異步回調(diào)函數(shù)，最終導(dǎo)致代碼的開(kāi)發(fā)成本和維護(hù)成本提高，可讀性和可擴(kuò)展性下降。

如果有一種方法，可以讓函數(shù)在異步調(diào)用時(shí)暫時(shí)掛起，并且在回調(diào)函數(shù)得到返回值后恢復(fù)執(zhí)行，那么就可以用同步化的編程模式開(kāi)發(fā)異步邏輯。 

yield 關(guān)鍵字

yield 是 Python中的一個(gè)關(guān)鍵字,凡是函數(shù)體中出現(xiàn)了 yield 關(guān)鍵字, Python將改變整個(gè)函數(shù)的上下文，調(diào)用該函數(shù)不再返回值, 而是一個(gè)生成器對(duì)象。只有調(diào)用這個(gè)生成器的迭代函數(shù)next才能開(kāi)始執(zhí)行生成器對(duì)象，當(dāng)生成器對(duì)象執(zhí)行到包含 yield 表達(dá)式時(shí), 函數(shù)將暫時(shí)掛起，等待下一次next調(diào)用來(lái)恢復(fù)執(zhí)行，具體機(jī)制如下：

1）調(diào)用生成器對(duì)象的next方法，啟動(dòng)函數(shù)執(zhí)行；

2）當(dāng)生成器對(duì)象執(zhí)行到包含 yield 表達(dá)式時(shí), 函數(shù)掛起；

3）下一次 next 函數(shù)調(diào)用又會(huì)驅(qū)動(dòng)該生成器對(duì)象繼續(xù)執(zhí)行此后的語(yǔ)句, 直到遇見(jiàn)下一個(gè) yield 再次掛起；

4）如果某次 next 調(diào)用驅(qū)動(dòng)了生成器繼續(xù)執(zhí)行, 而此后函數(shù)正常結(jié)束,生成器會(huì)拋出 StopIteration 異常；

如下代碼所示:

def f():
  print "Before first yield"
  yield 1
  print "Before second yield"
  yield 2
  print "After second yield"
 
g = f()
print "Before first next"
g.next()
print "Before second next"
g.next()
print "Before third yield"
g.next()

執(zhí)行結(jié)果為：

Before first next

Before first yield

Before second next

Before second yield

Before third yield

After second yield

StopIteration

哈，有了讓函數(shù)暫時(shí)掛起的機(jī)制，最后就剩下如何傳遞異步調(diào)用的返回值問(wèn)題了。其實(shí)生成器的next函數(shù)已經(jīng)實(shí)現(xiàn)了將參數(shù)從生成器對(duì)象內(nèi)部向外傳遞的機(jī)制，并且python還提供了一個(gè)send函數(shù)將參數(shù)從外向生成器對(duì)象內(nèi)部傳遞的機(jī)制，具體機(jī)制如下：

1） 調(diào)用next 函數(shù)驅(qū)動(dòng)生成器時(shí), next會(huì)同時(shí)等待生成器中下一個(gè) yield 掛起，并將該yield后面的參數(shù)返回給next；

2）往生成器中傳遞參數(shù)，需要將next函數(shù)替換成send，此時(shí)send的功能與next相同（驅(qū)動(dòng)生成器執(zhí)行，等待返回值），同時(shí)send將后面的參數(shù)傳遞給生成器內(nèi)部之前掛起的yield；

如下代碼所示：

def f():
  msg = yield 'first yield msg'
  print "generator inner receive:", msg
  msg = yield 'second yield msg'
  print "generator inner receive:", msg
 
g = f()
msg = g.next()
print "generator outer receive:", msg
msg = g.send('first send msg')
print "generator outer receive:", msg
g.send('second send msg')

執(zhí)行結(jié)果為：

generator outer receive: first yield msg

generator inner receive: first send msg

generator outer receive: second yield msg

generator inner receive: second send msg

StopIteration

同步化實(shí)現(xiàn)
     好了，萬(wàn)事俱備只欠東風(fēng)，下面就是簡(jiǎn)單對(duì)yield機(jī)制進(jìn)行工程上封裝以方便之后開(kāi)發(fā)。下面的代碼提供了一個(gè)叫IFakeSyncCall的interface，所有包含異步操作的邏輯類(lèi)都可以繼承這個(gè)接口：    
class IFakeSyncCall(object):
  def __init__(self):
    super(IFakeSyncCall, self).__init__()
    self.generators = {}
 
  @staticmethod
  def FAKE_SYNCALL():
    def fwrap(method):
      def fakeSyncCall(instance, *args, **kwargs):
        instance.generators[method.__name__] = method(instance, *args, **kwargs)
        func, args = instance.generators[method.__name__].next()
        func(*args)
      return fakeSyncCall
    return fwrap
 
  def onFakeSyncCall(self, identify, result):
    try:
      func, args = self.generators[identify].send(result)
      func(*args)
    except StopIteration:
      self.generators.pop(identify)

其中interface中屬性generators用來(lái)保存類(lèi)中已經(jīng)開(kāi)始執(zhí)行的生成器對(duì)象；函數(shù)FAKE_SYNCALL是一個(gè)decorator，裝飾類(lèi)中包含有yield的函數(shù)，改變函數(shù)的調(diào)用上下文，在fakeSyncCall內(nèi)部封裝了對(duì)生成器對(duì)象的next調(diào)用；函數(shù)onFakeSyncCall封裝了所有onXXX函數(shù)的邏輯，其他實(shí)體通過(guò)調(diào)用這個(gè)函數(shù)傳遞異步回調(diào)的返回值。

下面就是經(jīng)過(guò)同步化改進(jìn)后的異步副本評(píng)分邏輯代碼：    
# -*- coding: gbk -*-
import random
 
class Player(object):
  def __init__(self, entityId):
    super(Player, self).__init__()
    self.entityId = entityId
 
  def onFubenEnd(self, mailBox):
    score = random.randint(1, 10)
    print "onFubenEnd player %d score %d"%(self.entityId, score)
    mailBox.onFakeSyncCall('evalFubenScore', (self.entityId, score))
 
class FubenStub(IFakeSyncCall):
  def __init__(self, players):
    super(FubenStub, self).__init__()
    self.players = players
 
  @IFakeSyncCall.FAKE_SYNCALL()
  def evalFubenScore(self):
    totalScore = 0
    for player in self.players:
      entityId, score = yield (player.onFubenEnd, (self,))
      print "onEvalFubenScore player %d score %d"%(entityId, score)
      totalScore += score
 
    print 'the totalScore is %d'%totalScore
 
if __name__ == '__main__':
  players = [Player(i) for i in xrange(3)]
 
  fs = FubenStub(players)
  fs.evalFubenScore()

比較evalFubenScore函數(shù)，基本已經(jīng)和原本的同步邏輯代碼相差無(wú)幾。
      利用yield機(jī)制實(shí)現(xiàn)同步化編程模型的另外一個(gè)優(yōu)點(diǎn)是可以保證所有異步調(diào)用的邏輯串行化，從而保證數(shù)據(jù)的一致性和有效性，特別是在各種異步初始化流程中可以摒棄傳統(tǒng)的timer sleep機(jī)制，從源頭上扼殺一些隱藏很深的由于數(shù)據(jù)不一致性所導(dǎo)致的bug。