Spring-Boot插件式开发框架，为动态扩展系统而生的插件开发框架

/** * Copyright [2019-Present] [starBlues] * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.gitee.starblues.core; import com.gitee.starblues.core.checker.ComposePluginLauncherChecker; import com.gitee.starblues.core.checker.DefaultPluginLauncherChecker; import com.gitee.starblues.core.checker.DependencyPluginLauncherChecker; import com.gitee.starblues.core.checker.PluginBasicChecker; import com.gitee.starblues.core.descriptor.InsidePluginDescriptor; import com.gitee.starblues.core.descriptor.PluginDescriptor; import com.gitee.starblues.core.descriptor.PluginDescriptorLoader; import com.gitee.starblues.core.exception.PluginDisabledException; import com.gitee.starblues.core.exception.PluginException; import com.gitee.starblues.core.scanner.ComposePathResolve; import com.gitee.starblues.core.scanner.DevPathResolve; import com.gitee.starblues.core.scanner.PathResolve; import com.gitee.starblues.core.scanner.ProdPathResolve; import com.gitee.starblues.integration.IntegrationConfiguration; import com.gitee.starblues.integration.listener.DefaultPluginListenerFactory; import com.gitee.starblues.integration.listener.PluginListenerFactory; import com.gitee.starblues.utils.*; import org.apache.commons.io.FileUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.File; import java.io.IOException; import java.nio.file.Path; import java.nio.file.Paths; import java.util.*; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicBoolean; import java.util.stream.Collectors; /** * 抽象的插件管理者 * @author starBlues * @since 3.0.0 * @version 3.1.0 */ public class DefaultPluginManager implements PluginManager{ private final Logger log = LoggerFactory.getLogger(DefaultPluginManager.class); private final RealizeProvider provider; private final IntegrationConfiguration configuration; private final List<String> pluginRootDirs; private final PathResolve pathResolve; private final PluginBasicChecker basicChecker; protected final ComposePluginLauncherChecker launcherChecker; private final AtomicBoolean loaded = new AtomicBoolean(false); private final Map<String, PluginInsideInfo> startedPlugins = new ConcurrentHashMap<>(); private final Map<String, PluginInsideInfo> resolvedPlugins = new ConcurrentHashMap<>(); protected PluginListenerFactory pluginListenerFactory; private List<String> sortedPluginIds; public DefaultPluginManager(RealizeProvider realizeProvider, IntegrationConfiguration configuration) { this.provider = Assert.isNotNull(realizeProvider, "参数 realizeProvider 不能为空"); this.configuration = Assert.isNotNull(configuration, "参数 configuration 不能为空"); this.pluginRootDirs = resolvePath(configuration.pluginPath()); this.pathResolve = getComposePathResolve(); this.basicChecker = realizeProvider.getPluginBasicChecker(); this.launcherChecker = getComposeLauncherChecker(realizeProvider); setSortedPluginIds(configuration.sortInitPluginIds()); } protected ComposePluginLauncherChecker getComposeLauncherChecker(RealizeProvider realizeProvider){ ComposePluginLauncherChecker checker = new ComposePluginLauncherChecker(); checker.add(new DefaultPluginLauncherChecker(realizeProvider, configuration)); checker.add(new DependencyPluginLauncherChecker(this)); return checker; } protected ComposePathResolve getComposePathResolve(){ return new ComposePathResolve(new DevPathResolve(), new ProdPathResolve()); } public void setSortedPluginIds(List<String> sortedPluginIds) { this.sortedPluginIds = sortedPluginIds; } @Override public List<String> getPluginsRoots() { return new ArrayList<>(pluginRootDirs); } @Override public String getDefaultPluginRoot() { if(pluginRootDirs == null){ return null; } return pluginRootDirs.stream().findFirst().orElseThrow(()->{ return new PluginException("插件根路径未配置"); }); } @Override public synchronized List<PluginInfo> loadPlugins() { if(loaded.get()){ throw new PluginException("不能重复调用: loadPlugins"); } try { pluginListenerFactory = createPluginListenerFactory(); if(ObjectUtils.isEmpty(pluginRootDirs)){ log.warn("插件根目录为空, 无法加载插件."); return Collections.emptyList(); } List<Path> scanPluginPaths = provider.getPluginScanner().scan(pluginRootDirs); if(ObjectUtils.isEmpty(scanPluginPaths)){ printOfNotFoundPlugins(); return Collections.emptyList(); } Map<String, PluginInfo> pluginInfoMap = new LinkedHashMap<>(scanPluginPaths.size()); boolean findException = false; for (Path path : scanPluginPaths) { try { PluginInsideInfo pluginInfo = loadPlugin(path, false); if(pluginInfo != null){ pluginInfo.setFollowSystem(); PluginInfo pluginInfoFace = pluginInfo.toPluginInfo(); pluginListenerFactory.loadSuccess(pluginInfoFace); pluginInfoMap.put(pluginInfo.getPluginId(), pluginInfoFace); } } catch (Throwable e) { pluginListenerFactory.loadFailure(path, e); log.error("加载插件包失败: {}. {}", path, e.getMessage(), e); findException = true; } } if(!findException && pluginInfoMap.isEmpty()){ printOfNotFoundPlugins(); } return getSortPlugin(pluginInfoMap); } finally { loaded.set(true); } } protected PluginListenerFactory createPluginListenerFactory(){ return new DefaultPluginListenerFactory(); } @Override public boolean verify(Path pluginPath) { Assert.isNotNull(pluginPath, "参数pluginPath不能为空"); try (PluginDescriptorLoader pluginDescriptorLoader = provider.getPluginDescriptorLoader()){ basicChecker.checkPath(pluginPath); PluginDescriptor pluginDescriptor = pluginDescriptorLoader.load(pluginPath); return pluginDescriptor != null; } catch (Throwable e) { log.error("插件包校验失败: {}" , pluginPath, e); return false; } } @Override public PluginInfo parse(Path pluginPath) throws PluginException { PluginInsideInfo pluginInsideInfo = loadFromPath(pluginPath); if(pluginInsideInfo == null){ throw new PluginException("非法插件包: " + pluginPath); } pluginInsideInfo.setPluginState(PluginState.PARSED); return pluginInsideInfo.toPluginInfo(); } @Override public synchronized PluginInfo load(Path pluginPath, boolean unpackPlugin) throws PluginException { Assert.isNotNull(pluginPath, "参数pluginPath不能为空"); String sourcePluginPath = pluginPath.toString(); try { // 解析插件 PluginInfo pluginInfo = parse(pluginPath); // 检查是否存在当前插件 PluginInside