維克的煩惱

開發基礎:SFSObject 與 SFSArray

詳細內容

分類：smartfoxserver

發佈：2014-01-21, 週二 11:45

點擊數：2260

» SFSObject 與SFSArray

SmartFoxServer 2X 採用了兩個基本的類別，SFSObject  與SFSArray，這兩個類別是伺服端與客戶端之間操作與傳送資料的中心。它們是跨所有語言的API(包含伺服端API)。這讓移植代碼到任何平台和應用程序的每個面變得非常容易。

SFSObject 與SFSArray 代表著平台中立的高階物件，將客戶端與伺服端間的資料傳輸抽象化。它們分別用於以Map/Dictionary或是List/Array的型態來表示數據，它們可以巢狀的建立出複雜的資料結構並且支援許多不同的資料型態。(從位元組到整數，倍浮點數，字串以及更多)。
這兩個類提供細緻的控制通過網絡發送的每個數據元素並且使用預設的SFS2X二進制協議提供高速的序列化。

讓我們來想一下這個簡單的例子：在一個多人遊戲中，我們需要送出關於戰車一些資料。

ISFSObject sfso = new SFSObject();
sfso.putByte("id", 10);
sfso.putShort("health", 5000);
sfso.putIntArray("pos", Arrays.asList(120,150));
sfso.putUtfString("name", "Hurricane"); 

在程式碼中我們使用單一個位元組(有符號的8位元)來傳送任何的小整數值，一個短整數(有符號的16位元)來應付較大的值，以及整數來應付任何需要以標準(有符號的)32位元表示的值。在這個例子中我們想像有個廣域的RTS(維克：即時戰略)環境，並且使用一個Int陣列來傳送戰車的x/y位置。

» 支援的資料型態

下面列表是兩個類別所支援的所有型態：

當傳送相同型態的值的列表時，陣列型態特別有用。因為其結果會是一個非常緊湊的數據結構，換個方面來看，假如你要傳送有不同資料型態的值的列表，SFSObject 會是最好的選擇。

public function sendSomeData():void
{
    var sfso:SFSObject = new SFSObject();
    sfso.putByte("id", 10);
    sfso.putShort("health", 5000);
    sfso.putIntArray("pos", [120,150]);
    sfso.putUtfString("name", "Hurricane"); 
     
    // Send request to Zone level extension on server side
    sfs.send( new ExtensionRequest("data", sfso) );
}

public class DataRequestHandler extends BaseClientRequestHandler
{
    @Override
    public void handleClientRequest(User sender, ISFSObject params)
    {
        // Get the client parameters
        byte id = params.getByte("id");
        short health = params.getShort("health");
        Collection<Integer> pos = params.getIntArray("pos");
        String name = params.getUtfString("name");
          
        // Do something cool with the data...
    }
}

(short) health: 5000
(utf_string) name: Hurricane
(byte) id: 10
(int_array) pos: [120, 150]

Binary size: 54
12 00 04 00 06 68 65 61 6C 74 68 03 13 88 00 04 	.....health.....
6E 61 6D 65 08 00 09 48 75 72 72 69 63 61 6E 65 	name...Hurricane
00 02 69 64 02 0A 00 03 70 6F 73 0C 00 02 00 00 	..id....pos.....
00 78 00 00 00 96  

public class CombatQuad
{
    private int unitID;
    private int posx;
    private int posy;
    private int energyLevel;
    private int bulletCount;
     
    public CombatQuad(int unitID)
    {
        this.unitID = unitID;
        this.energyLevel = 100;
        this.bulletCount = 20;
    }
     
    //... More getters and setters...
     
    public ISFSObject toSFSObject()
    {
        ISFSObject sfso = new SFSObject();
         
        sfso.putByte("id", unitID);
        sfso.putShort("px", posx);
        sfso.putShort("py", posy);
        sfso.putByte("el", energyLevel);
        sfso.putShort("bc", bulletCount);
         
        return sfso;
    }
}

我們省略了所有的getter / setter方法，單刀直入地直接展現出它是如何運作的。toSFSObject方法負責提取我們需要的屬性，並且盡可能地使用最小的資料型態來格式化這些屬性。當需要在更新中傳送這些物件資料時，我們的擴展程式碼將會大大的簡化。

public void sendMapUpdate(CombatQuad quad, OtherObject other, User recipient)
{
    ISFSObject responseObj = new SFSObject();
    responseObj.putSFSObject("quad", quad.toSFSObject());
    responseObj.putSFSObject("other", other.toSFSObject());
     
    send("quadUpdate", responseObj, recipient);
}

在客戶端我們將使用一個類似但是相反的方法：我們將從借由SFSObject傳送過來的屬性，重新建立類別實例，我們將實現一個靜態的建構子稱之為newFromSFSObject。

public class CombatQuad
{
    private var unitID:int;
    private var posx:int;
    private var posy:int;
    private var energyLevel:int;
    private var bulletCount:int;
     
    public static function newFromSFSObject(sfso:ISFSObject):CombatQuad
    {
        var combatQuad:CombatQuad = new CombatQuad(sfso.getByte("id"));
        combatQuad.posx = sfso.getShort("px");
        combatQuad.posy = sfso.getShort("py");
        combatQuad.energyLevel = sfso.getByte("el");
        combatQuad.bulletCount = sfso.getByte("bc");
 
        return combatQuad;
    }
     
    function CombatQuad(unitID:int):void
    {
        this.unitID = unitID;
    }
     
    //... More getters and setters...
}

» 只適用於AS3: Object/Array 到SFSObject/SFSArray 的轉換

在ActionScript 3 中，SFSObject 與SFSArray 提供了直接的轉換到/從它們各自的原生類別：Object 與Array。這是為了幫助為SmartFoxServer 1.x而寫的舊版程式碼的遷移，並且對使用動態型態的開發者提供額外的便利性。

有必要強調的是，使用泛型對象來替代資料模型類別一般是不被建議的。(維克:泛型對象對象指的是SFSObject/SFSArray，資料模型類別就像是前面提到戰車的類別)因為它無法利用ActionScript 3采用的類型優化。動態附加到物件上的屬性不是強型態的，因此無法由編譯器最佳化。

通常在許多場合中這會是有用的，而且可以加速開發。額外的方法如下：

• SFSObject.newFromObject: 靜態建構子，從一個物件中產生一個新的SFSObject 實例。支援的型態為：null, Boolean, Number, String, Object, Array 。這個操作支援巢狀物件。
• SFSObject.toObject: 將SFSObject實例轉換成一個物件，包含巢狀的物件。
• SFSArray.newFromArray: 靜態建構子，從一個陣列中產生一個新的SFSArray。支援的型態為：null, Boolean, Number, String, Object, Array 。這個操作支援巢狀物件。
• SFSArray.toArray: 將SFSArray 實例轉化成為陣列，包含巢狀的物件。

使用這種方法的缺點是，你失去了微調數值型態的能力：所有的數字將被轉換為一個32位整數（非十進制值non decimal values）或64位雙精度（十進制值decimal values）。

» 更多的資源

要取得更多關於SFSObject 與SFSArray 的細節與範例，我們強烈建議看一下SFS2X的範例，並且參考這個網站(維克：請看官網)的API Documentation章節的文件。也可以查看Class serialization  這篇進階教學。

上一篇：開發基礎:伺服器變數

下一篇：開發基礎:資料庫方法

• 前一個
• 下一個