Solon2 开发之插件，二、插件扩展机制（Spi）

插件扩展机制，是基于 “插件” + “配置申明” 实现的解耦的扩展机制（类似 Spring Factories、Java Spi）：简单、弹性、自由。它的核心作用，是为模块获得了应用启动入口，并参与了应用生命周期。简称为 Solon 的 Spi。

像 @Tran、@Cache 之类的注解开发成果，都会希望能在所有项目中复用。它们就是基于插件扩展机制实现。

1、插件扩展机制

• 第一步：定制插件实现类（即实现插件生命周期的内部处理），实现类不能有注入。

//X开头可以让文件排序在未位，方便找到
public class XPluginImpl implements Plugin{
    @Override
    public void start(AopContext context) {
        //插件启动时...
    }

    @Override
    public void prestop() throws Throwable {
        //插件预停止时（启用安全停止时：预停止后隔几秒才会进行停止）
    }

    @Override
    public void stop(){
        //插件停止时
    }
}

• 第二步：通过插件配置文件申明自己，须全局唯一存在

约定插件配置文件：

#建议使用包做为文件名，便于识别，且可避免冲突
META-INF/solon/{packname}.properties

约定插件配置内容：

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

• 第三步：扫描并发现插件

程序启动时，扫描META-INF/solon/目录下所有的.properties文件，找到所有的插件并排序。

2、示例参考，插件：solon.aspect

这个插件提供了 @Dao 和 @Service 扩展注解，进而实现Class的动态代理能力。

• 插件实现类：src/main/java/org.noear.solon.aspect.XPluginImp.java

package org.noear.solon.aspect;

import org.noear.solon.core.AopContext;
import org.noear.solon.core.Plugin;
import org.noear.solon.aspect.annotation.Dao;
import org.noear.solon.aspect.annotation.Service;

public class XPluginImp implements Plugin {
    @Override
    public void start(AopContext context) {
        context.beanBuilderAdd(Dao.class, (clz, bw, anno) -> {
            BeanProxy.binding(bw);
        });

        context.beanBuilderAdd(Service.class, (clz, bw, anno) -> {
            BeanProxy.binding(bw);
        });
    }
}

• 插件配置文件：src/main/resources/META-INF/solon/solon.aspect.properties

solon.plugin=org.noear.solon.aspect.XPluginImp

• 插件应用示例

//
// 引入 org.noear:solon.aspect 插件之后
//

@Service
public class AppService {
    @Inject
    SqlMapper sqlMapper1;

    //
    // @Service 注解，可为 bean 添加 class 动态代理；进而支持事务注解：@Tran
    //
    @Tran
    public void addApp(){
        sqlMapper1.appx_add();
    }
}