部署Openfire源码（转）

1. 获取Openfire 3.5.1源代码
官方主页：http://www.igniterealtime.org/
（1）从官方网站上直接下载官方发布版本的源代码Openfire_3_5_1.zip源代码压缩包；
但是，2008年4月24官方发布的源代码中使用了import testng.xxx语句，所以额外需要下载并导入testng-5.8-jdk15.jar类库。否则会提示错误信息。
（2）也从官方网站上可以下载最新版（nightly builds），如源代码压缩包openfire_src_2008-05-31.zip
（3）使用Eclipse的版本控制插件SVN获取（检出为），具体步骤为：
* 在eclipse中，选择Windows->Open Perspective->Other
* 在弹出的窗口中，选择SVN Repository Exploring, 然后点OK

* 在SVN Repositories 视图中单击右键，选择 New->Repository Location...

*在弹出的New Repository Location对话框的输入URL文本框中输入：
http://svn.igniterealtime.org/svn/repos/openfire/trunk

然后，单击Finish. 你将会看到页面中出现URL地址
* 展开URL地址与openfire树形结构
* 在trunk上点击右键，选择Check Out（检出为），即可将源代码保存到您所指定的目录下。
* 用Create project from existing source新建工程，注意工程名要用openfire。

2. 创建openfire工程
2.1 源文件目录结构

将openfire_src_3_5_1.zip解压后，目录下除了READEME.html、LICENSE.html和changelog.html三个网页文件之外，有下面四个子目录:
build目录：build目录下收录的是生成安装文件（例如：rpm）所要的一些文件，例如JRE等。
resources目录：resources目录下收录的是一些为实现国际化（i18n）和本地化的一些编码文件（例如：英文，中文，法文，德文等）。
documentation目录：documentation目录下收录的是一些关于Openfire安装和配置的信息，但最终要的是这里有Openfire开发的Javadoc。
src目录：这个src文件夹就是我们想要的Openfire源代码了，这下面又有许多文件夹，Java文件夹面实现的Openfire的核心功能，通过它就可以运行和调试Openfire。

 

2.2 搭建openfire工程
（1）从现有资源新建项目：File->New->Java Project，在弹出的New Java Project对话框中输入工程名：openfire（源代码默认的工程名是openfire，其它名字也可以的），选择Create project from existing source项，单击Browe，找到当前工作空间目录(\workspace目录)下存放源代码的openfire文件夹。（推荐初学者使用这样方法，因为编译、打包、调试等已经做好，可以直接使用）

（2）如果您是做二次开发，为了定制自己的服务器端，就可以采用这样方法：
* 新建工程：File->New->Project->Java Project，单击Next，在Project name文本框中输入工程名：openfire，单击Finish
* 解压后得到的openfire_src_3_5_1\目录下所有内容复制到新建的工程目录workspace\openfire下
* 在Package Explorer视图中，右击openfire工程，选择Properties，在弹出的对话框中选择Libraries->Add JARs..，把openfire_src_3_5_1/build/lib目录下的*.jar类库及lib里面的文件夹的*.jar包全部添加进来；

*选择Source标签页，Add Folder..，选中src/java目录前的复选框，点击OK，并删除原来的openfire/src文件夹，点击OK按钮。

*若在Libaries选项卡只用的是JRE，那么需要remove掉，然后在Add Library里选择JRE System Library，然后加入一个JDK给它，这样项目的叉号才消失。

（在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项目没有打包部署，需要开发者自己完成相应的工作。

注意：新建工程之后，可能会出现一些警告信息，下面对此予以说明：
对于警告信息，是没有关系的。因为这些警告信息是使用1.5以上版本JDK时候才出现的，使用JDK1.4是不会出现这些警告信息的。因为这些代码中的有些是使用JDK 1.4编写的，而JDK1.4不支持泛型，而JDK 1.5和JDK1.6是支持泛型的。这些警告信息主要是提示将这些非泛型的代码修改为更加高级的方法——泛型，所以这些警告信息是不影响代码结果的。如果需要修改为泛型也是可以，使用泛型来处理相关的集合类。

3. 编译工程
openfire是用ant构建的，所以要先设置使得eclipse中每次编译都使用内置的ant工具，保证编译的正确执行。同时，要在Eclipse中设置为使用JDK作为JVM，如果使用JRE作为JVM，编译就会失败。
因为openfire在Windows下是使用install4j打包成.exe格式的安装文件的，所以需要安装install4j。否则，在使用ant进行编译的时候，在ant视图中可能会出现警告如下信息：taskdef class com.install4j.install4jtask cannot found。这主要是要安装用来打包Java应用程序的install4j.exe程序，而且将要安装到其默认的安装路径C:\Program Files\install4j下(这个好像不用安装也可以的，这个信息是在build.xml里写着的，我没用安装它也可以build successs，只是ant的图标上有警告而矣)。
（1）在eclipse中点击Window->Show View->Ant，打开Ant窗口；
（2）在Ant 视图中，单击右键，在弹出的快捷菜单中选择Add Buildfiles..；
（3）在弹出的对话框中，展开openfire/build文件夹，选择build目录下的build.xml，点击OK；
（4）在Ant视图中, 展开Openfire XMPP Server，双击 openfire（default）编译工程
（5）如果在Console视图中显示“BUILD SUCCESSFUL”就表示编译成功。



4. 创建项目Builder
（1）在eclipse的菜单栏中，选择Run->Open Run Dialog...，在弹出的对话框左侧的树形结构中选择Java Application，单击右键，选择New创建启动配置。
（2） 在Run窗口的Main选项卡中, 修改Name文本框中的值，改成包含要启动的类的工程名openfire
（3）在Run窗口的Main选项卡中，点Browse按钮，选择openfire
（4）在Run窗口的Main选项卡中，点Search按钮，选择Main class为
org.jivesoftware.openfire.starter.ServerStarter，单击Apply按钮。（这是openfire的启动类）


（5）点击进入Arguments选项卡，在VM arguments文本框中输入
-DopenfireHome="${workspace_loc:openfire}/target/openfire"
单击Apply按钮。这个是用于eclipse执行java命令时传递的参数，这样openfire程序可以通过System.getProperty(“openfireHome”)得到openfire的本地位置，target/openfire是运行build.xml后生成的，它应该是运行的所有类和配置文件的所在地。

（6）点击进入Classpath选项卡，选中User Entries，这样Advanced...就处于可用状态；点击Advanced...按钮，在Advanced Options页面，选择Add Folders, 单击OK。（默认情况下，已经将工程openfire添加到了这里，而不需要进行该项操作，如果有多个工程的时候才需要执行该项操作。）
选择openfire\src\i18n, 点OK按钮将这个文件夹加入到Classpath选项卡中；同样的方式把openfire\src\resources目录下的jar文件夹也加到Classpath选项卡中。
（7）在Common选项卡中，勾选Run复选框，单击Apply按钮。
设置完毕，这样以后在run这个工程的时候就会按照正确的配置进行了，debug的设置和run的设置类似，不再多说。

 

5. 运行并测试编译结果（openfire服务器）
（1）在Eclipse菜单中，单击Run->Run（或快捷方式Ctrl+F11），在Console试图中出现如下所示的信息。
Openfire 3.6.4 [Aug 12, 2010 3:11:24 PM]
Admin console listening at http://127.0.0.1:9090

（2）在Web浏览器中，输入http://127.0.0.1:9090/，如果可以出现配置的openfire的页面，就表示openfire编译、运行成功。

 

6. 自己定制openfire服务器时，在Eclipse对openfire源代码进行部署
参考网址：http://blog.csdn.net/racingtom/archive/2007/09/27/1803908.aspx
openfire的起始类为org.jivesoftware.openfire.starter.ServerStarter.java，但是直接运行此类却有问题，因为此类是针对Openfire安装包而设计的，此类的功能是将所用到的JAR文件解压并将class文件加载到虚拟机中，而我们要用的却是源代码中我们自己编译好的class文件。所以，我们需要一个新的启动类。
（1）一个简单的实现方法就是把src/java下的东西复制到我创建的java project下的src里了，并修改org.jivesoftware.openfire.starter包中ServerStarter.java类的源代码，具体如下（当然最好是与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();

}
}
这样程序就可以跑起来了，最后的问题就是配置文件路径的问题。
（2）配置文件路径
如果文件路径配置不正确（即Openfire的Home没有设定或者设置不正确），就可能在运行时出现如下所示的问题：
Could not locate home
java.io.FileNotFoundException......

ERROR 12114 [Jive-ERR] ():
java.io.FileNotFoundException: XML properties file does not exist: openfire.xml........
在XMPPServer类中有一个locateOpenfire方法，这个方法就是设置openfireHome属性。
第1部分的代码如下：
String jiveConfigName = "conf" + File.separator + "openfire.xml";
// First, try to load it openfireHome as a system property.
if (openfireHome == null) {
String homeProperty = System.getProperty("openfireHome");
try {
if (homeProperty != null) {
openfireHome = verifyHome(homeProperty, jiveConfigName);
}
}
catch (FileNotFoundException fe) {
// Ignore.
}
}
是在环境变量设置了Openfire的Home的情况下寻找openfire.xml文件

你可以更改第二部分的代码让Openfire找到Home：
// If we still don't have home, let's assume this is standalone
// and just look for home in a standard sub-dir location and verify
// by looking for the config file
if (openfireHome == null) {
try {
//修改的是下面的代码，将".."替换为其他路径了
openfireHome=verifyHome("C:\\Program Files\\Openfire", jiveConfigName).getCanonicalFile();
}
catch (FileNotFoundException fe) {
// Ignore.
}
catch (IOException ie) {
// Ignore.
}
}
这部分默认是找当前文件路径，你可以修改它为你安装openfire的路径，这样问题就可以解决了。
（3）将新建的工程目录下src/web/WEB-INF/classes/openfire_init.xml导入到eclipse的查询路径里，如将src/web/WEB-INF/classes目录作为eclipse的源目录，这样openfire_init.xml自动copy到$openfire_home/classses下面，将openfire_init.xml中的openfireHome设置为$openfire_home
修改org.jivesoftware.openfire.starter.ServerStarter中的如下两个field，
private static final String DEFAULT_LIB_DIR = "../lib";
private static final String DEFAULT_ADMIN_LIB_DIR = "../plugins/admin/webapp/WEB-INF/lib";
改成：
private static final String DIR_PREFIX = "$openfire_home";
// to be your own openfire_home
private static final String DEFAULT_LIB_DIR = DIR_PREFIX + "lib";
private static final String DEFAULT_ADMIN_LIB_DIR = DIR_PREFIX + "plugins/admin/webapp/WEB-INF/lib";
现在还不知道这里为什么要这样做？？？？？
10. 打包openfire编译结果
（1）编译成功之后，可以将openfire打包，以便安装和使用。
（2）在源码里面有一个文件夹里有个打包的图标，双击那个图标，install4j就会读取你在build.xml文件里的信息、在里面完成做界面等打包工作。

评论

1 楼 mzba520 2011-10-28  

我想请问能不能把openfire部署到tomcat中去，就是把它当成是一个网站来访问，而不是采用安装的形式。因为我有个虚拟空间，只有一个webapps的目录。