SmartFoxServer如何使用文档和示例

如何使用文档和示例

本文档提供了如何从提供的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
我们想鼓励并强调在代码中使用这些接口。原因是，这有助于轻松地交换不同的实现，没有副作用。在将来的版本中，我们可能会向这些接口引入新的实现，如果你坚持这种习惯，这将会影响你的代码最小。