当前位置: 首页 > 工具软件 > Solon > 使用案例 >

Solon 框架详解(五)- Solon扩展机制之Solon Plugin

燕智
2023-12-01

Solon详解系列文章:
Solon详解(一)- 快速入门
Solon详解(二)- Solon的核心
Solon详解(三)- Solon的web开发
Solon详解(四)- Solon的事务传播机制
Solon详解(五)- Solon扩展机制之Solon Plugin
Solon详解(六)- Solon的校验框架使用、定制与扩展
Solon详解(七)- Solon Ioc 的注解对比Spring及JSR330
Solon详解(八)- Solon的缓存框架使用和定制
Solon详解(九)- 渲染控制之定制统一的接口输出
Solon详解(十)- 怎么用 Solon 开发基于 undertow jsp tld 的项目?

Solon 中也有一种非常解耦的扩展机制:Solon Plugin。这种扩展机制和Spring Factories像,和java SPI也很像。

一、Solon 中的扩展机制

在Solon的扩展插件加载机制,是在 META-INF/solon/{packname}.properties 文件中配置Plugin的实现类名称和优先级别,然后在程序中读取这些配置文件并实例化。这种自定义的SPI机制是Solon Plugin扩展实现的基础。

具体在扩展项目添加申明如下:

  • 添加配置:src/main/resources/META-INF/solon/{packname}.properties
    • 使用包做为文件名,是为了便于识别,且可避免冲突
  • 配置内容:
solon.plugin={Plugin impl}  #插件实现类
solon.plugin.priority=9      #加载优先级,越大越优先;默认不用配置

Plugin的作用:

在应用启动过程中,在特定的序顺位置,获取运行权限;进而进行框架扩展。

二、扩展示例,插件:solon.extend.aspect

这个插件,是为Solon提供 @Dao@Service 扩展注解,进而实现class的动态代理能力;基于ASM实现,但算是比较克制,暂时没加别的功能。本例完整的项目源码:https://gitee.com/noear/solon/tree/master/_extend/solon.extend.aspect,此处主要展示与扩展机制有关系的代码和配置。

  • 代码文件:src/main/java/org.noear.solon.extend.aspect.XPluginImp.java,实现Plugin接口:
package org.noear.solon.extend.aspect;

import org.noear.solon.SolonApp;
import org.noear.solon.core.Aop;
import org.noear.solon.core.Plugin;
import org.noear.solon.extend.aspect.annotation.Dao;
import org.noear.solon.extend.aspect.annotation.Service;

public class XPluginImp implements Plugin {
    @Override
    public void start(SolonApp app) {
        Aop.context().beanBuilderAdd(Dao.class, (clz, bw, anno) -> {
            bw.proxySet(BeanProxyImp.global());

            Aop.context().beanRegister(bw, "", true);
        });

        Aop.context().beanBuilderAdd(Service.class, (clz, bw, anno) -> {
            bw.proxySet(BeanProxyImp.global());

            Aop.context().beanRegister(bw, "", true);
        });
    }
}

  • 配置文件:src/main/resources/META-INF/solon/solon.extend.aspect.properties,实现自申明效果:
solon.plugin=org.noear.solon.extend.aspect.XPluginImp

主框架会通过扫描 META-INF/solon/ 文件夹下的所有 .properties 文件,进而发现各种扩展插件的Plugin实现类。

  • 应用示例
@Service
public class AppService {
    @Inject
    SqlMapper sqlMapper1;

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

附:Solon应用的启动顺序

  • 1.实例化 Solon.global() 并加载配置
  • 2.加载扩展文件夹
  • 3.扫描插件并排序
  • 4.运行 initialize 函数
  • 5.推送 AppInitEndEvent [事件]
  • 6.运行插件
  • 7.推送 PluginLoadEndEvent [事件]
  • 8.导入java bean(@Import)
  • 9.扫描并加载java bean
  • a.推送 BeanLoadEndEvent [事件]
  • b.加载渲染印映关系
  • c.执行bean加完成事件
  • d.推送 AppLoadEndEvent [事件]
  • e.结束

附:Solon项目地址

 类似资料: