Java整合系列:高效構建自定義外掛

葡萄城技术团队發表於2024-04-22

前言

隨著軟體開發的快速發展和需求的不斷增長,開發人員面臨著更多的壓力和挑戰。傳統的開發方法需要花費大量的時間和精力,而低程式碼開發平臺的出現為開發人員提供了一種更加高效、快速的開發方式。今天小編就以構建命令外掛為例,展示如何使用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如何在低程式碼平臺中開發一個命令外掛的全過程,如果您想了解更多的資訊,歡迎點選這裡檢視。

擴充套件連結:

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

低程式碼開發平臺是什麼?

基於分支的版本管理,幫助低程式碼從專案交付走向定製化產品開發

相關文章