构建可调试的openfire插件

最新推荐文章于 2023-10-03 09:12:45 发布

yezis

最新推荐文章于 2023-10-03 09:12:45 发布

阅读量2k

点赞数 1

分类专栏： Openfire 文章标签： openfire

本文链接：https://blog.csdn.net/yezis/article/details/49454065

版权

Openfire 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

在http://blog.csdn.net/yezis/article/details/38313151中，以及很多博文都写过关于openfire的插件开发方式，都是新建一个项目去编写openfire插件，一开始我也是用的这种方式，后来放弃了，因为当插件功能趋于复杂后，不能调试是一个很大的问题，所以，我换了一种开发openfire插件的方式。

首先，必须使用openfire的源码，这是必须的，具体的方法可以自行寻找。

当部署完openfire的源码后，我们可以看法源码中有许多plugins关键字，其实这都是一个个插件

这些包的命名方式都是 src/plugins/插件名/src/java

之后在src/plugins文件夹下我们随便打开一个文件夹：

文件夹的命名就是插件的名字；lib存放插件所使用的第三方jar包；src为插件的源码；plugin.xml为插件的配置文件，很重要。其余的是一些图标与说明文档

好的openfire自带插件的结构就是这个样子，现在我们依照例子，创建自己的openfire插件。

一、按照下图操作，创建一个源码包

源码包的命名规则为：src/plugins/插件名/src/java

二、创建插件源码

创建完成后，在src/plugins/yezi/src/java下创建一个包，并在包下创建一个插件入口类，结构与类的源码如下：

TestPlugin.java

package net.yezi.openfire.plugin;

import java.io.File;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
import org.jivesoftware.openfire.interceptor.InterceptorManager;
import org.jivesoftware.openfire.interceptor.PacketInterceptor;
import org.jivesoftware.openfire.interceptor.PacketRejectedException;
import org.jivesoftware.openfire.session.Session;
import org.xmpp.packet.Packet;

public class TestPlugin  implements Plugin, PacketInterceptor {
	
    private InterceptorManager interceptoerManager;
    
    public TestPlugin() {  
        interceptoerManager = InterceptorManager.getInstance();  
    }
    
    /*
     * message Interceptor
     * @see org.jivesoftware.openfire.MessageRouter.route(Message)
     */
	@Override
    public void interceptPacket(Packet packet, Session session,  
            boolean incoming, boolean processed) throws PacketRejectedException {  
    	
		System.out.println(packet);
    	
    }
    
    @Override  
    public void initializePlugin(PluginManager manager, File pluginDirectory) {  
        interceptoerManager.addInterceptor(this);  
    }  
  
    @Override  
    public void destroyPlugin() {  
        interceptoerManager.removeInterceptor(this);  
    }  
    
}

简单点说就是，如果openfire收到了来自终端聊天的数据后，就会把聊天说句的节点打印出来，就是运行了interceptPacket方法

三、创建插件声明文件

之后，打开项目根目录下打开src/plugins/yezi文件夹，并创建一个lib文件夹，拷贝其他目录下的说明文件：

修改plugins.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
	<!-- 这是插件的入口类地址 -->
	<class>net.yezi.openfire.plugin.TestPlugin</class>
 
	<!-- Plugin meta-data -->
	<name>yezi</name>
	<description>yezi</description>
	<author>yezi</author>
 
	<version>1.0.0</version>
	<date>27/10/2015</date>
	<url>http://yezi.net</url>
	<minServerVersion>1.0.0</minServerVersion>
	<licenseType>gpl</licenseType>
 
	<adminconsole>    
	</adminconsole>
</plugin>

最重要的就是class节点下的值，需要正确声明插件的入口类地址

四、编译插件

之后修改项目下build下的build.properties.template文件，重命名为build.properties