ServiceLoader實現原(yuan)理
在java中根據一個子類獲取其父類或接口信息非常方便,但是根據一個接口獲取該接口的所有實現類卻沒那么容易。
有一種(zhong)比較笨的(de)辦(ban)法就(jiu)是(shi)掃描classpath所有的(de)class與jar包中的(de)class,然(ran)后用ClassLoader加載進來,然(ran)后再(zai)判斷是(shi)否是(shi)給定接口(kou)的(de)子(zi)類。但是(shi)很(hen)顯然(ran),不會(hui)使(shi)用這種(zhong)方法,代價(jia)太大(da)。
java本身也提供了一種方式來獲取一個接口的子類,那就是使用java.util.ServiceLoader#load(java.lang.Class<S>) 方法(fa),但是直(zhi)接使用(yong)該方法(fa)也是不能獲取(qu)到給(gei)定接口所有的子類的。
需(xu)要(yao)接口的子類以配置的方(fang)式主(zhu)動(dong)注冊(ce)到一個接口上,才(cai)能使用ServiceLoader進行(xing)加載到子類,并且(qie)子類需(xu)要(yao)有(you)一個無(wu)參構(gou)造方(fang)法(fa),用于被ServiceLoader進行(xing)實例化
下面介紹使用ServiceLoader的步驟
1、 編(bian)寫(xie)Service
package com.mogujie.uni.sl; /** * Created by laibao */ public interface Animal { void eat(); }
2、編寫實現(xian)類(lei)(注意(yi):實現(xian)類(lei)不一定(ding)要與(yu)接口在(zai)同一個工程(cheng)中,可以存在(zai)于其他的(de)jar包(bao)中)
package com.mogujie.uni.sl; /** * Created by laibao */ public class Pig implements Animal { @Override public void eat() { System.out.println("Pig eating..."); } }
package com.mogujie.uni.sl; /** * Created by laibao */ public class Dog implements Animal { @Override public void eat() { System.out.println("Dog eating..."); } }
3、 在實現類所在的工程的classpath下面的建立META-INF/services目錄,該目錄是固定的,一定要按照規定的名稱去創建,該目錄用于配置接口與實現類的映射關系
然后根據接(jie)(jie)口(kou)全名(ming) 在該(gai)目(mu)錄(lu)創建(jian)(jian)一(yi)個文件(jian)(jian),例如上面(mian)例子中(zhong)接(jie)(jie)口(kou)全名(ming)是com.mogujie.uni.sl.Animal,那么(me)就需(xu)要在實(shi)現(xian)(xian)類的工程中(zhong)建(jian)(jian)立META-INF/services/com.mogujie.uni.sl.Animal這樣一(yi)個文件(jian)(jian),然后在該(gai)文件(jian)(jian)中(zhong)配置(zhi)該(gai)接(jie)(jie)口(kou)的實(shi)現(xian)(xian)類,如果該(gai)接(jie)(jie)口(kou)有多個實(shi)現(xian)(xian)類,一(yi)行寫一(yi)個(以換(huan)行符分(fen)割),例如:
com.mogujie.uni.sl.Pig
com.mogujie.uni.sl.Dog
4、接下(xia)來就(jiu)能使(shi)用(yong)ServiceLoader的(de)方法獲取com.mogujie.uni.sl.Animal接口的(de)所(suo)有子類了。測試(shi)類如下(xia):
package com.mogujie.uni; import com.mogujie.uni.sl.Animal; import java.util.Iterator; import java.util.ServiceLoader; /** * Created by laibao */ public class TestServiceLoader { 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(); animal.eat(); } } }
輸出如下:
Pig eating...
Dog eating...
ServiceLoader的(de)原理其實很簡單(dan),就(jiu)(jiu)是根據(ju)給定的(de)參數(接口)就(jiu)(jiu)能定位到(dao)該接口與實現類的(de)映(ying)射配置文件(jian)的(de)路徑了,然(ran)后讀(du)取該配置文件(jian),就(jiu)(jiu)能獲取到(dao)該接口的(de)子類
下面(mian)自(zi)己實現一個CustomServiceLoader與系(xi)統的ServiceLoader具有同樣的功能
package com.mogujie.uni; import org.apache.commons.io.IOUtils; import java.net.URL; import java.util.Enumeration; import java.util.LinkedList; import java.util.List; /** * Created by laibao */ public class CustomServiceLoader { public static final String MAPPING_CONFIG_PREFIX = "META-INF/services"; public static <S> List<S> loade(Class<S> service) throws Exception{ String mappingConfigFile = MAPPING_CONFIG_PREFIX + "/" + service.getName() ; //由于(yu)一個(ge)接口的實現類可能(neng)存在(zai)多個(ge)jar包(bao)中的META-INF目錄(lu)下(xia),所以下(xia)面使用getResources返回(hui)一個(ge)URL數組 Enumeration<URL> configFileUrls = CustomServiceLoader.class.getClassLoader().getResources(mappingConfigFile); if(configFileUrls == null){ return null ; } List<S> services = new LinkedList<S>(); while(configFileUrls.hasMoreElements()){ URL configFileUrl = configFileUrls.nextElement(); String configContent = IOUtils.toString(configFileUrl.openStream()); String[] serviceNames = configContent.split("\n"); for(String serviceName : serviceNames){ Class serviceClass = CustomServiceLoader.class.getClassLoader().loadClass(serviceName); Object serviceInstance = serviceClass.newInstance(); services.add((S)serviceInstance); } } return services ; } }
測試類如下:
package com.mogujie.uni; import com.mogujie.uni.sl.Animal; import java.util.List; /** * Created by laibao */ public class CustomServiceLoaderTest { public static void main(String[] args) throws Exception { List<Animal> animals = CustomServiceLoader.loade(Animal.class); for (Animal animal : animals){ animal.eat(); } } }
輸出:
Pig eating...
Dog eating...
java系統定義的ServiceLoader與我們自定義的CustomServiceLoader的loade方法,它們的返回值類型是不一樣的,ServiceLoader的loade方法返回的是ServiceLoader對象,ServiceLoader對象實現了Iterable接口,通過ServiceLoader的成員方法iterator();就能遍歷所有的服務實例,而我們自定義的CustomServiceLoader的load方法返回的是一個List對象,直接將所有的服務實例封裝在一個集合里面返回了。
系(xi)統的ServiceLoader通過返回(hui)一(yi)個(ge)Iterator對象能夠(gou)做到對服(fu)務(wu)實(shi)(shi)例的懶加(jia)載 只有(you)(you)當調用(yong)iterator.next()方(fang)法時才會(hui)實(shi)(shi)例化下一(yi)個(ge)服(fu)務(wu)實(shi)(shi)例,只有(you)(you)需要使用(yong)的時候(hou)才進行(xing)實(shi)(shi)例化,具(ju)體實(shi)(shi)現讀者(zhe)可以去閱(yue)讀源碼(ma)進行(xing)研究,這也是其設(she)計(ji)的亮點之一(yi)。