【代码评审】IoT:插件机制

This commit is contained in:
YunaiV 2025-01-08 22:36:38 +08:00
parent 0af6d5a758
commit aad0581777
7 changed files with 27 additions and 31 deletions

View File

@ -1,5 +0,0 @@
{
"java.compile.nullAnalysis.mode": "automatic",
"java.jdt.ls.vmargs": "-XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx2G -Xms100m -Xlog:disable",
"java.configuration.updateBuildConfiguration": "interactive"
}

View File

@ -13,8 +13,8 @@ import java.util.Arrays;
@Getter
public enum IotPluginDeployTypeEnum implements IntArrayValuable {
DEPLOY_VIA_JAR(0, "通过 jar 部署"), // TODO @haohaoUPLOAD ALONE 感觉有点冲突前者是部署方式后者是运行方式这个后续再讨论下哈
DEPLOY_STANDALONE(1, "独立部署");
JAR(0, "JAR 部署"),
STANDALONE(1, "独立部署");
public static final int[] ARRAYS = Arrays.stream(values()).mapToInt(IotPluginDeployTypeEnum::getDeployType).toArray();
@ -48,4 +48,5 @@ public enum IotPluginDeployTypeEnum implements IntArrayValuable {
public int[] array() {
return ARRAYS;
}
}

View File

@ -33,19 +33,22 @@ public class PluginInstanceDO extends BaseDO {
*/
private String mainId;
/**
* 插件id
* 插件 ID
* <p>
* 关联 {@link PluginInfoDO#getId()}
*/
private Long pluginId;
/**
* 插件主程序所在ip
* 插件主程序所在 IP
*/
private String ip;
/**
* 插件主程序端口
*/
private Integer port;
// TODO @haohao字段改成 heartbeatTimeLocalDateTime
/**
* 心跳时间心路时间超过 30 秒需要剔除
*/

View File

@ -100,7 +100,7 @@ public class PluginInfoServiceImpl implements PluginInfoService {
// 2. 停止并卸载旧的插件
pluginInstanceService.stopAndUnloadPlugin(pluginInfoDo.getPluginKey());
// 3 上传新的插件文件,更新插件启用状态文件
// 3 上传新的插件文件更新插件启用状态文件
String pluginKeyNew = pluginInstanceService.uploadAndLoadNewPlugin(file);
// 4. 更新插件信息

View File

@ -11,7 +11,7 @@ import org.springframework.web.multipart.MultipartFile;
public interface PluginInstanceService {
/**
* 上报插件实例
* 上报插件实例心跳
*/
void reportPluginInstances();

View File

@ -41,7 +41,8 @@ import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionU
public class PluginInstanceServiceImpl implements PluginInstanceService {
// TODO @haohao这个可以后续确认下有没更合适的标识例如说 mac 地址之类的
// 简化的UUID + mac 地址 会不会好一些一台机子有可能会部署多个插件
// 简化的 UUID + mac 地址 会不会好一些一台机子有可能会部署多个插件
// 那就 mac@uuid
public static final String MAIN_ID = IdUtil.fastSimpleUUID();
@Resource
@ -53,13 +54,13 @@ public class PluginInstanceServiceImpl implements PluginInstanceService {
@Value("${pf4j.pluginsDir}")
private String pluginsDir;
@Value("${server.port:48080}")
private int port;
@Override
public void stopAndUnloadPlugin(String pluginKey) {
PluginWrapper plugin = pluginManager.getPlugin(pluginKey);
// TODO @haohao改成 if return 会更简洁一点
if (plugin != null) {
if (plugin.getPluginState().equals(PluginState.STARTED)) {
pluginManager.stopPlugin(pluginKey); // 停止插件
@ -75,6 +76,7 @@ public class PluginInstanceServiceImpl implements PluginInstanceService {
@Override
public void deletePluginFile(PluginInfoDO pluginInfoDO) {
File file = new File(pluginsDir, pluginInfoDO.getFileName());
// TODO @haohao改成 if return 会更简洁一点
if (file.exists()) {
try {
TimeUnit.SECONDS.sleep(1); // 等待 1 避免插件未卸载完毕
@ -82,9 +84,7 @@ public class PluginInstanceServiceImpl implements PluginInstanceService {
log.error("[deletePluginInfo][删除插件文件({}) 失败]", pluginInfoDO.getFileName());
}
} catch (InterruptedException e) {
log.error("[deletePluginInfo][删除插件文件({}) 失败]", pluginInfoDO.getFileName(),
e);
Thread.currentThread().interrupt(); // 恢复中断状态
log.error("[deletePluginInfo][删除插件文件({}) 失败]", pluginInfoDO.getFileName(), e);
}
}
}
@ -120,6 +120,7 @@ public class PluginInstanceServiceImpl implements PluginInstanceService {
String pluginKey = pluginInfoDo.getPluginKey();
PluginWrapper plugin = pluginManager.getPlugin(pluginKey);
// TODO @haohao改成 if return 会更简洁一点
if (plugin != null) {
// 启动插件
if (status.equals(IotPluginStatusEnum.RUNNING.getStatus())
@ -143,46 +144,41 @@ public class PluginInstanceServiceImpl implements PluginInstanceService {
@Override
public void reportPluginInstances() {
// 1. 获取 pf4j 插件列表
// 1.1 获取 pf4j 插件列表
List<PluginWrapper> plugins = pluginManager.getPlugins();
// 2. 获取插件信息列表并转换为 Map 以便快速查找
// 1.2 获取插件信息列表并转换为 Map 以便快速查找
List<PluginInfoDO> pluginInfos = pluginInfoMapper.selectList();
Map<String, PluginInfoDO> pluginInfoMap = pluginInfos.stream()
.collect(Collectors.toMap(PluginInfoDO::getPluginKey, Function.identity()));
// 3. 获取本机 IP MAC 地址
// 1.3 获取本机 IP MAC 地址
String ip = NetUtil.getLocalhostStr();
String mac = NetUtil.getLocalMacAddress();
String mainId = MAIN_ID + "-" + mac;
// 4. 遍历插件列表并保存为插件实例
// 2. 遍历插件列表并保存为插件实例
for (PluginWrapper plugin : plugins) {
String pluginKey = plugin.getPluginId();
// 4.1 查找插件信息
// 2.1 查找插件信息
PluginInfoDO pluginInfo = pluginInfoMap.get(pluginKey);
if (pluginInfo == null) {
// 4.2 插件信息不存在记录错误并跳过
log.error("插件信息不存在pluginKey = {}", pluginKey);
continue;
}
// 4.3 查询插件实例
// 2.2 情况一如果插件实例不存在则创建
PluginInstanceDO pluginInstance = pluginInstanceMapper.selectByMainIdAndPluginId(mainId,
pluginInfo.getId());
if (pluginInstance == null) {
// 4.4 如果插件实例不存在则创建
pluginInstance = PluginInstanceDO.builder()
.pluginId(pluginInfo.getId())
.mainId(MAIN_ID + "-" + mac)
.ip(ip)
.port(port)
.heartbeatAt(System.currentTimeMillis())
.build();
pluginInstance = PluginInstanceDO.builder().pluginId(pluginInfo.getId()).mainId(MAIN_ID + "-" + mac)
.ip(ip).port(port).heartbeatAt(System.currentTimeMillis()).build();
pluginInstanceMapper.insert(pluginInstance);
} else {
// 4.5 如果插件实例存在则更新心跳时间
// 2.2 情况二如果存在则更新 heartbeatAt
// TODO @haohao这里最好 new update避免并发更新虽然目前没有
pluginInstance.setHeartbeatAt(System.currentTimeMillis());
pluginInstanceMapper.updateById(pluginInstance);
}

View File

@ -11,6 +11,7 @@ import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
import java.util.concurrent.CompletableFuture;
// TODO 芋艿后续 review
/**
* 插件实例 RPC 接口
*