首页 > Java > java教程 > 正文

SpringBoot的SPI机制怎么实现

WBOY
发布: 2023-05-16 09:10:11
转载
916 人浏览过

    简介

    SPI(Service Provider Interface)是JDK内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,主要用于框架中开发,例如Dubbo、Spring、Common-Logging,JDBC等采用采用SPI机制,针对同一接口采用不同的实现提供给不同的用户,从而提高了框架的扩展性。

    Java SPI实现

    Java内置的SPI通过java.util.ServiceLoader类解析classPath和jar包的META-INF/services/目录 下的以接口全限定名命名的文件,并加载该文件中指定的接口实现类,以此完成调用。

    示例说明

    创建动态接口

    public interface VedioSPI
    {
        void call();
    }
    登录后复制

    实现类1

    public class Mp3Vedio implements VedioSPI
    {
        @Override
        public void call()
        {
            System.out.println("this is mp3 call");
        }
    }
    登录后复制

    实现类2

    public class Mp4Vedio implements VedioSPI
    {
        @Override
        public void call()
        {
           System.out.println("this is mp4 call");
        }
    }
    登录后复制

    在项目的source目录下新建META-INF/services/目录下,创建com.skywares.fw.juc.spi.VedioSPI文件。

    SpringBoot的SPI机制怎么实现

    相关测试

    public class VedioSPITest
    {
        public static void main(String[] args)
        {
            ServiceLoader<VedioSPI> serviceLoader =ServiceLoader.load(VedioSPI.class);
            serviceLoader.forEach(t->{
                t.call();
            });
        }
    }
    登录后复制

    说明:Java实现spi是通过ServiceLoader来查找服务提供的工具类。

    运行结果

    SpringBoot的SPI机制怎么实现

    源码分析

    上述只是通过简单的示例来实现下java的内置的SPI功能。其实现原理是ServiceLoader是Java内置的用于查找服务提供接口的工具类,通过调用load()方法实现对服务提供接口的查找,最后遍历来逐个访问服务提供接口的实现类。

    SpringBoot的SPI机制怎么实现

    从源码可以发现:

    • ServiceLoader类本身实现了Iterable接口并实现了其中的iterator方法,iterator方法的实现中调用了LazyIterator这个内部类中的方法,解析完服务提供接口文件后最终结果放在了Iterator中返回,并不支持服务提供接口实现类的直接访问。

    • 所有服务提供接口的对应文件都是放置在META-INF/services/目录下,final类型决定了PREFIX目录不可变更。

    虽然java提供的SPI机制的思想非常好,但是也存在相应的弊端。具体如下:

    • Java内置的方法方式只能通过遍历来获取

    • 服务提供接口必须放到META-INF/services/目录下。

    针对java的spi存在的问题,Spring的SPI机制沿用的SPI的思想,但对其进行扩展和优化。

    Spring SPI

    Spring SPI沿用了Java SPI的设计思想,Spring采用的是spring.factories方式实现SPI机制,可以在不修改Spring源码的前提下,提供Spring框架的扩展性。

    Spring示例

    定义接口

    public interface DataBaseSPI
    {
       void getConnection();
    }
    登录后复制

    相关实现

    #DB2实现
    public class DB2DataBase implements DataBaseSPI
    {
        @Override
        public void getConnection()
        {
            System.out.println("this database is db2");
        }
    }
    #Mysql实现
    public class MysqlDataBase implements DataBaseSPI
    {
        @Override
        public void getConnection()
        {
           System.out.println("this is mysql database");
        }
    }
    登录后复制

    1.在项目的META-INF目录下,新增spring.factories文件

    SpringBoot的SPI机制怎么实现

    2.填写相关的接口信息,内容如下

    com.skywares.fw.juc.springspi.DataBaseSPI = com.skywares.fw.juc.springspi.DB2DataBase, com.skywares.fw.juc.springspi.MysqlDataBase

    说明多个实现采用逗号分隔。

    相关测试类

    public class SpringSPITest
    {
        public static void main(String[] args)
        {
             List<DataBaseSPI> dataBaseSPIs =SpringFactoriesLoader.loadFactories(DataBaseSPI.class, 
                     Thread.currentThread().getContextClassLoader());
             for(DataBaseSPI datBaseSPI:dataBaseSPIs){
                datBaseSPI.getConnection();
             }
        }
    }
    登录后复制

    输出结果

    SpringBoot的SPI机制怎么实现

    从示例中我们看出,Spring 采用spring.factories实现SPI与java实现SPI非常相似,但是spring的spi方式针对java的spi进行的相关优化具体内容如下:

    • Java SPI是一个服务提供接口对应一个配置文件,配置文件中存放当前接口的所有实现类,多个服务提供接口对应多个配置文件,所有配置都在services目录下;

    • Spring factories SPI是一个spring.factories配置文件存放多个接口及对应的实现类,以接口全限定名作为key,实现类作为value来配置,多个实现类用逗号隔开,仅spring.factories一个配置文件。

    那么spring是如何通过加载spring.factories来实现SpI的呢?我们可以通过源码来进一步分析。

    源码分析

    SpringBoot的SPI机制怎么实现

    说明:loadFactoryNames解析spring.factories文件中指定接口的实现类的全限定名,具体实现如下:

    SpringBoot的SPI机制怎么实现

    说明: 获取所有jar包中META-INF/spring.factories文件路径,以枚举值返回。 遍历spring.factories文件路径,逐个加载解析,整合factoryClass类型的实现类名称,获取到实现类的全类名称后进行类的实例话操作,其相关源码如下:

    SpringBoot的SPI机制怎么实现

    说明:实例化是通过反射来实现对应的初始化。

    以上是SpringBoot的SPI机制怎么实现的详细内容。更多信息请关注PHP中文网其他相关文章!

    相关标签:
    来源:yisu.com
    本站声明
    本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
    热门教程
    更多>
    最新下载
    更多>
    网站特效
    网站源码
    网站素材
    前端模板