?2016-2026 Matools All rights reserved,
粵ICP備17059708號(hào)
JDK SPI是什么
最近工作中聽?zhēng)讉€(gè)同事說(shuō)了好幾次SPI這個(gè)名詞，雖然和我沒關(guān)系，但是心里默默想還是學(xué)習(xí)一下，不然下次和我說(shuō)到SPI，連是什么都不知道那就尷尬了。
所以SPI是什么呢？SPI全稱Service Provider
Interface，在Java中還是一個(gè)比較重要的概念，是Java提供的一套用來(lái)被第三方實(shí)現(xiàn)或者擴(kuò)展的API，或者換句話說(shuō)，SPI是一種服務(wù)發(fā)現(xiàn)機(jī)制。
?
JDK SPI使用說(shuō)明及示例
要使用SPI比較簡(jiǎn)單，只需要按照以下幾個(gè)步驟操作即可：
* 在jar包的META-INF/services目錄下創(chuàng)建一個(gè)以"接口全限定名"為命名的文件，內(nèi)容為實(shí)現(xiàn)類的全限定名
* 接口實(shí)現(xiàn)類所在的jar包在classpath下
*
主程序通過(guò)java.util.ServiceLoader動(dòng)態(tài)狀態(tài)實(shí)現(xiàn)模塊，它通過(guò)掃描META-INF/services目錄下的配置文件找到實(shí)現(xiàn)類的全限定名，把類加載到JVM
* SPI的實(shí)現(xiàn)類必須帶一個(gè)無(wú)參構(gòu)造方法
接著我們看一下具體例子，首先定義一個(gè)SpiService，它是一個(gè)接口：
package org.xrq.test.spi; public interface SpiService { public void hello(); }
兩個(gè)實(shí)現(xiàn)類，分別為SpiServiceA與SpiServiceB：
package org.xrq.test.spi; public class SpiServiceA implements SpiService {
public void hello() { System.out.println("SpiServiceA.Hello"); } }
package org.xrq.test.spi; public class SpiServiceB implements SpiService {
@Overridepublic void hello() { System.out.println("SpiServiceB.hello"); } }
接著我們建一個(gè)META-INF/services的文件夾，里面建一個(gè)file，file的名字是接口的全限定名org.xrq.test.spi.SpiService：
文件的內(nèi)容是SpiService實(shí)現(xiàn)類SpiServiceA、SpiServiceB的全限定名：
org.xrq.test.spi.SpiServiceA org.xrq.test.spi.SpiServiceB
這樣就大功告成了！然后我們寫個(gè)測(cè)試類自動(dòng)加載一下這兩個(gè)類：
public class SpiTest { @Test public void testSpi() { ServiceLoader<SpiService>
serviceLoader = ServiceLoader.load(SpiService.class); Iterator<SpiService>
iterator = serviceLoader.iterator(); while (iterator.hasNext()) { SpiService
spiService= iterator.next(); spiService.hello(); } } }
結(jié)果一目了然，調(diào)用了hello()方法：
SpiServiceA.Hello SpiServiceB.hello
這就是SPI的使用示例，接著我們看一下SPI在實(shí)際場(chǎng)景中的應(yīng)用。
?
SPI在JDBC中的應(yīng)用
回看快四年前的文章https://www.cnblogs.com/xrq730/p/4851944.html
<https://www.cnblogs.com/xrq730/p/4851944.html>，這篇名為《
JDBC學(xué)習(xí)2：為什么要寫Class.forName("XXX")？
<https://www.cnblogs.com/xrq730/p/4851944.html>
》的文章里面當(dāng)時(shí)技術(shù)真的是稚嫩，為什么不寫Class.forName("XXX")的解釋現(xiàn)在看來(lái)真的是弱爆了，最后一樓網(wǎng)友的回復(fù)"
不用寫的原因是，新版本JDBC使用了SPI"，所以學(xué)了一下SPI馬上就想起這個(gè)例子來(lái)了，因此就由JDBC講講SPI的實(shí)際應(yīng)用。
在老版本的JDBC中，假設(shè)我們使用的是MySql，初始化JDBC的時(shí)候是需要顯式調(diào)用Class.forName("com.mysql.jdbc.Driver
")這一句的，但是在某個(gè)版本之后就不需要做這一步操作了，如上所說(shuō)這是通過(guò)SPI實(shí)現(xiàn)的，怎么理解呢。Class.forName其實(shí)沒有實(shí)際意義，其實(shí)既不會(huì)new對(duì)象也不會(huì)反射生成對(duì)象，它只是為了調(diào)用com.mysql.jdbc.Driver的static方法塊而已：
public class Driver extends NonRegisteringDriver implements java.sql.Driver {
// // Register ourselves with the DriverManager // static { try {
java.sql.DriverManager.registerDriver(new Driver()); } catch (SQLException E) {
throw new RuntimeException("Can't register driver!"); } } /** * Construct a new
driver and register it with DriverManager * *@throws SQLException * if a
database error occurs.*/ public Driver() throws SQLException { // Required for
Class.forName().newInstance() } }
方法塊的作用只有一個(gè)，通過(guò)jdk自帶的DriverManager注冊(cè)Driver，registerDrivers方法沒什么套路，把Driver放到CopyOnArrayList里面而已：
public static synchronized void registerDriver(java.sql.Driver driver,
DriverAction da)throws SQLException { /* Register the driver if it has not
already been added to our list*/ if(driver != null) {
registeredDrivers.addIfAbsent(new DriverInfo(driver, da)); } else { // This is
for compatibility with the original DriverManager throw new
NullPointerException(); } println("registerDriver: " + driver); }
從某個(gè)JDK版本，具體也不知道哪個(gè)版本，廢棄了這個(gè)操作，看下新版的DriverManager，我的是JDK1.8的：
/** * Load the initial JDBC drivers by checking the System property *
jdbc.properties and then use the {@code ServiceLoader} mechanism */ static {
loadInitialDrivers(); println("JDBC DriverManager initialized"); }
直接看一下loadInitialDrivers這個(gè)方法的核心部分：
AccessController.doPrivileged(new PrivilegedAction<Void>() { public Void run()
{ ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
Iterator<Driver> driversIterator = loadedDrivers.iterator(); /* * 節(jié)約篇幅，注釋省略 */
try{ while(driversIterator.hasNext()) { driversIterator.next(); } } catch
(Throwable t) {// Do nothing } return null; } });
看到使用SPI的方式從META-INF/services下去找java.sql.Driver這個(gè)文件，并找到里面的Driver實(shí)現(xiàn)類逐一注入。最后我們看一下Iterator的next()方法做了什么就完全懂了，通過(guò)next()方法調(diào)用了：
private S nextService() { if (!hasNextService()) throw new
NoSuchElementException(); String cn= nextName; nextName = null; Class<?> c =
null; try { c = Class.forName(cn, false, loader); } catch
(ClassNotFoundException x) { fail(service,"Provider " + cn + " not found"); } if
(!service.isAssignableFrom(c)) { fail(service, "Provider " + cn + " not a
subtype"); } try { S p = service.cast(c.newInstance()); providers.put(cn, p);
return p; } catch (Throwable x) { fail(service, "Provider " + cn + " could not
be instantiated", x); } throw new Error(); // This cannot happen }
看到Class.forName了吧，雖然都是Class.forName，但是通過(guò)SPI的方式把用戶手動(dòng)做的動(dòng)作變成框架做。
?
對(duì)SPI的理解
最后談一談我對(duì)SPI的理解，學(xué)習(xí)了怎么用SPI、SPI在實(shí)際應(yīng)用中的示例之后，深刻理解SPI機(jī)制才能在以后工作中真正將SPI為我所用。
首先大家可以注意到，標(biāo)題是JDK
SPI，也就是說(shuō)SPI并不是JDK專屬的。是的，我理解的SPI其實(shí)是一種可插拔技術(shù)的總稱，最簡(jiǎn)單的例子就是USB，廠商提供了USB的標(biāo)準(zhǔn)，廠家根據(jù)USB的標(biāo)準(zhǔn)制造自己的外設(shè)，例如鼠標(biāo)、鍵盤、游戲手柄等等，但是USB標(biāo)準(zhǔn)具體在電腦中是怎么用的，廠家就不需要管了。
回到我們的代碼中也是一樣的道理。當(dāng)我們開發(fā)一個(gè)框架的時(shí)候，除了保證基本的功能外，最重要的一個(gè)點(diǎn)是什么？我認(rèn)為最重要的應(yīng)該是松耦合，即對(duì)擴(kuò)展開放、對(duì)修改關(guān)閉
，保證框架實(shí)現(xiàn)對(duì)于使用者來(lái)說(shuō)是黑盒。
框架不可能做好所有的事情，只能把共性的部分抽離出來(lái)進(jìn)行流程化，松耦合實(shí)現(xiàn)的核心就是定義好足夠松散的接口，或者可以理解是擴(kuò)展點(diǎn)，具體的擴(kuò)展點(diǎn)讓使用者去實(shí)現(xiàn)，這樣不同的擴(kuò)展就不需要修改源代碼或者對(duì)框架進(jìn)行定制，這就是面向接口編程的好處。
回到我們框架的部分來(lái)說(shuō)：
* JDK對(duì)于SPI的實(shí)現(xiàn)是通過(guò)META-INF/services這個(gè)目錄 + ServiceLoader
*
Spring實(shí)現(xiàn)SPI的方式是留了N多的接口，例如BeanPostProcessor、InitializingBean、DisposableBean，我們只需要實(shí)現(xiàn)這些接口然后注入即可
對(duì)已有框架而言，我們可以通過(guò)框架給我們提供的擴(kuò)展點(diǎn)擴(kuò)展框架功能。對(duì)自己寫框架而言，記得SPI這個(gè)事情，留好足夠的擴(kuò)展點(diǎn)，這將大大加強(qiáng)你寫的框架的擴(kuò)展性。
?
熱門工具 換一換