SFS overview:如何使用文件以及範例

如何使用文件以及範例:

這份文件提供了一個快速地教程,教導如何在SmartFoxServer 2X(或是叫做SFS2X)的文件中取得最大的效益。我們的第一個建議是,在開始例子與技術文件之前,先參考這節所提供的文章。

不論你是一個經驗豐富的SmartFox開發人員,或只是剛剛開始多人世界的第一步。你會發現最初的文章對於SmartFox的開始特別有用。在”開始”(Getting Started  )章節中,將會引導你進入客戶端與伺服端地建立階段。而”進階主題”(Advanced Topics)章節則會將目光放在新的擴展系統、伺服端API、以及許多其他項目。

例子:

我們大力的倡導正在申請專利的方法--邊做邊學,當然,申請專利是開玩笑的,但是我們很認真的是,藉由一系列越來越複雜的例子來學習。

SmartFoxServer充滿了許多簡單與進階的例子,而這些例子是由ActionScript 3, Objective-C, Java and C#所實作。藉此可以學習到相當的基礎,並且快速地進入到更有趣、更強大的功能。

每個例子都包含了客戶端與伺服端的原始程式碼,並且企圖將例子建立在之前的例子上,以提供其連續性的感覺。

Java/AS3/C#文件:

當你了解到新的SmartFoxServer能為你做些什麼,並且測試了一些例子。你大概會急著開始玩一些API並且雛型化一些想法。這時候當然就是ActionScript/C#/等等文件(客戶端)與Javadoc文件(伺服端)該上場的時候了。

下面是一個提示列表,讓你開始使用API而不會迷失在大量的程式套件之中,並且為你所會遭遇到的API進行分類。

客戶端:

客戶端API的主要物件是SmartFox類別,該類別能在com.smartfoxserver.v2 (AS3)、Sfs2X(C#) 或是 sfs2x.client (Java),套件中找到。這是客戶端API的主要進入點。這物件允許你管理你自己的事件監聽器,開啟連線與藉由send()方法來送出要求。

另外一個關於客戶端框架的重要章節是com.smartfoxserver.v2.requests (AS3)、Sfs2X.Requests (C#) 或是  sfs2x.client.requests (Java) 套件。在這些套件中你能找到許多不同的類別,每個類別都代表著一個特殊的客戶端要求,像是登入要求(LoginRequest)、加入房間要求(JoinRoomRequest)、傳送公開訊息要求(SendPublicMessageRequest )以及許多許多。這其中還包含了兩個個別的子套件。遊戲(game)與好友列表(buddylist),(在C++API中是Game Buddylist)。你可以在這兩個子套件中找到進階的API,分別用以建立遊戲與管理好友列表。

( 維克:所謂的進入點指的是,學習的進入點,學習可以從該類別開始)

伺服端:

扮演著伺服端API進入點的類別能在com.smartfoxserver.v2.api套件中找到。特別是下面幾種:

  • 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)

你也會注意到整個框架將這些介面使用在幾乎每一個方法或是傳回的型別中。

我們也樂意鼓勵並強調在你的程式碼中也使用這些介面。理由是這能在沒有副作用的情形下,幫助我們進行不同實現(implementations)的交換。在未來釋出的版本中,我們可能會為這些介面引入新的實現(implementations)方式。這可以在最小程度上影響你的程式碼,假如你能盡可能的堅守這習慣的話。

翻譯文,原網址為:http://docs2x.smartfoxserver.com/Overview/using-the-documentation

我對英文不太好,專業術語也不太熟,只是剛好在學,就順便寫寫。

 
 

  按個讚!~支持本站!~

FB推薦載入中