插件開發說明 · 通訊前置服務介紹

# 插件開發說明插件開發手冊 ## **一、說明** 在實際項目應用當中，YFE前置系統內置的報文組件可能滿足不了某些報文解析要求，此時項目實施人員可以開發流程插件對特殊報文進行處理；在前置流程收到報文后調用插件進行解包，在返回應答報文前調用插件進行組包報文 ## **二、插件開發** 插件開發本質上是編寫一個業務處理jar包，放置到指定位置，然后在流程配置中配置對應的類路徑即可使用。 ### 1、新建Java項目新建一個普通的Java project即可。如果新建的是maven項目，要注意最后打包jar不能是運行包，maven依賴三方庫注意單獨拿出來，方面后續放到plugin目錄建議使用普通Java project 如果有之前創建的插件項目，亦可使用 ### 2、編寫業務處理邏輯在項目新建一個Java class。類名按業務自行定義。類的結構如下。 ``` <pre class="calibre29">``` package com.ylink.plugin.demo; import java.util.HashMap; import java.util.Map; import org.slf4j.Logger; import cn.hutool.core.date.DateUtil; public class DemoPlugin { /* * 日志對象，由通訊服務自動注入 */ public static Logger log; /** * 初始化方法 * * @param cfgs 當前接入配置 */ public static void initEnv(Map cfgs) { } /** * 插件具體執行業務處理 * 方法必須是static的 * 方法的入參的順序和數量是固定的 * * @param tranCode 交易碼 * @param inObj 傳入參數。有流程配置時指定 * @return 返回值無約束，根據業務執行定義 * @throws Exception */ public static Map<String, Object> test(String tranCode, Object inObj) throws Exception { log.info("客戶化插件調用開始。。。。。。。"); log.info("參數 1 交易碼={}", tranCode); log.info("參數 2 配置參數=={}", inObj); // TODO 1、參數校驗 // TODO 2、業務處理 Map<String, Object> retMap = new HashMap<String, Object>(); retMap.put("tranCode", tranCode); retMap.put("date", DateUtil.now()); return retMap; } } ``` ``` - log 日志對象，固定名稱，不可改，為org.slf4j.Logger 對象 - 類內為靜態方法 - 方法的入參是固定的格式，不能修改 - 方法返回值可以根據業務自行定義 - 插件中使用到三方庫，直接放到項目的lib文件夾，設置classpth即可 ### 3、導出jar Eclipse中直接在項目中右鍵 export Jar file即可： - 導出類型選擇 Java-> JAR file ![](https://img.kancloud.cn/63/7c/637cbe682a1a258acc93e26968f1b977_1006x606.png) - 導出文件只選擇src即可。Lib目錄無需導出 ![](https://img.kancloud.cn/53/ca/53ca6414e5f3f78e540e81feb7f3fa50_1016x188.png) ## **三、部署、配置** ### 1、部署將導出的jar放到通訊服務的根目錄的plugin文件夾(如沒有，新建一個)： ![](https://img.kancloud.cn/a9/44/a944d1e9f37582faa4040b91c891003d_976x526.png) - plugin文件夾和項目運行包同級 - 如果插件中使用的三方庫(插件項目lib目錄jar)在通訊服務中沒有引入，需要將三方jar也放到plugin目錄下 ### 2、配置流程接入配置:根據業務實際流程在相應位置增加【插件調用】節點。 ![](https://img.kancloud.cn/b6/c4/b6c4ccaaa408b67ef981a470b8ab309a_528x346.png) 配置插件信息：類名+方法名 ![](https://img.kancloud.cn/d1/f2/d1f21e03123f209d2d542915d964f137_1107x603.png) - 類名必須是類的全路徑名稱，通訊服務根據類名反射獲取類實例 - 方法名必須和插件類一致，通訊按照以下規則獲取方法調用：getMethod(strMethod, String.class, Object.class)