初识Java SPI思想

最近在找实习,博客没有及时更新。最近了解了下一下SPI思想,记录一下。
spi的全称是:Service Provider Interface,也就是服务提供接口。我们都知道,我们在开发提倡面向接口开发,在运行期动态指定接口的具体的实现。在Java中,我们可以用反射,IOC(底层也是基于反射机制)来实现动态指定服务的具体提供者,从而达到解耦的目的,不在代码中写死了,从而达到在不修改代码的前提下,实现具体实现的选择。spi思想跟它类似:当系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。很多开源框架都采用了spi思想,比如dubbo扩展(协议等),jdbc(Java规定了JDBC的接口,可由不同厂商来实现:MySQL,Oracl等),不同的日志实现等。
Java SPI的约定 当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里指定。
jdk提供服务实现查找的一个工具类:java.util.ServiceLoader。
我们可以看到JDBC的驱动的MySQL实现类的配置: 初识Java SPI思想
文章图片
初识Java SPI思想
文章图片

我们可以看到,对于Java.sql.Driver接口的实现类MySQL,配置了相应的实现类的类路径。 注意:我们可以这样理解,java.sql.Driver是java提供的jdbc的驱动标准接口,任何数据库厂商都可以根据这个接口来实现自己的驱动服务。那么我们在选择装载驱动的时候,可以使用反射的方式:Class.forName("....")的方式来选择我们使用的数据库驱动。在jdbc4.0以后,都可以采用spi的思想,加载了mysql的驱动包后,mysql的驱动包配置了相应的services配置,我们可以直接使用ServiceLoader来加载对应的驱动。注意:配置,是配置在服务提供方的。我们可以提供工厂来获取相应的实现类。
测试SPI的使用 我看了一下网上的例子,大多数都用了查找这个例子,我就写了一下。比如,我们要实现一个查找服务:在文件中查找,在数据库中查找。我们首先定义接口(规范):

package com.spi.search; /** * @Description: * @Author: Jz Wang * @Date: Created in 20:082018/4/19. */ public interface Search {/** * 查找服务 * * @param keyword */ void search(String keyword); }

然后定义两个服务:
定义查找服务:分别在文件中查找和数据库中查找:
package com.spi.search.impl; import com.spi.search.Search; /** * @Description: * @Author: Jz Wang * @Date: Created in 20:102018/4/19. */ public class FileSearch implements Search { /** * 基于文件的查找服务 * * @param keyword */ @Override public void search(String keyword) { // 业务逻辑 System.out.println("基于文件进行查找!"); } }

package com.spi.search.impl; import com.spi.search.Search; /** * @Description: * @Author: Jz Wang * @Date: Created in 20:112018/4/19. */ public class DBSearch implements Search { /** * 基于数据库的查找服务 * * @param keyword */ @Override public void search(String keyword) { // 业务逻辑 System.out.println("基于数据库的查找操作!"); } }

定义services文件:比如我们此Jar包实现了在文件中查找的功能:
初识Java SPI思想
文章图片


初识Java SPI思想
文章图片



我们可以写测试类:
package com.spi.test; import com.spi.search.Search; import java.util.Iterator; import java.util.ServiceLoader; /** * @Description: * @Author: Jingzeng Wang * @Date: Created in 20:142018/4/19. */ public class SpiTest {public static void main(String[] args) { ServiceLoader searches = ServiceLoader.load(Search.class); Iterator iterator = searches.iterator(); if (iterator.hasNext()) { Search search1 = iterator.next(); search1.search("aaa"); }} }

结果:
初识Java SPI思想
文章图片




这样我们使用spi就可以实现了服务的选择。等到我们更换服务提供的jar包后,我们的业务逻辑代码不用变。













【初识Java SPI思想】

    推荐阅读