读懂Springboot必会的java SPI思想
- 什么是java的SPI
- SPI 应用场景
- Java SPI 规范
- 案例代码
- 创建案例工程
什么是java的SPI
SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件。
Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。
系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。
Java SPI就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。
SPI 应用场景
比较常见的例子:
数据库驱动加载接口实现类的加载
JDBC加载不同类型数据库的驱动
日志门面接口实现类加载
SLF4J加载不同提供商的日志实现类
Spring
Spring中大量使用了SPI,比如:对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
Dubbo
Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装,允许用户扩展实现Filter接口
Java SPI 规范
要使用Java SPI,需要遵循如下约定:
1、当服务提供者提供了接口的一种具体实现后,在jar包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名;
2、接口实现类所在的jar包放在主程序的classpath中;
3、主程序通过java.util.ServiceLoder动态装载实现模块,它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名,把类加载到JVM;
4、SPI的实现类必须携带一个不带参数的构造方法;
案例代码
创建案例工程
1.创建父工程
2. 创建service-common工程
此工程模块为其他工程的公共的依赖模块,在其中定义PayService接口
public interface PayService {public void pay();
}
- 创建ali-pay工程
在pom.xml文件中引入依赖
<dependencies><dependency><groupId>cn.tx.spi</groupId><artifactId>service-common</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
创建PayService的实现类AliPayService
public class AliPayService implements PayService {public void pay() {System.out.println("支付宝支付");}
}
在resources下创建META-INF.services包
创建cn.tx.service.PayService文件内容如下&#xff1a;指定文件名所示的接口的实现类
cn.tx.impl.AliPayService
4.创建wx-pay工程
在pom.xml文件中引入依赖
<dependencies><dependency><groupId>cn.tx.spi</groupId><artifactId>service-common</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
创建PayService的实现类WxPayService
public class WxPayService implements PayService {public void pay() {System.out.println("微信支付");}
}
在resources下创建META-INF.services包
创建cn.tx.service.PayService文件内容如下&#xff1a;指定文件名所示的接口的实现类
cn.tx.impl.WxPayService
5.创建main-pay工程
引入依赖
<dependencies><dependency><groupId>cn.tx.spi</groupId><artifactId>service-common</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>cn.tx.spi</groupId><artifactId>ali-pay</artifactId><version>1.0-SNAPSHOT</version></dependency><!--<dependency><groupId>cn.tx.spi</groupId><artifactId>wx-pay</artifactId><version>1.0-SNAPSHOT</version></dependency>--></dependencies>
创建测试类
public class Test {public static void main(String[] args) {ServiceLoader<PayService> services &#61; ServiceLoader.load(PayService.class);for (PayService service : services) {service.pay();}}
}
执行测试&#xff1a;我们可以看到我们引入的Ali-pay就能得到AlipayService的实现类实例
如果我在pom中切换依赖
<dependencies><dependency><groupId>cn.tx.spi</groupId><artifactId>service-common</artifactId><version>1.0-SNAPSHOT</version></dependency><!--<dependency><groupId>cn.tx.spi</groupId><artifactId>ali-pay</artifactId><version>1.0-SNAPSHOT</version></dependency>--><dependency><groupId>cn.tx.spi</groupId><artifactId>wx-pay</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
再次执行测试&#xff1a;我们可以看到我们引入的wx-pay就能得到WxpayService的实现类实例
如果两种支付的依赖都引入
<dependencies><dependency><groupId>cn.tx.spi</groupId><artifactId>service-common</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>cn.tx.spi</groupId><artifactId>ali-pay</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>cn.tx.spi</groupId><artifactId>wx-pay</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
测试结果
使用Java SPI机制的优势是实现解耦&#xff0c;使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离&#xff0c;而不是耦合在一起。应用程序可以根据实际业务情况启用框架扩展或替换框架组件。
Springboot的原理即是使用期原理来做的自动配置。
源码获取和更多内容可以加Q群264572737
直接群中找到我即可。