openfire插件开发流程

项目准备

参考：http://www.yunliaoim.com/im/866.html

我们可以在源码目录的plugins下新建一个maven插件module，当然，也可以新建一个project去开发插件，我这里为了看代码、调试方便直接在源码的插件目录下新建了。父模块和其它的一些配置参考源码自带的openfire-plugin-assembly-descriptor插件。或者到官方代码库Ignite Realtime · GitHub找一些插件作为参考即可。

自定义插件，需要满足以下基本要求：

• 根目录下要包含：plugin.xml

• 根目录下包含一个java源码文件夹，同时要有一个实现了org.jivesoftware.openfire.container.Plugin 接口的java类。

我们这个插件实现openfire Server启动和关闭时，在控制台打印出消息。changelog.html、plugin.xml、readme.html这三个文件分别是你的插件修改日志文件，插件文件和自述文件。logo_small.gif，logo_large.gif是插件显示的图标（从别的插件随便拷贝过来好了），新建这几个文件，暂时留空。

插件类

新建插件类，插件简单的在初始化和销毁时打印一些简单的信息。通过pom的依赖关系可以看到父插件依赖了xmppserver，所以是可以直接使用xmppserver相关的接口了。

package com.nufront.openfire.plugin;
​
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
​
import java.io.File;
​
/**
 * @author kangming.ning
 * @date 2020/8/26 16:38
 */
public class HelloWorldPlugin implements Plugin {
​
    private XMPPServer server;
​
    @Override
    public void initializePlugin(PluginManager manager, File pluginDirectory) {
        server = XMPPServer.getInstance();
        System.out.println("HelloWorldPlugin----start");
        System.out.println(server.getServerInfo());
    }
​
    @Override
    public void destroyPlugin() {
        System.out.println("HelloWorldPlugin----destroy");
    }
}

plugin配置

编写根目录下plugin.xml的内容，内容如下，adminconsole是配置插件关联的页面，这里不需要。

<?xml version="1.0" encoding="UTF-8"?>
​
<plugin>
    <class>com.nufront.openfire.plugin.HelloWorldPlugin</class>
    <name>helloWorld</name>
    <description>First Openfire Custom Plugin.</description>
    <author>ningkangming</author>
    <version>1.0.0</version>
    <date>26/08/2020</date>
    <minServerVersion>4.5.3</minServerVersion>
    <adminconsole>
    </adminconsole>
</plugin>

编译安装插件

直接maven打成jar包还不可以用，因为没把plugin.xml打包进去，并且openfire插件的目录结构还得按规定，比如插件的jar得在lib目录下。接下来修改我们的插件pom，将相关资源打包进去。参考：https://www.twblogs.net/a/5eac125e6052e15026732da3，关键是添加如下配置

 <build>
        <!-- 插件打包后的jar包名称-->
        <finalName>helloworld</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <includes>
                        <!-- 只在jar里面放class文件 -->
                        <include>**/com/nufront/openfire/plugin/**</include>
                    </includes>
                    <outputDirectory>${project.build.directory}</outputDirectory>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>install</phase>
                        <goals>
                            <goal>resources</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <resources>
                        <resource>
                            <directory>${project.basedir}</directory>
                            <filtering>true</filtering>
                            <includes>
                                <include>changelog.html</include>
                                <include>readme.html</include>
                                <include>plugin.xml</include>
                                <include>logo_large.gif</include>
                                <include>logo_small.gif</include>
                            </includes>
                        </resource>
                        <resource>
                            <directory>${project.basedir}/src/main/web</directory>
                            <targetPath>web</targetPath>
                        </resource>
                    </resources>
                </configuration>
            </plugin>
            <plugin>
                <!-- ant插件, 這個最重要了, 以上三個插件只是能夠零散的把文件編譯並放在target文件夾下,
                我使用ant插件, 把文件整理起來, 並壓縮到指定的jar裏面 -->
                <artifactId>maven-antrun-plugin</artifactId>
                <version>1.3</version>
                <executions>
                    <execution>
                        <!-- 調用階段 -->
                        <phase>install</phase>
                        <goals>
                            <!-- 目標(命令) -->
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <tasks>
                                <echo message="開始構建插件包..."></echo>
                                <copy todir="${project.build.directory}/${project.build.finalName}-final/lib" overwrite="true" file="${project.build.directory}/${project.build.finalName}.jar"></copy>
                                <copydir dest="${project.build.directory}/${project.build.finalName}-final/" src="${project.build.directory}/classes/" excludes="org/**"></copydir>
                                <jar basedir="${project.build.directory}/${project.build.finalName}-final/" destfile="${project.build.directory}/${project.build.finalName}-final.jar"></jar>
                                <delete dir="${project.build.directory}/${project.build.finalName}-final/"></delete>
                            </tasks>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
​
        </plugins>
    </build>

把插件通过管理界面把helloworld-final.jar加载后可以发现正常加载，启动和关闭会把相关信息打印。（注意，打包用mvn install，用xx-final.jar）