SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件。
Java SPI就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。
Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。
典型实例:jdbc的设计
通常各大厂商(如Mysql、Oracle)会根据一个统一的规范(java.sql.Driver)开发各自的驱动实现逻辑。客户端使用jdbc时不需要去改变代码,直接引入不同的spi接口服务即可。
Mysql的则是com.mysql.jdbc.Drive,Oracle则是oracle.jdbc.driver.OracleDriver。
可以参考如下文件配置
1.代码编写
既然是spi,那么就必须先定义好接口。其次,就是定义好接口的实现类。
public interface HelloService { void hello(); } public class HelloService1 implements HelloService { @Override public void hello() { System.out.println("hello world"); } } public class HelloService2 implements HelloService { @Override public void hello() { System.out.println("hello chenziyang"); } }
2.创建一个文件夹
在项目的srcmain esources下创建META-INFservices目录,还需要将resources目录变更为Resources资源目录
3.文件夹下增加配置文件
在上面META-INFservices的目录下再增加一个配置文件,这个文件必须以接口的全限定类名保持一致,例如:com.java.HelloService
4.配置文件增加描述
上面介绍spi时说道,除了代码上的接口实现之外,还需要把该实现的描述提供给JDK。那么,此步骤就是在配置文件中撰写接口实现描述。很简单,就是在配置文件中写入具体实现类的全限定类名,如有多个便换行写入。
com.java.imp.HelloService1 com.java.imp.HelloService2
5.使用JDK来载入
编写main()方法,输出测试接口。使用JDK提供的ServiceLoader.load()来加载配置文件中的描述信息,完成类加载操作。
public class Test { public static void main(String[] args) { ServiceLoader<HelloService> loaders = ServiceLoader.load(HelloService.class); for (HelloService hello:loaders) { hello.hello(); } } }
最后
总结
优点:
使用Java SPI机制的优势是实现解耦,使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离,而不是耦合在一起。应用程序可以根据实际业务情况启用框架扩展或替换框架组件。
相比使用提供接口jar包,供第三方服务模块实现接口的方式,SPI的方式使得源框架,不必关心接口的实现类的路径,可以不用通过下面的方式获取接口实现类:
- 代码硬编码import 导入实现类
- 指定类全路径反射获取:例如在JDBC4.0之前,JDBC中获取数据库驱动类需要通过Class.forName("com.mysql.jdbc.Driver"),类似语句先动态加载数据库相关的驱动,然后再进行获取连接等的操作
- 第三方服务模块把接口实现类实例注册到指定地方,源框架从该处访问实例
通过SPI的方式,第三方服务模块实现接口后,在第三方的项目代码的META-INF/services目录下的配置文件指定实现类的全路径名,源码框架即可找到实现类