Openfire源码阅读（一）

本篇先分析openfire源码的主要流程，模块细节后续再继续分析；

一、简介：

Openfire是开源的实时协作服务器（RTC），它是基于公开协议XMPP（RFC-3920），并在此基础上实现了XMPP-IM(RFC-3921)，扩展了IM功能，对实施协作的各种场景做较全面的考虑，如用户在线状态切换、消息订阅、通知等等，因此可以用来搭建即时通信服务器，其搭建的方法也很简易。

1、账号体系：

• XMPP服务器的帐号基础，是域（Domain），例如：org.example.com，它在服务器配置时的时候设置，也是服务器能被访问到的域名或IP地址。客户端连接的时候，用这个域去寻找服务器。
• JID：XMPP中，任何一个可能进行通信的实体，包括一个用户、或者一个聊天室，都需要一个JID。

用户的JID格式为：usre@domain，如：abc@org.example.com

聊天室的JID为：room@conference.domain， 如ABC@conference.org.example.com

一般情况，JID后面还会附带一个资源名（resource），指代这个客户端的来源，比如：abc@org.example.com/pc-abc，表示这个JID在一台名为pc-abc的设备上登录。这是同一个帐号能够在多个设备中登录的基础。

2、通信端口：

C-S连接的端口是5222，S-S连接的端口为5269，这些端口已经在MINA注册。

3、通信机制：

当客户端连接上XMPP服务器创建会话时，首先是建立一个TCP长连接，并在这个连接上收发XML流进行协商，协商通过后，服务端与客户端，可以通过Message、Presence、IQ这三种格式进行数据交换。

• Message：基本的消息发送，不要求得到响应，用于即时通信、群组、通知等；
• Presence：用来表明用户的状态，当用户离线或改变自己的状态时，就会在stream的上下文中插入一个Presence元素，来表明自身的状态。
• IQ：一种请求／响应机制，类似于Http的get请求。

4、  模块和插件（module/plugin）：

在openfire里主要是module和plugin两类模块，一般情况下内部的模块都用module，对于一些功能的扩展或者第三方的开发扩展使用Plugin。官方其实也会自己写一个插件来扩展功能，说明插件还是比较灵活的。

Module的生命周期：initialize->start->stop->destroy；

二、启动过程：

1、 XMPPServer.start开始启动Openfire，首先会在initialize中完成全局变量openfireHome初始化以及配置文件openfire.xml文件的定位，然后加载系统全局配置JiveGlobals；

2、 接下来完成系统全局变量的初始化并构造全局对象XMPPServerInfoImpl（部分变量是从刚才的配置文件中读取的）；

3、 初始化缓存对象：缓存对象有两种：单机运行时的本地缓存DefaultLocalCacheStrategy和集群环境下的集群缓存ClusteredCacheFactory，默认初始化为本地缓存DefaultLocalCacheStrategy，当从单机切换到集群，或者从集群切换到单机环境下时，缓存对象也相应的切换；

4、 verifyDataSource验证数据库连接是否能正常连接上数据库，如果连接正确则继续启动，否则退出openfire的启动；

5、 loadModules加载模块：将所有模块加载到hash表modules中（Class为Key，module实例为value），注意ConnectionManagerImpl模块是最后加载的，因为openfire采用mina作为服务器处理客户端连接的，在这个模块中进行了mina的服务器端绑定端口、连接管理、端口监听等事情，因此需要其他模块都能先启动起来以保证这个模块能正常启动；

6、 initModules和startModules会循环遍历所有的module，依次调用么每个模块的 init和start方法；

7、 最后调用pluginManager.start方法来启动PluginMonitor线程；PluginMonitor线程的主要处理：解压插件目录下所有拓展名为jar和war的插件，用loadPlugin( )装载该插件，最后通过firePluginsMonitored( )函数调用插件的监听函数。

三、Message请求处理流程：

上图只是一个简化后的基本流程处理图；

1、客户端连接服务器，服务器的MINA框架的业务处理Handler对象ClientConnectionhandler接收到连接请求，在sessionOpened中根据IoSession创建NIOconnection对象并绑定到Iosession上；

2、客户端发送封装好的登录协议，ClientConnectionhandler接收到后会创建ClientStanzaHandler对象，然后将接收到数据交给ClientStanzaHandler来处理：根据连接创建LocalClientSession对象并添加到PreAuthenticatedSessions（这个session管理器中存储着客户端与服务器建立的连接的session，但是还未通过登录认证的session）管理器中，然后完成账号的登录验证处理（验证完成后客户端会发送一个xmpp-bind的IQ协议，此时会将这个LocalClientSession添加到routingTable中，并从PreAuthenticatedSessions管理器中删除：routingTable存储了客户端JID和LocalClientSession的对应关系，这样就可以根据JID找到对应的LocalClientSession并将消息发送给对应的客户端）；

3、客户端给另一个客户端发送chat消息时，消息先到达服务器ClientConnectionhandler，服务器先封装成协议数据包Message，然后交由PacketRouterImpl进行路由（PacketRouterImpl首先根据消息类型（message, IQ, Presence）交由对应的Router处理，这里chat会交由MessageRouter来处理，然后MessageRouter交给RoutingTableImpl来路由，RoutingTableImpl根据JID的信息决定路由给本地路由器localRoutingTable还是远程路由器remotePacketRouter来处理，本地路由器localRoutingTable根据JID找到对应的LocalClientSession），最后路由到对应的LocalClientSession，通过他将消息数据包Message发送给对应客户端；

上面的流程只是一个概要流程，openfire代码中具体的详细的的时序图如下：

1、客户端发送登录协议到服务器的ConnectionHander处理（ConnectionHander是MINA框架的业务逻辑处理Hanlder，新消息到达时触发messageReceived方法），服务器创建该session的协议分析器ClientStanzaHandler，然后将协议Message交给ClientStanzaHandler来处理；

2、ClientStanzaHandler.process根据连接信息创建LocalClientSession对象并添加到localSessionManager.PreAuthenticatedSessions管理器中（PreAuthenticatedSessions管理器中的session是还未登录认证的session），然后给客户端回复两条报文（其实就是登录过程中，服务端收到客户端第一个初始化流之后的两个应答：第一个是流回复，第二个是通知客户端进行STL协商。），接着完成登录认证；

3、登录成功后，客户端再发送一条chat聊天消息，ConnectionHander收到消息后，封装成Message协议数据包，传递给PacketRouterImpl.route方法来路由消息；

4、PacketRouterImpl.route中判断数据包类型，根据不同的数据包类型交给不同的路由器进行路由，Message消息交给messageRouter路由，presence消息交给presenceRouter路由，IQ消息交给iqRouter路由；

5、messageRouter.route判断是广播还是点对点，这里的chat是点对点，于是就交给RoutingTableImpl.routePacket来路由处理；

6、RoutingTableImpl.routePacket根据接收客户端的JID判断是本地路由还是远程计算机路由，本地路由时根据接受者的JID从LocalRoutingTable中查找出对应的LocalSession（LocalRoutingTable对象里面有个hash表routes，存储了JID和LocalSession的键值对，在客户端登录成功并发送xmpp-bind时，服务器会将Session和JID保存到这个hash表中，同时从PreAuthenticatedSessions管理器中删除该session），然后将协议数据包交给LocalSession. Deliver来处理，然后LocalSession又交给NIOConnection. Deliver来处理，最后交给MINA的IoSession.Write将数据包发送给接收客户端；

四、IQ请求处理流程：

与Message消息处理流程类似，IQ请求消息处理在交由Router组件路由之前与Message消息的处理完全相同；在服务器处理完成生成响应数据包后再交由路由器路由时的流程也与Message消息的处理完全相同；具体流程如下：

1、ConnectionHandler在收到IQ请求后将请求交给PacketRouterImpl.route路由时，Message消息交给messageRouter处理，IQ请求交给IQRouter来路由处理；

2、IQRouter.route中首先根据命名空间namespace来查找对应的IQHandler，然后交由对应的IQHandler.process来处理；每一个IQ协议都有其对应的namespace和IQHandler，他们注册在IQRouter. namespace2Handlers的hash变量中（这个hash表保存了namespace和IQHandler的键值对）；在前面XMPPServer启动时将所有的module实例注册到一个hashMap中，其中实现了IQHandler的module又被注册到namespace2Handlers的hash表中，这样，此处的getHandler就能根据namespace查找到对应的IQHandler实例了；

3、IQHandler是一个抽象类，不同的IQ请求分别有不同的派生类实现，每个派生的IQHandler子类需要实现两个接口：getInfo返回该IQHandler的信息，包括name和namespace属性，handleIQ需要根据传入的IQPacket包进行处理，生成响应应答信息并封装成IQPacket；IQHandler.process方法生成响应应答数据包后，将其交给PacketDelivererImpl对象的deliver发送；

4、PacketDelivererImpl. Deliver又交给SocketPacketWriteHandler.process处理，接着又交给RoutingTableImpl. routePacket来处理，最后的处理流程与message消息的路由流程完全相同；