如何使用文檔和示例

本文檔提供了如何從提供的SmartFoxServer 2X（aka SFS2X）文檔獲得最佳的快速教程。我們的第一個建議是在進行示例和技術文檔之前咨詢本節中提供的文章。

無論你是一個經驗豐富的SmartFox開發人員，還是剛剛在多人游戲世界中移動你的第一步，你會發現最初的文章特別有用的開始。入門部分將指導您在客戶端和服務器設置階段，而高級主題部分提供有關新的擴展系統，服務器API和更多的洞察。
?示例

我們堅決支持我們正在申請專利的Learning-While-Doing?方法學。當然，我們正在開玩笑的專利事情，但我們認真的學習通過遵循一系列的例子越來越復雜。

SmartFoxServer包含了在ActionScript 3，Objective-C，Java和C＃中創建的簡單和高級示例，您可以在其中學習基礎知識，并快速移至更有趣和更強大的功能。

每個示例都帶有客戶端和服務器端的源代碼，并嘗試基于前面的示例在系列中提供連續性感。
?Java / AS3 / C＃doc

一旦你了解了新的SmartFoxServer 2X可以為你做了什么，并測試了一些例子，你可能渴望開始使用API??和原型的一些想法。這當然是ActionScript / C＃/ etc docs（客戶端）和Javadoc（服務器）將派上用場的時刻。

下面列出了開始使用API??的提示，而不會丟失在你將遇到的包和類的主機。
?客戶端

客戶端API主對象是在com.smartfoxserver.v2（AS3），Sfs2X（C＃）或sfs2x.client（Java）包中找到的SmartFox類。這是客戶端API的主要入口點。此對象允許您管理事件偵聽器，啟動連接并通過send（）方法發送請求。

客戶端框架的另一個重要部分是com.smartfoxserver.v2.requests（AS3），Sfs2X.Requests（C＃）或sfs2x.client.requests（Java）包。這里你會發現幾十個不同的類，每個代表一個特定的客戶端請求，如LoginRequest，JoinRoomRequest，SendPublicMessageRequest等等。還有兩個單獨的子包，游戲和buddylist（游戲和Buddylist為C＃API），在那里你可以找到高級API分別用于構建游戲和管理好友列表。
?服務器端

充當服務器端API入口點的類在com.smartfoxserver.v2.api packge中找到。特別：

SFSApi：在這里你可以找到幾十種最常用的服務器操作方法：登錄，創建/刪除房間，發送消息，加入用戶，設置變量等。 SFSGameApi：游戲特定API SFSBuddyApi：好友列表特定API

重要的提示
在瀏覽Javadoc時，有時可能會找到幾乎沒有文檔的字段或方法。除了由于文檔的當前狀態的少數例外，這是為了指示不應該直接使用這些方法。API類已經在后臺使用這些較低級別的方法，您不必直接處理它們。使用它們可能會破壞正常的SFS2X功能。
?編程到接口

一般來說，在整個客戶端和服務器API中，您將注意到框架的所有重要類都由接口支持。
例如：

SFSZone 實現了區域(Zone) SFSRoom 實現了房間(Room) SFSUser 實現了使用者(User) SFSBuddy 實現了好友(Buddy) SFSObject 實現的SFS物件(ISFSObject) SFSArray 實現了SFS陣列(ISFSArray) SFSRoomVariable 實現了房間變數(RoomVariable) SFSUserVariable 實現了使用者變數( UserVariable)

您還將注意到整個框架在幾乎每個方法簽名或返回類型中使用這些接口。
翻譯文，原網址為：http://docs2x.smartfoxserver.com/Overview/using-the-documentation
我們想鼓勵并強調在代碼中使用這些接口。原因是，這有助于輕松地交換不同的實現，沒有副作用。在將來的版本中，我們可能會向這些接口引入新的實現，如果你堅持這種習慣，這將會影響你的代碼最小。

總結

以上是生活随笔為你收集整理的SmartFoxServer如何使用文档和示例的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。