Support plugin management and dynamic plugin installation with extensions #984
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,6 +27,7 @@ | |
| import com.alipay.sofa.ark.spi.service.biz.BizManagerService; | ||
| import com.alipay.sofa.ark.spi.service.event.EventAdminService; | ||
| import com.alipay.sofa.ark.spi.service.injection.InjectionService; | ||
| import com.alipay.sofa.ark.spi.service.plugin.PluginFactoryService; | ||
| import com.alipay.sofa.ark.spi.service.plugin.PluginManagerService; | ||
| import com.google.inject.Binding; | ||
| import com.google.inject.Guice; | ||
|
|
@@ -92,6 +93,7 @@ public void start() throws ArkRuntimeException { | |
| ArkClient.setInjectionService(getService(InjectionService.class)); | ||
| ArkClient.setEventAdminService(getService(EventAdminService.class)); | ||
| ArkClient.setPluginManagerService(getService(PluginManagerService.class)); | ||
| ArkClient.setPluginFactoryService(getService(PluginFactoryService.class)); | ||
| ArkClient.setArguments(arguments); | ||
| ArkLoggerFactory.getDefaultLogger().info("Finish to start ArkServiceContainer"); | ||
| } finally { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,11 +31,8 @@ | |
| import com.alipay.sofa.ark.spi.archive.Archive; | ||
| import com.alipay.sofa.ark.spi.archive.BizArchive; | ||
| import com.alipay.sofa.ark.spi.constant.Constants; | ||
| import com.alipay.sofa.ark.spi.model.*; | ||
| import com.alipay.sofa.ark.spi.model.BizInfo.StateChangeReason; | ||
| import com.alipay.sofa.ark.spi.service.biz.BizFactoryService; | ||
| import com.alipay.sofa.ark.spi.service.plugin.PluginManagerService; | ||
| import com.google.inject.Inject; | ||
|
|
@@ -48,9 +45,11 @@ | |
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.jar.Attributes; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static com.alipay.sofa.ark.spi.constant.Constants.ARK_BIZ_NAME; | ||
| import static com.alipay.sofa.ark.spi.constant.Constants.ARK_BIZ_VERSION; | ||
|
|
@@ -80,15 +79,60 @@ public class BizFactoryServiceImpl implements BizFactoryService { | |
|
|
||
| @Override | ||
| public Biz createBiz(BizArchive bizArchive) throws IOException { | ||
| return createBiz(bizArchive, new BizConfig()); | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createBiz(BizArchive bizArchive, URL[] extensionUrls) throws IOException { | ||
| BizConfig bizConfig = new BizConfig(); | ||
| bizConfig.setExtensionUrls(extensionUrls); | ||
| return createBiz(bizArchive, bizConfig); | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createBiz(File file) throws IOException { | ||
| BizArchive bizArchive = prepareBizArchive(file); | ||
| return createBiz(bizArchive, new BizConfig()); | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createBiz(File file, URL[] extensionUrls) throws IOException { | ||
yuanyuancin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| BizArchive bizArchive = prepareBizArchive(file); | ||
| BizConfig bizConfig = new BizConfig(); | ||
| bizConfig.setExtensionUrls(extensionUrls); | ||
| return createBiz(bizArchive, bizConfig); | ||
| } | ||
|
|
||
|
Comment on lines
+85
to
+105
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider refactoring overloaded The overloaded Consider refactoring to eliminate duplication, possibly by introducing helper methods or utilizing default parameter values. |
||
| @Override | ||
| public Biz createBiz(BizOperation bizOperation, File file) throws IOException { | ||
| BizArchive bizArchive = prepareBizArchive(file); | ||
| BizConfig bizConfig = new BizConfig(); | ||
| bizConfig.setSpecifiedVersion(bizOperation.getBizVersion()); | ||
| return createBiz(bizArchive, bizConfig); | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createBiz(File file, BizConfig bizConfig) throws IOException { | ||
| BizArchive bizArchive = prepareBizArchive(file); | ||
| return createBiz(bizArchive, bizConfig); | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createBiz(BizArchive bizArchive, BizConfig bizConfig) throws IOException { | ||
| AssertUtils.isTrue(isArkBiz(bizArchive), "Archive must be a ark biz!"); | ||
| AssertUtils.isTrue(bizConfig != null, "BizConfig must not be null!"); | ||
|
|
||
| Attributes manifestMainAttributes = bizArchive.getManifest().getMainAttributes(); | ||
| String mainClass = manifestMainAttributes.getValue(MAIN_CLASS_ATTRIBUTE); | ||
| String startClass = manifestMainAttributes.getValue(START_CLASS_ATTRIBUTE); | ||
| BizModel bizModel = new BizModel(); | ||
| bizModel | ||
| .setBizState(BizState.RESOLVED, StateChangeReason.CREATED) | ||
| .setBizName(manifestMainAttributes.getValue(ARK_BIZ_NAME)) | ||
| .setBizVersion( | ||
| !StringUtils.isEmpty(bizConfig.getSpecifiedVersion()) ? bizConfig | ||
yuanyuancin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .getSpecifiedVersion() : manifestMainAttributes.getValue(ARK_BIZ_VERSION)) | ||
| .setBizUrl(!(bizArchive instanceof DirectoryBizArchive) ? bizArchive.getUrl() : null) | ||
| .setMainClass(!StringUtils.isEmpty(startClass) ? startClass : mainClass) | ||
| .setPriority(manifestMainAttributes.getValue(PRIORITY_ATTRIBUTE)) | ||
| .setWebContextPath(manifestMainAttributes.getValue(WEB_CONTEXT_PATH)) | ||
|
|
@@ -99,22 +143,49 @@ public Biz createBiz(BizArchive bizArchive) throws IOException { | |
| getInjectDependencies(manifestMainAttributes.getValue(INJECT_PLUGIN_DEPENDENCIES))) | ||
| .setInjectExportPackages(manifestMainAttributes.getValue(INJECT_EXPORT_PACKAGES)) | ||
| .setDeclaredLibraries(manifestMainAttributes.getValue(DECLARED_LIBRARIES)) | ||
| .setClassPath(getMergedBizClassPath(bizArchive.getUrls(), bizConfig.getExtensionUrls())); | ||
|
|
||
| // prepare dependent plugins and plugin export map | ||
| List<String> dependentPlugins = bizConfig.getDependentPlugins(); | ||
| if (dependentPlugins == null || dependentPlugins.isEmpty()) { | ||
| dependentPlugins = StringUtils.strToList( | ||
| manifestMainAttributes.getValue("dependent-plugins"), | ||
| Constants.MANIFEST_VALUE_SPLIT); | ||
| } | ||
| resolveExportMapIfNecessary(bizModel, dependentPlugins); | ||
|
|
||
| // must be after prepare dependent plugins | ||
| bizModel.setPluginClassPath(getPluginURLs(bizModel)); | ||
|
|
||
| // create biz classloader | ||
| BizClassLoader bizClassLoader = new BizClassLoader(bizModel.getIdentity(), | ||
| getBizUcp(bizModel), bizArchive instanceof ExplodedBizArchive | ||
| || bizArchive instanceof DirectoryBizArchive); | ||
| bizClassLoader.setBizModel(bizModel); | ||
| bizModel.setClassLoader(bizClassLoader); | ||
|
|
||
| // set biz work dir | ||
| if (bizModel.getBizUrl() != null) { | ||
| bizModel.setBizTempWorkDir(new File(bizModel.getBizUrl().getFile())); | ||
| } | ||
|
|
||
| return bizModel; | ||
| } | ||
|
|
||
| @Override | ||
| public Biz createEmbedMasterBiz(ClassLoader masterClassLoader) { | ||
| BizModel bizModel = new BizModel(); | ||
| bizModel.setBizState(BizState.RESOLVED, StateChangeReason.CREATED) | ||
| .setBizName(ArkConfigs.getStringValue(MASTER_BIZ)).setBizVersion("1.0.0") | ||
| .setMainClass("embed main").setPriority("100").setWebContextPath("/") | ||
| .setDenyImportPackages(null).setDenyImportClasses(null).setDenyImportResources(null) | ||
| .setInjectPluginDependencies(new HashSet<>()).setInjectExportPackages(null) | ||
| .setClassPath(ClassLoaderUtils.getURLs(masterClassLoader)) | ||
| .setClassLoader(masterClassLoader); | ||
| return bizModel; | ||
| } | ||
|
|
||
| private BizArchive prepareBizArchive(File file) throws IOException { | ||
| BizArchive bizArchive; | ||
| if (ArkConfigs.isEmbedEnable()) { | ||
| File unpackFile = FileUtils.file(file.getAbsolutePath() + "-unpack"); | ||
|
|
@@ -131,35 +202,56 @@ public Biz createBiz(File file) throws IOException { | |
| JarFileArchive jarFileArchive = new JarFileArchive(bizFile); | ||
| bizArchive = new JarBizArchive(jarFileArchive); | ||
| } | ||
yuanyuancin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return bizArchive; | ||
| } | ||
|
|
||
| private URL[] getMergedBizClassPath(URL[] bizArchiveUrls, URL[] extensionUrls) { | ||
| if (extensionUrls == null || extensionUrls.length == 0) { | ||
| return bizArchiveUrls; | ||
| } | ||
| return Stream.concat(Arrays.stream(bizArchiveUrls), Arrays.stream(extensionUrls)).toArray(URL[]::new); | ||
| } | ||
|
|
||
| private void resolveExportMapIfNecessary(BizModel bizModel, List<String> dependentPlugins) { | ||
| Set<Plugin> plugins = new HashSet<>(); | ||
| if (ArkConfigs.isBizSpecifyDependentPluginsEnable()) { | ||
| if (dependentPlugins != null && !dependentPlugins.isEmpty()) { | ||
| for (String pluginName : dependentPlugins) { | ||
| Plugin plugin = pluginManagerService.getPluginByName(pluginName); | ||
| plugins.add(plugin); | ||
|
Comment on lines
+220
to
+221
There was a problem hiding this comment. Potential NullPointerException when adding plugins The method Please add a null check before adding the plugin to the set. For example: Plugin plugin = pluginManagerService.getPluginByName(pluginName);
if (plugin != null) {
plugins.add(plugin);
} else {
// Handle the case where the plugin is not found
} |
||
| } | ||
| } | ||
| } else { | ||
| plugins.addAll(pluginManagerService.getPluginsInOrder()); | ||
| } | ||
|
|
||
| bizModel.setDependentPlugins(plugins); | ||
| for (Plugin plugin : plugins) { | ||
|
There was a problem hiding this comment. 所以每个 plugin，是需要定义自己的 export 内容的，这部分需要在使用文档里说明。 |
||
| for (String exportIndex : plugin.getExportPackageNodes()) { | ||
| bizModel.getExportNodeAndClassLoaderMap().putIfAbsent(exportIndex, plugin); | ||
| } | ||
| for (String exportIndex : plugin.getExportPackageStems()) { | ||
| bizModel.getExportStemAndClassLoaderMap().putIfAbsent(exportIndex, plugin); | ||
| } | ||
| for (String exportIndex : plugin.getExportClasses()) { | ||
| bizModel.getExportClassAndClassLoaderMap().putIfAbsent(exportIndex, plugin); | ||
| } | ||
| for (String resource : plugin.getExportResources()) { | ||
| bizModel.getExportResourceAndClassLoaderMap().putIfAbsent(resource, | ||
| new LinkedList<>()); | ||
| bizModel.getExportResourceAndClassLoaderMap().get(resource).add(plugin); | ||
| } | ||
| for (String resource : plugin.getExportPrefixResourceStems()) { | ||
| bizModel.getExportPrefixStemResourceAndClassLoaderMap().putIfAbsent(resource, | ||
| new LinkedList<>()); | ||
| bizModel.getExportPrefixStemResourceAndClassLoaderMap().get(resource).add(plugin); | ||
| } | ||
| for (String resource : plugin.getExportSuffixResourceStems()) { | ||
| bizModel.getExportSuffixStemResourceAndClassLoaderMap().putIfAbsent(resource, | ||
| new LinkedList<>()); | ||
| bizModel.getExportSuffixStemResourceAndClassLoaderMap().get(resource).add(plugin); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Set<String> getInjectDependencies(String injectPluginDependencies) { | ||
|
|
@@ -183,16 +275,16 @@ public boolean matches(Archive.Entry entry) { | |
| }); | ||
| } | ||
|
|
||
| private URL[] getBizUcp(BizModel bizModel) { | ||
| List<URL> bizUcp = new ArrayList<>(); | ||
| bizUcp.addAll(Arrays.asList(bizModel.getClassPath())); | ||
| bizUcp.addAll(Arrays.asList(getPluginURLs(bizModel))); | ||
| return bizUcp.toArray(new URL[bizUcp.size()]); | ||
| } | ||
|
|
||
| private URL[] getPluginURLs(BizModel bizModel) { | ||
| List<URL> pluginUrls = new ArrayList<>(); | ||
| for (Plugin plugin : bizModel.getDependentPlugins()) { | ||
| pluginUrls.add(plugin.getPluginURL()); | ||
| } | ||
| return pluginUrls.toArray(new URL[pluginUrls.size()]); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -457,7 +457,13 @@ private byte[] getClassBytesFromJar(String jarFilePath, String className) throws | |
|
|
||
| private Class<?> doResolveExportClass(String name) { | ||
| if (shouldFindExportedClass(name)) { | ||
| ClassLoader importClassLoader = null; | ||
| if (this instanceof BizClassLoader) { | ||
| importClassLoader = classloaderService.findExportClassLoaderByBiz( | ||
| ((BizClassLoader) this).getBizModel(), name); | ||
| } else if (this instanceof PluginClassLoader) { | ||
| importClassLoader = classloaderService.findExportClassLoader(name); | ||
yuanyuancin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| if (importClassLoader != null) { | ||
| try { | ||
| Class<?> clazz = importClassLoader.loadClass(name); | ||
|
|
@@ -555,12 +561,18 @@ protected Class<?> resolveJavaAgentClass(String name) { | |
| */ | ||
| protected URL getExportResource(String resourceName) { | ||
| if (shouldFindExportedResource(resourceName)) { | ||
| List<ClassLoader> exportResourceClassLoadersInOrder = null; | ||
| if (this instanceof BizClassLoader) { | ||
| exportResourceClassLoadersInOrder = classloaderService | ||
| .findExportResourceClassLoadersInOrderByBiz( | ||
| ((BizClassLoader) this).getBizModel(), resourceName); | ||
| } else if (this instanceof PluginClassLoader) { | ||
| exportResourceClassLoadersInOrder = classloaderService | ||
| .findExportResourceClassLoadersInOrder(resourceName); | ||
| } | ||
| if (exportResourceClassLoadersInOrder != null) { | ||
| for (ClassLoader exportResourceClassLoader : exportResourceClassLoadersInOrder) { | ||
| URL url = exportResourceClassLoader.getResource(resourceName); | ||
| if (url != null && this instanceof BizClassLoader) { | ||
| if (((BizClassLoader) (this)).getBizModel().isDeclared(url, resourceName)) { | ||
| return url; | ||
|
|
@@ -629,8 +641,15 @@ private String transformClassName(String name) { | |
| @SuppressWarnings("unchecked") | ||
| protected Enumeration<URL> getExportResources(String resourceName) throws IOException { | ||
| if (shouldFindExportedResource(resourceName)) { | ||
| List<ClassLoader> exportResourceClassLoadersInOrder = null; | ||
| if (this instanceof BizClassLoader) { | ||
| exportResourceClassLoadersInOrder = classloaderService | ||
| .findExportResourceClassLoadersInOrderByBiz( | ||
| ((BizClassLoader) this).getBizModel(), resourceName); | ||
| } else if (this instanceof PluginClassLoader) { | ||
| exportResourceClassLoadersInOrder = classloaderService | ||
| .findExportResourceClassLoadersInOrder(resourceName); | ||
| } | ||
| if (exportResourceClassLoadersInOrder != null) { | ||
| List<Enumeration<URL>> enumerationList = new ArrayList<>(); | ||
| for (ClassLoader exportResourceClassLoader : exportResourceClassLoadersInOrder) { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider Thread Safety for
dependentPluginsIf
dependentPluginsmay be accessed by multiple threads concurrently, consider using a thread-safe collection likeCopyOnWriteArraySetor synchronizing access appropriately to prevent concurrent modification issues.