Openfire简介（正式向）

编文档需要，对网上收集的素材做了一些调整，去掉一些口语化的词。

[if !supportLists]1.1.1.1 [endif]Openfire

Openfire 是根据开放源 Apache 许可获得许可的实时协作（RTC）服务器。它使用唯一被广泛采用的用于即时消息的开放协议 XMPP（也称为 Jabber）。Openfire 的设置和管理非常简单，但是却提供了坚实的安全性和性能。

Openfire 是 XMPP 服务器，已获得开源 Apache 许可。

[if !supportLists]1.1.1.1.1    [endif]XMPP

ExtensibleMessaging

and Presence Protocol，是一个发送接收处理消息的协议，该协议发送的消息，既不是二进制，也不是字符串，而是XML。

[if !supportLists]1.1.1.1.2    [endif]IM

InstantMessenger，及时通信软件。常用用的QQ、MSN

Messenger和Gtalk等等都是及时通信软件，但其中只有Gtalk 是基于XMPP 协议实现，其他的则不是。当前IM 几乎作为每个上网者必然使用的工具，在国外的大型企业中有一些企业级的IM应用，但是其商业价值还没完全发挥出来。设想，既然XMPP 协议是一个公开的协议，那么每个企业都可以利用它来开发适合本身企业工作，提高自身生产效率的IM；甚至，还可以在网络游戏中集成这种通信软件，让你可以边游戏边聊天，也可以开发出适合游戏本身的IM 应用，比如说一些游戏关键场景提醒功能，团队语音交流等等都可以基于IM来实现。

[if !supportLists]1.1.1.1.3    [endif]Spark、Smack和Openfire

Spark、Smack和Openfire三个开源软件合起来，可以组成一个完整的XMPP IM系统。包括服务器端—Openfire，客户端—Spark，XMPP传输协议的实现—Smack。三者都是基于Java 语言的实现。

Spark 提供了客户端一个基本的实现，并提出了一个很好的插件架构，可以基于插件方式来实现新增加的功能，而不需要改源代码，这样有利于项目架构，把对原始项目的影响降到最低。

Openfire 是基于XMPP 协议的IM 的服务器端的一个实现。当两个用户连接后，可以通过点对点的方式来发送消息，但是用户还需要连接到服务器来获取一些连接信息和通信信息，所以服务器端是必须的。Openfire提供了一些基本功能，也提供插件的扩展，像Spark一样，建议使用插件扩展的方式来增加新的功能。

Smack是一个XMPP 协议的Java 实现，提供了一套可扩展的API，不过有些时候，你还是不得不使用自己定制发送的XML 文件内容的方式来实现自己的功能

下图展示了三者之间的关系：

从图上可以了解到，client 端和server端都可以通过插件的方式来进行扩展，smack是二者传递数据的媒介。

[if !supportLists]1.1.1.1.4    [endif]Apache MINA

Openfire的通信处理基于Apache

MINA框架实现。Apache MINA是一个网络应用程序框架，用来帮助用户简单地开发高性能和高可靠性的网络应用程序。它提供了一个通过Java NIO在不同的传输例如TCP/IP和UDP/IP上抽象的事件驱动的异步API。

Apache MINA 也称为NIO框架库、客户端服务器框架库、一个网络套接字库。

MINA虽然简单但是仍然提供了全功能的网络应用程序框架：

●为不同的传输类型提供了统一的API:

○通过Java NIO提供TCP/IP 和 UDP/IP支持

○通过RXTX提供串口通讯(RS232)

○ In-VM管道通讯

●过滤器作为一个扩展特性; 类似Servlet过滤器

●低级和高级的API：

○低级: 使用字节缓存(ByteBuffers)

○高级: 使用用户定义的消息对象(objects)和编码(codecs)

●高度定制化线程模型：

○单线程

○一个线程池

○一个以上的线程池(SEDA)

●使用Java 5 SSL引擎提供沙盒(Out-of-the-box)

SSL•TLS•StartTLS支持

●超载保护和传输流量控制

●利用模拟对象进行单元测试

● JMX管理能力

●通过StreamIoHandler提供基于流的I/O支持

●和知名的容器(例如PicoContainer、Spring)集成

●从Netty平滑的迁移到MINA， Netty是MINA的前辈。

[if !supportLists]1.1.1.1.5    [endif]命名规则

Openfire中常见的类名后缀命名包括Starter、Plugin、Listener、Dispatcher、Handler、Manager、Provider，通常情况下，这些命名类包括如下意义：

XXStarter

系统启动类，如org.jivesoftware.openfire.starter.ServerStarter，调用其start()方法可启动系统应用。

XXListener

调度类，其中有很多关键方法，如addListener()，以组合的方式，为类内定义的静态Set<XXListener>实例添加XXListener对象。以便调用dispatchEvent(Stringproperty,

EventType eventType, Map<String, Object> params)方法遍历处理Set集中的XXListener对象（通过调用XXListener对象的各实际方法完成实际业务）。

XXPlugin

实现Plugin接口的插件类,需实现initializePlugin(PluginManagermanager,

File pluginDirectory)方法和destroyPlugin()方法。在其初始化方法中调用Dispatcher实现类的addListener()方法如PropertyEventDispatcher.addListener(this)。

XXProvider

实现面向接口编程方式的接口类，通过反射机制创建具体实现类的对象，反射类名配置在ofproperty表对应的记录propvalue属性中。若没有相关配置，则调用默认实现类，默认实现类类名命名规则为DefaultXXProvider。

XXHandler

实际处理类，以ConnectionHandler为例，在org.jivesoftware.openfire.spi.ConnectionManagerImpl类的startClientSSLListeners(StringlocalIPAddress)方法中，有这样一段代码：sslSocketAcceptor.bind(newInetSocketAddress(bindInterface,

port), newClientConnectionHandler(serverName));其中bind方法的第二个参数是新创建的一个ClientConnectionHandler的实例，而它就是ConnectionHandler的一个子类。

[if !supportLists]1.1.1.1.6    [endif]系统配置项

Openfire的系统配置项采用文件结合数据库表的方式配置，也有部分默认配置项通过Java硬编码方式配置（如org.jivesoftware.openfire.

ConnectionManager接口类中定义的DEFAULT_PORT、DEFAULT_SSL_PORT、DEFAULT_COMPONENT_PORT等），Openfire中比较重要的配置位置包括：

（1）src/conf目录下的openfire.xml配置文件。该配置文件为系统核心配置文件。在第一次启动Openfire并通过管理控制台完成安装配置后会往该配置文件中填入相应的配置信息。

（2）plugin.xml配置文件。该配置文件为各插件包下的核心配置文件，由它确定插件核心处理类和相应页面插件的展现等。配置项及含义详见官方插件开发说明部分。

（3）web.xml和web-custom.xml配置文件。用于配置servlet和用户自定义servlet(插件页面用，放在插件对应目录下)。

（4）ofproperty中的各条记录，该表中包括两个字段name和propvalue，分别代表配置项名和配置项值。

[if !supportLists]1.1.1.1.7    [endif]系统启动流程

系统启动时调用ServerStarter类中的start()方法，通过反射加载org.jivesoftware.openfire.XMPPServer类文件，创建实例时调用其构造函数，在其构造函数中调用其start()方法实际启动服务应用程序。Start()方法中首先调用verifyDataSource()方法验证并确保数据库可以访问，然后会调用loadModules();initModules();startModules();方法来对Module接口的实现类的各子类进行操作，依次完成模块的加载、初始化和启动操作。loadModules()方法中会调用loadModule(String

module)方法通过反射加载各模块类，参数字符串module为对应的模块核心处理类的类名,如AdHocCommandHandler。现以AdHocCommandHandler为例对接下来的处理流程进行说明。通过loadModule创建AdHocCommandHandler类实例时调用其构造函数，在构造函数中初始化了其私有AdHocCommandManager对象。在initModules()时调用AdHocCommandHandler实例的initialize(XMPPServer

server)方法对其私有属性对象进行初始化。然后调用start()方法，调用addDefaultCommands方法添加命令并启动命令（通过调用startCommand(AdHocCommand

command)方法实现）。

[if !supportLists]1.1.1.1.8    [endif]网络处理

[if !supportLists]Ø  [endif]消息监听服务

SSL等监听服务的调度在ConnectionManagerImpl类中实现。ConnectionManagerImpl.createClientSSLListeners()方法启动SSL监听

[if !supportLists]Ø  [endif]消息封装

信息处理采用XML节的方式传递信息，消息封装通常采用IQ、Message、Presence。

[if !supportLists]1.1.1.1.9    [endif]WEB服务器

Openfire采用内置的jetty作web服务器，在启动AdminConsolePlugin插件时调用startup()方法启动jetty服务器，9090为其明文端口，9091为其加密端口。

[if !supportLists]1.1.1.1.10  [endif]数据库处理

Openfire的数据库处理采用直接调用JDBC 的方式。核心类为org.jivesoftware.database.DbConnectionManager。数据库的处理与业务处理耦合，没有划分出专门的业务逻辑层。

ConnectionProvider

此类为数据库提供者接口，如需连接mysql、hsqldb等数据库，需首先实现些接口，处理方式

通常直接调用XXManager中的实例方法，XXManager中又调用的是对应的接口XXProvider的方法，实际操作在该接口的实现类中实现。实现类是动态绑定的（默认的实现类通常命名规则为DefaultXXProvider），在运行时根据ofproperty表中对应配置项值选择。下面以添加用户组为例进行说明。

首先获得GroupManager的一个实例，在调用其构造函数时调用initProvider()方法，在该方法中获取数据库中配置项的值，若不为空则根据该值通过反射机制获取GroupProvider接口的实现类实例对象；若为空则以DefaultGroupProvider作为GroupProvider接口的实现类并创建实例对象，然后调用GroupProvider.createGroup(String

name)方法完成业务操作。