Solon Plugin 自动装配机制详解

原创于 2025-10-01 10:48:47 发布 · 736 阅读

14 ·

CC 4.0 BY-SA版权

文章标签：

#java #solon #ai #mcp #spi #spring

Solon Java Framework 专栏收录该内容

362 篇文章

订阅专栏

基于编码风格的扩展艺术

在现代Java生态中，框架的扩展能力是衡量其灵活性和强大程度的重要指标。Solon框架作为一款新兴的Java企业级应用开发框架，其插件扩展机制提供了一种“编码风格”的扩展体系，使开发者能够以更自由、更灵活的方式增强框架功能。

一、Solon Plugin 是什么？

Solon Plugin 是 Solon 框架三大核心组件之一，与Ioc/Aop应用容器、Context+Handler通用上下文处理接口共同构成了 Solon 的基础架构。

与其他扩展机制相比，Solon Plugin具有独特的设计理念：

扩展机制	描述	特点	体验风格
Java SPI	Java自带的	以接口为单位	配置风格
Spring Factories	Spring框架提供的	以组件为单位	配置风格
Solon Plugin	Solon框架提供的	以模块为单位	编码风格

Solon Plugin 本质上是 Java SPI 概念的一种“增强”模式，它强调编码风格，让开发者能够通过代码而非繁琐的配置来实现功能扩展。

二、Solon Plugin 的核心机制

1. 插件接口定义

Solon Plugin 的核心接口极其简洁：

public interface Plugin {
    //启动
    void start(AppContext context) throws Throwable;
    //预停止
    default void prestop() throws Throwable{}
    //停止
    default void stop() throws Throwable{}
}

这种简洁的设计赋予了插件极大的灵活性，开发者只需关注start方法的实现，即可完成插件的初始化工作

2. 插件发现机制

Solon 采用了一种自定义的 SPI 机制来发现和加载插件。插件的元信息配置需要申明一个 Plugin 接口的实现类，在应用启动时扫描元信息目录，以发现所有申明的插件实现

配置路径：META-INF/solon/{packname}.properties

配置内容：

solon.plugin={PluginImpl}   #插件实现类配置
solon.plugin.priority=1 #插件优化级配置。越大越优先，默认为0

通过优先级配置，Solon可以精确控制插件的加载顺序，这在处理插件间依赖关系时尤为重要。

三、自动装配的实现原理

1. 启动流程中的插件加载

Solon应用的启动过程精心设计了插件的加载时机：

实例化 Solon.app() 并加载配置
加载扩展文件夹
扫描插件并排序
运行 initialize 函数
推送 AppInitEndEvent [事件]
运行插件
推送 PluginLoadEndEvent [事件]
导入java bean(@Import)
扫描并加载java bean

从这个流程可以看出，插件在Bean加载之前运行，这为插件自动装配Bean提供了契机。

2. 自动装配的典型示例

以下是一个数据缓存与事务相关插件的自动装配示例：

public class DemoSolonPlugin implements Plugin {
    @Override
    public void start(AppContext context) {
        if (context.app() != null) {
            //添加事务控制支持
            if (context.app().source().isAnnotationPresent(EnableTransaction.class)) {
                //添加注解拦截器
                context.beanInterceptorAdd(Tran.class, TranInterceptor.instance, 120);
            }

            //添加缓存控制支持
            if (context.app().source().isAnnotationPresent(EnableCaching.class)) {
                //添加注解拦截器
                context.beanInterceptorAdd(CachePut.class, new CachePutInterceptor(), 110);
                context.beanInterceptorAdd(CacheRemove.class, new CacheRemoveInterceptor(), 110);
                context.beanInterceptorAdd(Cache.class, new CacheInterceptor(), 111);
            }
        }

        //根据配置自动构建数据源
        context.beanMake(DataSourcesAutoConfiguration.class);
    }
}

这个示例展示了Solon Plugin自动装配的几种典型场景：

条件化装配：根据应用类上的注解（如@EnableTransaction、@EnableCaching）决定是否启用特定功能
拦截器注册：为特定注解添加拦截器实现，实现AOP功能
Bean自动创建：根据配置自动创建和配置Bean

3. 应用示例

@EnableTransaction
@EnableCaching
public class App {
    public static void main(String[] args) {
        Solon.start(App.class, args);
    }
}

@Component
public class DemoService {
    @Cache
    public String test() {
        return new Date().toString();
    }

    @Tran
    public void post() {
        //...
    }
}

通过插件实现的自动装配，开发者只需添加相应的注解，即可享受缓存和事务等高级功能，极大简化了配置工作

四、高级特性：热插拔管理机制

Solon还提供了插件热插拔管理机制（H-Spi），这是框架提供的生产时用的另一种高级扩展方案。相对于基础的E-Spi，H-Spi更侧重隔离、热插热拔、及管理性

H-Spi的特点：

所有插件包独享ClassLoader、AopContext、配置，完全隔离
模块可以打包成独立的插件包，也可以与主程序一起打包
更新插件包不需要重启主服务，实现热更新
开发时，所有资源完全独立自控

热插拔插件示例：

public class Plugin1Impl implements Plugin {
    AopContext context;
    StaticRepository staticRepository;

    @Override
    public void start(AopContext context) {
        this.context = context;

        //添加自己的配置文件
        context.cfg().loadAdd("demo1011.plugin1.yml");
        //扫描自己的bean
        context.beanScan(Plugin1Impl.class);

        //添加自己的静态文件仓库
        staticRepository = new ClassPathStaticRepository(context.getClassLoader(), "plugin1_static");
        StaticMappings.add("/html/", staticRepository);
    }

    @Override
    public void stop() throws Throwable {
        //重要：插件停止时必须清理所有已添加的资源
        context.app().router().remove("/user");
        JobManager.remove("job1");
        
        //移除事件订阅
        context.beanForeach(bw -> {
            if (bw.raw() instanceof EventListener) {
                EventBus.unsubscribe(bw.raw());
            }
        });

        //移除静态文件仓库
        StaticMappings.remove(staticRepository);
    }
}

热插拔机制要求插件在"启动"时添加到公共场所的资源或对象，在插件停止时必须移除，这是实现热更新的关键

五、Solon Plugin 的实际应用场景

1. 框架功能扩展

如Solon Auth认证插件的实现：

@Configuration
public class Config {
    @Bean
    public AuthAdapter init() {
        return new AuthAdapter()
                .loginUrl("/login")
                .addRule(r -> r.include("**").verifyIp().failure((c, t) -> c.output("你的IP不在白名单")))
                .addRule(b -> b.exclude("/login**").exclude("/run/**").verifyPath())
                .processor(new AuthProcessorImpl())
                .failure((ctx, rst) -> {
                    ctx.render(rst);
                });
    }
}

通过插件机制，Solon Auth能够提供统一的认证控制，同时允许开发者灵活配置规则和适配器

2. 新兴技术集成

Solon Plugin机制同样适用于新兴技术领域的集成，如Solon AI MCP Server：

@McpServerEndpoint(channel = McpChannel.STREAMABLE, mcpEndpoint = "/mcp")
public class HelloService {
    @ToolMapping(description = "你好世界")
    public String hello(@Param(description = "名字") String name) throws SQLException {
        return "hello " + name;
    }
}