活字格10.0新功能解密：二十八、Java开发服务端命令插件
本帖最后由 Jack.Cheng 于 2024-3-8 09:35 编辑活字格本体可以扩展的插件分为三种类型，单元格类型插件、命令插件和服务端命令插件。
之前开发插件，需要掌握JavaScript和C#编程语言才可以，而在新版本中，服务端命令插件这一类型（单元格类型插件和命令插件暂未支持）的开发将会支持Java语言。本篇帖子将会为大家介绍这个新特性。
之前有个用户论坛有个帖子，我们以这个为背景，来介绍下Java开发服务端命令插件的步骤
论坛有一个客户分享了一个签名加密的Java代码，看看能不能改一下放进来（求指导活字格支不支持使用JAVA工具
https://gcdn.grapecity.com.cn/showtopic-196810-1-1.html
(出处: 葡萄城开发者社区)）
第1步：使用forguncyJavaPluginGenerator构建工程
活字格Java Web Api生成工具（https://gitee.com/GrapeCity/forg ... /releases/tag/1.0.0），推荐使用压缩包版本创建。
如果压缩包版本闪退，是因为系统太老没有webview2，推荐使用msi安装包安装，或者更新系统到2018年4月之后的win10 或更高版本。
https://gcdn-cdn.grapecity.com.cn/data/attachment/forum/202402/27/173846ljpgbtreag2g2agu.png
完成后，在对应目录将会生成工程文件
idea打开后工程文件结构如下
MyPlugin是我们主类，后面主要业务需求在此处实现。
第2步：针对业务需求进行具体编码
pom中增加这些依赖
Icon图片和PluginLogo图片替换如下
PluginConfig中修改如下
这是我的示例代码
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 yourEncodingException.");
}
}
/***
* 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;
// two characters form the hex value.
for (int i = 0, j = 0; i < l; i++) {
out = DIGITS[(0xF0 & data) >>> 4];
out = DIGITS];
}
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();
}
}
目前Java开发服务端命令插件时属性使用情况与C#一致，只是语法需要按照Java要求书写。
第3步：使用maven打包插件
在此处先点击clean，后点击install
在target目录会出现产出物
下面我们把插件进行安装后实际看看效果
这是在服务端命令里面的样式
这是在服务端命令中进行测试后
近期和社区里一些插件开发者交流时候，他们说活字格支持Java开发插件实在是太好了，之前有些.NET中不太好找的硬件对接功能，在Java生态非常好实现，极大提高了他们的业务半径。
因此，活字格10出来后，大家可以充分利用Java生态的丰富性，开发相关的扩展插件了，同时C#生态也能利用到。这样子，可以降低项目交付中可能的技术风险，而且插件可以复用，降低了技术投入成本。
页:
[1]