簡(jiǎn)單分析JDK中「SPI」的原理
一、SPI簡(jiǎn)介
1、概念
SPI即service-provider-interface的簡(jiǎn)寫(xiě);
JDK內(nèi)置的服務(wù)提供加載機(jī)制,可以為服務(wù)接口加載實(shí)現(xiàn)類,解耦是其核心思想,也是很多框架和組件的常用手段;
2、入門(mén)案例
2.1 定義接口
就是普通的接口,在SPI的機(jī)制中稱為【service】,即服務(wù);
public interface Animal { String animalName () ; }
2.2 兩個(gè)實(shí)現(xiàn)類
提供兩個(gè)模擬用來(lái)測(cè)試,就是普通的接口實(shí)現(xiàn)類,在SPI的機(jī)制中稱為【service-provider】即服務(wù)提供方;
CatAnimal實(shí)現(xiàn)類;
public class CatAnimal implements Animal { @Override public String animalName() { System.out.println("Cat-Animal:布偶貓"); return "Ragdoll"; } }
DogAnimal實(shí)現(xiàn)類;
public class DogAnimal implements Animal { @Override public String animalName() { System.out.println("Dog-Animal:哈士奇"); return "husky"; } }
2.3 配置文件
文件目錄:在代碼工程中創(chuàng)建META-INF.services文件夾;
文件命名:butte.program.basics.spi.inf.Animal,即全限定接口名稱;
文件內(nèi)容:添加相應(yīng)實(shí)現(xiàn)類的全限定命名;
butte.program.basics.spi.impl.CatAnimal butte.program.basics.spi.impl.DogAnimal
2.4 測(cè)試代碼
通過(guò)ServiceLoader加載配置文件中指定的服務(wù)實(shí)現(xiàn)類,然后遍歷并調(diào)用Animal接口方法,從而執(zhí)行不同服務(wù)提供方的具體邏輯;
public class SpiAnaly { public static void main(String[] args) { ServiceLoader<Animal> serviceLoader = ServiceLoader.load(Animal.class); Iterator<Animal> animalIterator = serviceLoader.iterator(); while(animalIterator.hasNext()) { Animal animal = animalIterator.next(); System.out.println("animal-name:" + animal.animalName()); } } }
結(jié)果輸出
Cat-Animal:布偶貓 \n animal-name:ragdoll Dog-Animal:哈士奇 \n animal-name:husky
二、原理分析
1、ServiceLoader結(jié)構(gòu)
很顯然,分析SPI機(jī)制的原理,從ServiceLoader源碼中l(wèi)oad方法切入即可,但是需要先從核心類的結(jié)構(gòu)開(kāi)始分析;
public final class ServiceLoader<S> implements Iterable<S> { // 配置文件目錄 private static final String PREFIX = "META-INF/services/"; // 表示正在加載的服務(wù)的類或接口 private final Class<S> service; // 類加載器用來(lái)定位,加載,實(shí)例化服務(wù)提供方 private final ClassLoader loader; // 創(chuàng)建ServiceLoader時(shí)采用的訪問(wèn)控制上下文 private final AccessControlContext acc; // 按實(shí)例化的順序緩存服務(wù)提供方 private LinkedHashMap<String,S> providers = new LinkedHashMap<>(); // 惰性查找迭代器 private LazyIterator lookupIterator; /** * service:表示服務(wù)的接口或抽象類 * loader: 類加載器 */ public static <S> ServiceLoader<S> load(Class<S> service) { ClassLoader cl = Thread.currentThread().getContextClassLoader(); return ServiceLoader.load(service, cl); } /** * ServiceLoader構(gòu)造方法 */ private ServiceLoader(Class<S> svc, ClassLoader cl) { loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl; acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null; reload(); } public void reload() { providers.clear(); // 實(shí)例化迭代器 lookupIterator = new LazyIterator(service, loader); } public static <S> ServiceLoader<S> load(Class<S> service,ClassLoader loader) { return new ServiceLoader<>(service, loader); } private class LazyIterator implements Iterator<S> { // 服務(wù)接口 Class<S> service; // 類加載器 ClassLoader loader; // 實(shí)現(xiàn)類URL Enumeration<URL> configs = null; // 實(shí)現(xiàn)類全名 Iterator<String> pending = null; // 下個(gè)實(shí)現(xiàn)類全名 String nextName = null; } }
斷點(diǎn)截圖:
2、iterator迭代方法
在ServiceLoader類的迭代器方法中,實(shí)際使用的是LazyIterator內(nèi)部類的方法;
public Iterator<S> iterator() { return new Iterator<S>() { Iterator<Map.Entry<String,S>> knownProviders = providers.entrySet().iterator(); public boolean hasNext() { if (knownProviders.hasNext()) return true; return lookupIterator.hasNext(); } public S next() { if (knownProviders.hasNext()) return knownProviders.next().getValue(); return lookupIterator.next(); } public void remove() { throw new UnsupportedOperationException(); } }; }
3、hasNextService方法
從上面迭代方法的源碼中可知,最終執(zhí)行的是LazyIterator#hasNextService判斷方法,該方法通過(guò)解析最終會(huì)得到實(shí)現(xiàn)類的全限定名稱;
private class LazyIterator implements Iterator<S> { private boolean hasNextService() { // 1、拼接名稱 String fullName = PREFIX + service.getName(); // 2、加載資源文件 configs = loader.getResources(fullName); // 3、解析文件內(nèi)容 pending = parse(service, configs.nextElement()); nextName = pending.next(); return true; } }
斷點(diǎn)截圖:
4、nextService方法
迭代器的next方法最終執(zhí)行的是LazyIterator#nextService獲取方法,會(huì)基于上面hasNextService方法獲取的實(shí)現(xiàn)類全限定名稱,獲取其Class對(duì)象,進(jìn)而得到實(shí)例化對(duì)象,緩存并返回;
private class LazyIterator implements Iterator<S> { private S nextService() { // 1、通過(guò)全限定命名獲取Class對(duì)象 String cn = nextName; Class<?> c = Class.forName(cn, false, loader); // 2、實(shí)例化對(duì)象 S p = service.cast(c.newInstance()); // 3、放入緩存并返回該對(duì)象 providers.put(cn, p); return p; } }
斷點(diǎn)截圖:
三、SPI實(shí)踐
1、Driver驅(qū)動(dòng)接口
在JDK中提供了數(shù)據(jù)庫(kù)驅(qū)動(dòng)接口java.sql.Driver,無(wú)論是MySQL驅(qū)動(dòng)包還是Druid連接池,都提供了該接口的實(shí)現(xiàn)類,通過(guò)SPI機(jī)制可以加載到這些驅(qū)動(dòng)實(shí)現(xiàn)類;
public class DriverManager { private static void loadInitialDrivers() { AccessController.doPrivileged(new PrivilegedAction<Void>() { public Void run() { ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(java.sql.Driver.class); Iterator<Driver> driversIterator = loadedDrivers.iterator(); } }); } }
斷點(diǎn)截圖:
2、Slf4j日志接口
SLF4J是門(mén)面模式的日志組件,提供了標(biāo)準(zhǔn)的日志服務(wù)SLF4JServiceProvider接口,在LogFactory日志工廠類中,負(fù)責(zé)加載具體的日志實(shí)現(xiàn)類,比如常用的Log4j或Logback日志組件;
public final class LoggerFactory { static List<SLF4JServiceProvider> findServiceProviders() { // 服務(wù)加載 ClassLoader classLoaderOfLoggerFactory = org.slf4j.LoggerFactory.class.getClassLoader(); // 重點(diǎn)看該方法:【getServiceLoader()】 ServiceLoader<SLF4JServiceProvider> serviceLoader = getServiceLoader(classLoaderOfLoggerFactory); // 迭代方法 List<SLF4JServiceProvider> providerList = new ArrayList(); Iterator<SLF4JServiceProvider> iterator = serviceLoader.iterator(); while(iterator.hasNext()) { safelyInstantiate(providerList, iterator); } return providerList; } }
斷點(diǎn)截圖:
到此這篇關(guān)于簡(jiǎn)單分析JDK中「SPI」的原理的文章就介紹到這了,更多相關(guān)JDK中「SPI」的原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
WPF實(shí)現(xiàn)自定義一個(gè)自刪除的多功能ListBox
這篇文章主要為大家詳細(xì)介紹了如何利用WPF實(shí)現(xiàn)自定義一個(gè)自刪除的多功能ListBox,文中示例代碼講解詳細(xì),感興趣的小伙伴可以了解一下2022-12-12BaseDao封裝JavaWeb的增刪改查的實(shí)現(xiàn)代碼
Basedao 是一種基于數(shù)據(jù)訪問(wèn)對(duì)象(Data Access Object)模式的設(shè)計(jì)方法,它是一個(gè)用于處理數(shù)據(jù)庫(kù)操作的基礎(chǔ)類,負(fù)責(zé)封裝數(shù)據(jù)庫(kù)訪問(wèn)的底層操作,提供通用的數(shù)據(jù)庫(kù)訪問(wèn)方法,本文給大家介紹了BaseDao封裝JavaWeb的增刪改查的實(shí)現(xiàn)代碼,需要的朋友可以參考下2024-03-03線程池調(diào)用kafka發(fā)送消息產(chǎn)生的內(nèi)存泄漏問(wèn)題排查解決
這篇文章主要為大家介紹了線程池調(diào)用kafka發(fā)送消息產(chǎn)生的內(nèi)存泄漏問(wèn)題排查解決,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08Java多線程 Producer and Consumer設(shè)計(jì)模式
這篇文章主要介紹了Java多線程 Producer and Consumer設(shè)計(jì)模式,producer是生產(chǎn)者的意思:指生產(chǎn)數(shù)據(jù)的線程,consumer是消費(fèi)者的意思,指的是使用數(shù)據(jù)的線程,下文圍繞Producer及Consumer展開(kāi)話題,需要的朋友可以參考一下2021-10-10