spark的插件主要用来增强客户端的功能,下文主要介绍一下spark插件的开发过程。
1.最终完成效果如下:
增加一个My Plugin菜单,点击后显示hello面板。
2.开发流程
1)插件结构
插件的jar包结构如下示:
example.jar
|- plugin.xml 插件定义文件
|- libs/ 包含所有运行此插件所需的classes文件
定义你的plugin.xml文件。spark会自动读取插件jar中的plugin.xml文件,进行插件加载工作。示例文件如下:
<!-- Define your plugins -->
<plugin>
<name>Examples Plugin</name>
<version>1.0</version>
<author>Derek DeMoro</author>
<homePage>http://www.jivesoftware.com</homePage>
<email>derek@jivesoftware.com</email>
<description>Shows some simple ways to create plugins.</description>
<!--插件的接口实现类-->
<class>com.jivesoftware.spark.examples.ExamplePlugin</class>
<minSparkVersion>2.5.0</minSparkVersion>
</plugin>
2)开发你的插件
插件源码目录结构
example
|- src 源代码
|- lib 支持此插件的额外jar文件
|- resources 图片等资源文件
|- build 编译文件
|-build.xml ant打包插件的配置文件
插件的实现类,你的类首先要实现Spark 提供的Plugin 接口,然后实现它的一些方法。
package org.jivesoftware.spark.examples;
import org.jivesoftware.spark.plugin.Plugin;
/**
* 通过实现方法的不同,来显示不同的插件功能
*/
public class ExamplePlugin implements Plugin {
/**
* 插件安装后,初始化插件
*/
public void initialize() {
System.out.println("Welcome To Spark");
}
/**
*spark关闭的时候调用,来实现信息持久化或释放资源
*/
public void shutdown() {
}
/**
* 当用户请求关闭spark时,如果可以关闭返回真
*/
public boolean canShutDown() {
return true;
}
/**
* 插件卸载的时候调用,清除磁盘上的资源,如文件,图像等以及插件安装时留下的所有组件
*/
public void uninstall(){
// Remove all resources belonging to this plugin.
}
}
开发流程待续,例子先放上
不好意思,因工作关系,插件开发的流程没有写完,不过放上的例子部署起来后应该就很明白了,不再继续写下去,我在开发过程中主要是参照官网文档,附上一点以前记录的资料地址:
spark的一些开源插件
http://version2software.com/software.html
spark插件打包说明
http://www.igniterealtime.org/projects/spark/sparkplug-kit.jsp