当前位置: 首页 > 后端技术 > Java

可插拔组件设计机制——SPI

时间:2023-04-01 22:18:52 Java

作者:孔向东,京东物流1.什么是SPI?SPI的全称是ServiceProviderInterface,提供服务接口;它是一种服务发现机制。SPI的本质是在文件中配置接口实现类的全限定名,服务加载器读取配置文件并加载实现类。.这样就可以在运行时为接口动态替换实现类。由于这个特点,我们可以很方便的通过SPI机制为我们的程序提供扩展功能。如下图所示:系统设计的每一个抽象往往有很多不同的实现方案。在面向对象设计中,一般建议基于接口在模块之间进行编程,模块的实现不硬编码。一旦代码涉及到具体的实现类,就违反了可插拔性原则的确立。JavaSPI提供了这样一种机制,为某个接口寻找某个服务的实现,这有点类似于IOC的思想,将组装的控制权移出程序,这在模块化中尤为重要。与其说SPI是java提供的一种服务发现机制,倒不如说是一种解耦思想。2、使用场景?数据库驱动加载接口实现类加载;如:JDBC加载Mysql,Oracle...logfacade接口实现类加载,如:SLF4J支持log4j和logbackSPI在Spring中被广泛使用,尤其是spring-boot中的自动配置Dubbo的实现也大量使用SPI来实现框架的扩展。它封装了原有的SPI,允许用户扩展实现Filter接口。3、使用介绍使用JavaSPI需要遵循如下约定:当服务提供者提供接口的具体实现时,需要在META-INF/services目录下创建一个“接口全限制名称”的JAR包。命名文件包含实现类的完全限定名称;将接口实现类所在的JAR放在主程序的类路径下,即引入依赖。主程序通过java.util.ServiceLoder动态加载实现模块。它会通过扫描META-INF/services目录下的文件找到实现类的完全限定名,将类加载到JVM中,并实例化;SPI实现类必须采用不带参数的构造函数。示例:spi-interface模块定义定义了一组接口:publicinterfaceMyDriverspi-jd-driversspi-ali-driver实现为:publicclassJdDriverimplementsMyDriverpublicclassAliDriverimplementsMyDriver建立在src/main/resources/下/META-INF/services目录,新增一个以接口命名的文件(org.MyDriver文件),内容为要应用的实现类,com.jd.JdDriver和com.ali.AliDriverspi-core一般为核心包平台提供的,包括加载使用实现类的策略等,我们这里简单实现一下逻辑:没有找到具体实现,抛出异常b.如果找到多个实现,则打印publicvoidinvoker(){ServiceLoaderserviceLoader=ServiceLoader.加载(MyDriver.class);Iteratordrivers=serviceLoader.iterator();布尔isNotFound=true;while(drivers.hasNext()){isNotFound=false;drivers.next().load();}if(isNotFound){thrownewRuntimeException("驱动实现类不存在");}}spi-testpublicclassApp{publicstaticvoidmain(String[]args){DriverFactoryfactory=newDriverFactory();工厂.调用者();}}1.引入spi-core包,执行结果2.引入spi-core,spi-jd-driver包3.引入spi-core,spi-jd-driver,spi-ali-driver4.原理分析我们看看刚才的具体实现类是怎么得到的?只需两行代码:ServiceLoaderserviceLoader=ServiceLoader.load(MyDriver.class);Iteratordrivers=serviceLoader.iterator();所以,首先我们看一下ServiceLoader类:publicfinalclassServiceLoaderimplementsIterable{//配置文件的路径privatestaticfinalStringPREFIX="META-INF/services/";//表示加载的类或接口privatefinalClassservice;//用于providers的定位、加载和实例类加载器privatefinalClassLoaderloader;//创建ServiceLoader时使用的访问控制上下文privatefinalAccessControlContextacc;//缓存提供者,按照实例化顺序排列privateLinkedHashMapproviders=newLinkedHashMap<>();//Lazylookupiterator,真正加载服务的类privateLazyIteratorlookupIterator;//服务提供者查找的迭代器privateclassLazyIteratorimplementsIterator{.....privatebooleanhasNextService(){if(nextName!=null){returntrue;}if(configs==null){try{//全局命名:com.xxxx.xxxStringfullName=PREFIX+service.getName();if(loader==null)configs=ClassLoader.getSystemResources(fullName);否则configs=loader.getResources(fullName);}}while((pending==null)||!pending.hasNext()){if(!configs.hasMoreElements()){returnfalse;}pending=parse(service,configs.nextElement());}nextName=pending.next();返回真;}privateSnextService(){if(!hasNextService())thrownewNoSuchElementException();Stringcn=nextName;下一个名字=空;类c=null;try{//通过反发射获取c=Class.forName(cn,false,装载机);}if(!service.isAssignableFrom(c)){fail(service,"Provider"+cn+"不是子类型");}try{Sp=service.cast(c.newInstance());providers.put(cn,p);返回p;}}........大致流程如下图:应用程序调用ServiceLoader.load方法,应用程序通过迭代器获取对象实例,会先判断是否已经有缓存的实例对象提供者对象。如果存在,则直接返回。如果不存在,执行类转载,读取META-INF/services下的配置文件,获取所有可以实例化的类的名称,可以跨JAR获取配置文件。通过反射方法Class.forName()加载对象,并通过Instance()方法实例化类。实例化的类缓存在提供者对象中并同步返回。组装控制逻辑与调用方业务代码分离,不会耦合在一起。应用程序可以根据实际业务情况启用框架扩展和更换框架组件。使用SPI使得无需通过以下方式获取实现类代码的硬编码导入。导入指定类的完全限定名以反映获取,如JDBC4.0之前;Class.forName("com.mysql.jdbc.Driver")缺点:ServiceLoader虽然也可以看成是懒加载,但是基本上只能通过遍历获取,即接口的所有实现类都加载并实例化一次.有些实现类如果不想用,也加载实例化,造成浪费。获取某个实现类的方式不够灵活,只能通过Iterator的形式获取,无法根据某个参数获取对应的实现类。6.对比