Openfire源代码

Openfire源代码分析

 

 

 

 

 

 

（运行环境的搭建）

  关于Openfire的介绍在此不多说了，网上有很多关于这个基于Java的XMPP服务器的介绍，也可以通Jivesoftware的官方网站www.jivesofteware.com来寻找关于Openfire的信息。
  如果研究Openfire的代码，建议第一步在本机上安装Openfire服务器和Spark这款XMPP的客户端程序，这样既可以熟悉一下Openfire的样态和功能，也可以在以后的源代码调试过程中通过Openfire的目录结构得到帮助.

 

 准备工作：Eclipse环境（当然包括JavaSE），Openfire的源代码包（例如：openfire_src_3_3_2.tar.gz，可到jivesoftware官方网站下载），Mysql数据库V5以上（当然可以用其他数据库，但在此例中选用Mysql作为Openfire的后台数据库）。

 

  第一步：有个好心情，通过Openfire的安装包将Openfire安装在本机上，具体实现见http://blog.csdn.net/expendable/archive/2007/06/25/1666122.aspx这里有详细的介绍。（除了数据库的部分）

  第二步：将openfire_src_3_3_2.tar.gz解压后目录下除了Readme和License以外有四个子目录。

1.               build目录：build目录下收录的是生成安装文件（例如：rpm）所要的一些文件，例如JRE等。
2.               resources目录：resources目录下收录的是一些为实现国际化（i18n）和本地化的一些编码文件（例如：英文，中文，法文，德文等）。
3.               documentation目录：documentation目录下收录的是一些关于Openfire安装和配置的信息，但最终要的是这里有Openfire开发的Javadoc。
4.               src目录：顾名思义这个src文件夹就是我们想要的Openfire源代码了，这下面又有许多文件夹，我们只要Java文件夹就好，这里面实现的Openfire的核心功能，通过它就可以调试Openfire了。
  第三步：在Eclipse中将此Java文件夹当成源代码文件夹新建工程，建立新工程后观察Openfire所import的包，发现Openfire用了许多开源工具，而这些库都在上文提到的Build目录的lib目录下（当然也可以到网上下载），将Openfire用到的库都添加到这个新建工程的Referenced Libraries中。或者如果这样一个一个添加比较麻烦的话还有一个方法就是从你安装好的Openfire服务器目录下的lib目录中（例如：”D:\Program Files\Openfire\lib”或 “/usr/local/openfire/lib”）找到openfire.jar，打开后将里面的org/jivesoftware删除，重新打包成jar并添加到这个新建工程的Referenced Libraries中，这样省去了很多工作。

  第四步：openfire的起始类为org.jivesoftware.openfire.starter.ServerStarter.java 但是直接运行此类却有问题，因为此类是针对Openfire安装包而设计的，此类的功能是将所用到的Jar文件解压并将class文件加载到虚拟机中，而我们要用的却是源代码中我们自己编译好的class文件，所以我们需要一个新的启动类，一个简单的实现如下（当然最好是与ServerStarter.java中的方法一样，用自定义的ClassLoader来将XMPPServer.class加载到虚拟机中）：

 

package org.jivesoftware.openfire.starter;

 

import org.jivesoftware.openfire.XMPPServer;

public class StandaloneStarter {

 

    public static void main(String[] args) {

       XMPPServer server = new XMPPServer();

    }

}

 

这样程序就可以跑起来了，最后的问题就是配置文件路径的问题，但我在此不想多少，留给访友调试解决了。

客户端连接）

Openfire的socket网络连接包括：

1.       服务器和服务器之间的连接（监听在端口5269）

2.       外部组件和服务器之间的连接（监听在端口5275）

3.       多元(complex)连接（监听在端口5269）

4.       客户端和服务器的连接（监听在端口5222）

5.       和客户端通过TLS/SSL3.0和服务器的连接。（监听在端口5223）

 

这些连接都是通过ConnectionManager接口实现管理的，程序中对ConnectionManager接口的实现类是ConnectionManagerImpl，它是作为一个模块（Module）类加载到服务器中的。

下面分析的是客户端和服务器的连接。

 

在ConnectionManagerImpl中是通过调用startClientListeners方法来初始化和开始端口监听的。

在startClientListeners方法使用的是Apache的Mina框架来实现网络连接的，Mina框架的模式如下：

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

IoFilter：

       IoFilter为MINA的功能扩展提供了接口。它拦截所有的IO事件进行事件的预处理和后处理。它与Servlet中的filter机制十分相似。多个IoFilter存放在IoFilterChain中

       IoFilter能够实现以下功能：

              数据转换

              事件日志

              性能检测

       在Openfire中主要用filter这种机制来进行数据转换。

 

Protocol Codec Factory：

       Protocol Codec Factory提供了方便的Protocol支持，通过它的Encoder和Decoder，可以方便的扩展并支持各种基于Socket的网络协议，比如HTTP服务器、FTP服务器、Telnet服务器等等。

       要实现自己的编码/解码器(codec)只需要实现interface: ProtocolCodecFactory即可，在Openfire中实现ProtocolCodecFactory的类为XMPPCodecFactory。

 

IoHandler:

    MINA中，所有的业务逻辑都有实现了IoHandler的class完成    ，当事件发生时，将触发IoHandler中的方法:

           sessionCreated

sessionOpened

sessionClosed

sessionIdle

exceptionCaught

messageReceived

messageSent

       在Openfire中客户端和服务器连接的IoHandler实现类是ClientConnectionHandler，它是从ConnectionHandler中继承来的。

 

 

startClientListeners方法首先为Mian框架设置线程池，再将一个由XMPPCodecFactory作为Protocol Codec Factory的Filter放入到FilterChain中，然后绑定到端口5222，并将ClientConnectionHandler作为IoHandler对数据进行处理。完成这些步骤后Openfire就在5222等待客户端的连接。

 

客户端连接的处理过程：

 

当有客户端进行连接时根据Mina框架的模式首先调用的是sessionOpened方法。

       sessionOpened首先为此新连接构造了一个parser（XMLLightWeightParser），这个parser是专门给XMPPDecoder（是XMPPCodecFactory的解码器类）使用的，再创建一个Openfire的Connection类实例connection和一个StanzaHandler的实例。最后将以上的parser, connection和StanzaHandler的实例存放在Mina的session中，以便以后使用。

 

       当有数据发送过来时，Mina框架会调用messageReceived方法

       messageReceived首先从Mina的session中得到在sessionOpened方法中创建的StanzaHandler实例handler，然后从parsers中得到一个parser（如果parsers中没有可以创建一个新的实例）（注意这个parser和在sessionOpened方法中创建的parser不同，这个parser是用来处理Stanza的，而在sessionOpened方法中创建的parser是在filter中用来解码的，一句话说就是在sessionOpened方法中创建的parser是更低一层的parser）。最后将xml数据包交给StanzaHander的实例hander进行处理。

 

       StanzaHander的实例hander处理xml数据包的过程

       StanzaHander首先判断xml数据包的类型，.如果数据包以“<stream:stream”打头那么说明客户端刚刚连接，需要初始化通信（符合XMPP协议）Openfire首先为此客户端建立一个与客户端JID相关的ClientSession，而后与客户端交互协商例如是否使用SSL，是否使用压缩等问题。当协商完成之后进入正常通信阶段，则可以将xml数据包交给这个用户的ClientSession进行派送（deliever），经过派送数据包可以发送给PacketRouteImpl模块进行处理。

    在PacketRouteImpl中包将进一步被细化处理，以后将继续分析。