低代碼集成Java系列：高效構建自定義插件

前言

隨着軟件開發的快速發展和需求的不斷增長，開發人員面臨着更多的壓力和挑戰。傳統的開發方法需要花費大量的時間和精力，而低代碼開發平臺的出現爲開發人員提供了一種更加高效、快速的開發方式。今天小編就以構建命令插件爲例，展示如何使用Java語言高效構建自定義插件。

環境準備

• 活字格插件構建工具-Java版（forguncyJavaPluginGenerator）
• 活字格設計器（v10.0版本及以上）
• IDE編譯器（例如IntelliJ IDEA Community Edition）
• Java運行時環境（Java Runtime Environment）
• JDK8.0版本及以上

插件生成器

打開活字格插件構建工具-Java版鏈接（forguncyJavaPluginGenerator），下載【活字格Java擴展創建工具】。推薦使用壓縮包版本創建。

打開【forguncyJavaExtensionGenerateTool.exe】，在如下界面配置插件的基礎信息：

點擊創建服務端命令插件，創建完成後，在設置的對應目錄下會生成工程文件：

接下來使用IDE編譯器打開MyPlugin工程，打開後，工程目錄如下圖：

至此就完成了前期的準備工作，下面我們來進行代碼邏輯的編寫。

代碼實現

添加依賴

在實現代碼之前，我們先要增加一些活字格的相關依賴，如下圖我們需要給pom文件中添加如下依賴：

插件的圖標和Logo替換Icon.png和PluginLogo.png即可。

而【PluginConfig.json】用於對插件的信息做基本的配置：

{
  "assembly": [],                                    // 如需要加載其他類
  "javascript": [],                                  // 如需加載其他JavaScript文件
  "css": [],                                         // 如需加載其他css文件
  "image": "resources/PluginLogo.png",               // 需要加載圖片的相對路徑
  "description": "這是一個活字格插件",                 // 插件的文本描述信息
  "description_cn": "這是一個活字格插件",              // 插件的中文文本描述信息
  "name": "MyPlugin",                                // 插件名稱
  "name_cn": "我的插件",                              // 插件中午名稱
  "pluginType": "command",                           // 插件類型，當前爲命令類型插件
  "guid": "fefeb164-ab98-48c8-b309-b5410052e504",    // 插件唯一標識GUID，建議勿修改
  "version": "1.0.0.0",                              // 插件版本
  "dependenceVersion": "10.0.0.0"                    // 插件支持依賴最低活字格版本
}

編寫核心代碼邏輯

在完成上述配置之後，就可以編寫插件邏輯了。下面是插件的一段示例代碼，主要是通過5個參數（AppSecret、請求ID、時間戳、數據和簽名結果）生成一段隨機數簽名。

package org.example;

import com.grapecity.forguncy.LoggerContext;
import com.grapecity.forguncy.commands.ICommandExecutableInServerSide;
import com.grapecity.forguncy.commands.IServerCommandExecuteContext;
import com.grapecity.forguncy.commands.annotation.ResultToProperty;
import com.grapecity.forguncy.commands.annotation.common.Category;
import com.grapecity.forguncy.commands.entity.Command;
import com.grapecity.forguncy.commands.entity.ExecuteResult;
import com.grapecity.forguncy.commands.enumeration.CommandScope;
import com.grapecity.forguncy.plugincommon.common.annotation.*;
import lombok.Data;
import org.apache.commons.codec.binary.Base64;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import javax.servlet.http.HttpServletRequest;

@Data
@Icon( uri= "resources/Icon.png")
@Category(category = "程傑合集")
public class MyPlugin extends Command implements ICommandExecutableInServerSide {

    private static final char[] DIGITS = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };

    @DisplayName(displayName = "AppSecret")
    @FormulaProperty
    @Required
    private String appSecret;

    @DisplayName(displayName = "請求ID")
    @FormulaProperty
    @Required
    private String requestId;

    @DisplayName(displayName = "時間戳")
    @FormulaProperty
    @Required
    private String timestamp;

    @DisplayName(displayName = "數據")
    @FormulaProperty
    @Required
    private String data;

    @ResultToProperty
    @FormulaProperty
    @DisplayName(displayName = "簽名結果")
    private String resultTo = "結果";

    @Override
    public ExecuteResult execute(IServerCommandExecuteContext dataContext) {
        Long innerTimestamp = Long.parseLong(timestamp);
        String res = null;
        try {
            res = sign(appSecret, requestId, innerTimestamp, data);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        try {
            dataContext.getParameters().put(resultTo, res);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }

        ExecuteResult executeResult = new ExecuteResult();
        executeResult.getReturnValues().put("結果", res);
        return executeResult;
    }

    @Override
    public boolean getDesignerPropertyVisible(String propertyName, CommandScope commandScope) {

        return super.getDesignerPropertyVisible(propertyName, commandScope);
    }

    @Override
    public String toString() {
        return "簽名程傑";
    }

    public static String sign(String appSecret, String requestId, Long timestamp, String data) throws Exception{
        // 1.簽名參數按自然升序排列,拼接上data
        StringBuilder sb = new StringBuilder();
        sb.append("appSecret=").append(appSecret).append("&")
                .append("requestId=").append(requestId).append("&")
                .append("timestamp=").append(timestamp)
                .append(data);
        // 2.對簽名字符串base64編碼後獲取32位md5值
        // 2.對簽名字符串base64編碼後獲取32位md5值
        String base64Encode = base64Encode(sb.toString().getBytes("UTF-8"));
        String md5Value = md5(base64Encode);
        // 3.將得到的MD5值進行sha1散列,轉換爲16進制字符串
        String sign = sha1(md5Value);
        return sign;
    }

    /**
     * 對字符串進行MD5加密,得到32位MD5值
     * @param text 明文
     * @return 密文
     */
    public static String md5(String text) {
        try {
            MessageDigest msgDigest = MessageDigest.getInstance("MD5");
            msgDigest.update(text.getBytes("UTF-8"));
            byte[] bytes = msgDigest.digest();
            // 轉成16進制
            return new String(encodeHex(bytes));
        } catch (NoSuchAlgorithmException e) {
            throw new IllegalStateException("System doesn't support MD5 algorithm.");
        } catch (UnsupportedEncodingException e) {
            throw new IllegalStateException("System doesn't support your  EncodingException.");
        }
    }

    /***
     * SHA加密
     * @return
     */
    public static String sha1(String content) throws Exception {
        MessageDigest sha = MessageDigest.getInstance("SHA1");
        byte[] byteArray = content.getBytes("UTF-8");
        return new String(encodeHex(sha.digest(byteArray)));
    }


    /**
     * base64編碼
     *
     * @param content
     * @return
     * @throws Exception
     */
    public static String base64Encode(byte[] content) throws Exception {
        return Base64.encodeBase64String(content).replaceAll("(\\\r\\\n|\\\r|\\\n|\\\n\\\r)", "");
    }

    /**
     * base64解碼
     *
     * @param content
     * @return
     * @throws Exception
     */

    public static byte[] base64Decode(String content) throws Exception {
        return Base64.decodeBase64(content);
    }

    /**
     * 轉換成16進制
     * @param data
     * @return
     */
    private static char[] encodeHex(byte[] data) {
        int l = data.length;
        char[] out = new char[l << 1];
        // two characters form the hex value.
        for (int i = 0, j = 0; i < l; i++) {
            out[j++] = DIGITS[(0xF0 & data[i]) >>> 4];
            out[j++] = DIGITS[0x0F & data[i]];
        }
        return out;
    }
    public static String getPostData(HttpServletRequest request) {
        StringBuilder data = new StringBuilder();
        String line;
        BufferedReader reader;
        try {
            reader = request.getReader();
            while (null != (line = reader.readLine())) {
                data.append(line);
            }
        } catch (IOException e) {
            return null;
        }
        return data.toString();
    }
}

使用maven打包插件

代碼寫完後，將整個項目打包：在此處點擊【clean】，然後點擊【install】：

接着在【target】目錄會出現打包產物：

緊接着把打包後的zip插件安裝到活字格設計器使用。

新建命令，在命令選擇中就可以找到剛纔打包的插件。

填寫參數：

可以在服務端命令中進行測試：

可以看到，上圖的測試結果中返回了一段隨機數簽名。這樣，一個使用Java語言構建的插件就已經開發完成啦。

總結

以上就是如何使用Java如何在低代碼平臺中開發一個命令插件的全過程，如果您想了解更多的信息，歡迎點擊這裏查看。

擴展鏈接：

從表單驅動到模型驅動，解讀低代碼開發平臺的發展趨勢

低代碼開發平臺是什麼？

基於分支的版本管理，幫助低代碼從項目交付走向定製化產品開發