如何开发一个网络服务插件

有了 快速搭建 Joget 开发环境 , 我们做好了前置工作,就可以动手开发插件了. 在这里,我们选择最简单的插件作为入门教程.

1.确定要开发的插件类型

• 我们这里确定为最简单的Web Service插件类型.
• 确定插件类型后,在 Joget 官方知识库寻找对应的文档. 
• 比如 Web Service 插件 ,该链接指向的是 Joget 官方开发 WebService 插件需要实现的接口和抽象类.

2.生成插件代码骨架

• 进入到之前搭建好的开发环境目录,一般是 Joget Source Code/wflow-plugin-archetype/

• 使用以下命令生成代码骨架

"C:\Joget Source Code\wflow-plugin-archetype\create-plugin.bat" packageName pluginFolderName jogetDependencyVersion

./create-plugin.sh packageName pluginFolderName jogetDependencyVersion

• 生成后的代码在当前目录

3.开始开发

• 复制代码文件到你喜欢的工作目录
• 使用JAVA IDE 打开它,我这里使用的是IDEA
• 新建主实现类,实现 WebService 类型插件的接口和抽象类

4.添加客户化依赖

• 为了更符合插件类型,我修改了文件目录和项目名称为 my-web-service
• 由于是一个maven项目,所以添加自定义依赖很简单(具体参考 https://www.runoob.com/maven/maven-external-dependencies.html )
• 我们这个项目需要 servlet-api 依赖,如图

5.自定义实现WebService插件类型的抽象方法

• 本例使用的是WebService类型的插件,因此,需要继承  ExtDefaultPlugin 抽象类和实现 PluginWebSupport 接口
• 这两个是从哪里得知的呢? 参见 https://dev.joget.org/community/pages/viewpage.action?pageId=27363105

6.测试打包编写好的插件

1. 修改Activator,如图
2. 使用maven打包

7.上传到 Joget 并测试使用

• 打开Joget,管理插件,上传插件
• 找到我们打包好的 jar 文件,一般在 target 目录下面
• 根据 文档 提示的地址进行访问,本例是 http://localhost:8080/jw/web/json/plugin/com.vps.joget.MyWebService/service?action=Hello World

8.恭喜,你已经学会了Joget 插件开发!