【Concept Plugin 3】轻量级插件化解决方案｜动态类加载

背景

去年的这篇文章【Spring Boot】插件化动态类加载解决方案发现反响很不错

看来大家对于插件化这样的功能还是有一定需求，于是趁热打铁，实现了大家呼声比较高的功能，就有了Concept Plugin 3

新特性

支持集群环境，支持AWS S3对象存储加载插件
支持动态Spring接口，支持解析yaml文件
提供更简单的Observable集成方式

框架介绍

Concept Plugin 3是一款轻量级插件化解决方案，提供可插拔的插件能力

GitHub 传送门

Concept Wiki 说明

Concept Plugin Sample 示例

使用

1. 配置需要提取的插件

java 复制代码

@EnablePluginConcept
@Configuration
public class PluginConfig {

    @Bean
    public PluginObservable<String, AI> aiPluginObservable() {
        return new GenericPluginObservable<String, AI>() {
            @Override
                public String grouping(AI plugin, PluginContext context) {
                return plugin.getName();
            }
        };
    }
}

@EnablePluginConcept用于启用插件功能，也可以标记在启动类上

PluginObservable<String, AI>表示监听AI.class的所有实现类

grouping返回插件名称或分组，后续可以通过该值获取插件

更多的配置方式可以看Wiki，也可以阅读【Spring Boot】插件化动态类加载解决方案

2. 注入插件Observable

java 复制代码

@RestController
@RequestMapping("/ai")
public class AIController {

    @Autowired
    private PluginObservable<String, AI> aiPluginObservable;

    @RequestMapping("/{name}")
    public void ai(@PathVariable("name") String name) {
        AI ai = aiPluginObservable.get(name);
        if (ai == null) {
            throw new RuntimeException("AI not found: " + name);
        } else {
            ai.ai();
        }
    }
}

在需要使用插件的地方注入PluginObservable<String, AI>

通过get方法获得插件对象

3. 通过管理页面或调用对应方法来加载卸载插件

管理页面路径：/concept-plugin/management.html

优势

开箱即用

基于上述的3步就能集成插件化功能且自带可视化页面

当然对于一些复杂的需求也提供了更强大更灵活的集成方式

无侵入性

我们实现的插件包，不需要标记任何该框架内的注解，也不需要实现任何该框架内接口

甚至任意一个开源jar包都可以直接进行加载

Spring友好

和Spring一样，插件配置文件支持通过${}绑定Spring的配置

支持Spring的依赖注入能力，在实现插件的时候可以直接使用Spring相关的功能

最新特性支持动态Spring接口，可以将接口也进行插件化

但是需要注意，插件加载的Bean不会注入到Spring的容器中

轻量化

其实我在网上也看到过有一些模块插件化的项目

这种框架会相对重一点，框架的复杂性也比较高，问题排查也会更困难

而Concept Plugin提供的功能相对比较基础也有更大的灵活性

当然也能够基于动态Spring接口实现简化版的模块插件化

支持集群环境

最新的特性通过基于对象存储加载插件来支持集群环境

默认提供了AWS S3的协议，也支持自定义对象存储或分布式存储的实现方式

支持嵌套或关联依赖

在实现插件的时候有可能需要依赖其他的jar中的类

如果插件依赖的类在我们的主服务中已经存在了那就不需要管

如果在主服务中没有，有下面两种方案：

嵌套依赖

可以把依赖的jar打包进插件包里面，这样就能自动识别

插件依赖

如果被依赖的jar比较通用，很多插件都需要依赖

那么可以把这个jar作为一个基础插件（多个jar可以打包成zip）

在这个基础插件中添加配置plugin.properties

java项目在resources目录下添加即可

zip文件在根目录下添加即可

properties 复制代码

concept.plugin.name=common #插件名称
concept.plugin.handler.enabled=false #作为基础插件不进行解析匹配提取

然后在其他的插件包中添加配置plugin.properties

properties 复制代码

concept.plugin.dependency.names=common #依赖的插件，多个用逗号分隔

这样我们的插件就能加载到基础插件中的类了

结束

如果大家感兴趣或有需要可以看下更详细的用法 Wiki

觉得不错的话记得给个Star Github

也可以看看其他的功能 Concept Wiki