在java中根據(jù)一個子類獲取其父類或接口信息非常方便，但是根據(jù)一個接口獲取該接口的所有實現(xiàn)類卻沒那么容易。
有一種比較笨的辦法就是掃描classpath所有的class與jar包中的class，然后用ClassLoader加載進來，然后再判斷是否是給定接口的子類。但是很顯然，不會使用這種方法，代價太大。
java本身也提供了一種方式來獲取一個接口的子類，那就是使用java.util.ServiceLoader#load(java.lang.Class<S>) 方法，但是直接使用該方法也是不能獲取到給定接口所有的子類的。
需要接口的子類以配置的方式主動注冊到一個接口上，才能使用ServiceLoader進行加載到子類，并且子類需要有一個無參構(gòu)造方法，用于被ServiceLoader進行實例化
下面介紹使用ServiceLoader的步驟
1、 編寫Service
|
1
2
3
4
5
6
7
|
package com.mogujie.uni.sl;/** * Created by laibao */public interface Animal { void eat();} |
2、編寫實現(xiàn)類（注意：實現(xiàn)類不一定要與接口在同一個工程中，可以存在于其他的jar包中）
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
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、 在實現(xiàn)類所在的工程的classpath下面的建立META-INF/services目錄，該目錄是固定的，一定要按照規(guī)定的名稱去創(chuàng)建，該目錄用于配置接口與實現(xiàn)類的映射關(guān)系
然后根據(jù)接口全名 在該目錄創(chuàng)建一個文件，例如上面例子中接口全名是com.mogujie.uni.sl.Animal，那么就需要在實現(xiàn)類的工程中建立META-INF/services/com.mogujie.uni.sl.Animal這樣一個文件，然后在該文件中配置該接口的實現(xiàn)類，如果該接口有多個實現(xiàn)類，一行寫一個（以換行符分割），例如：
|
1
2
|
com.mogujie.uni.sl.Pigcom.mogujie.uni.sl.Dog |
4、接下來就能使用ServiceLoader的方法獲取com.mogujie.uni.sl.Animal接口的所有子類了。
測試類如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
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(); } }} |
輸出如下：
|
1
2
|
Pig eating...Dog eating... |
ServiceLoader的原理其實很簡單，就是根據(jù)給定的參數(shù)（接口）就能定位到該接口與實現(xiàn)類的映射配置文件的路徑了，然后讀取該配置文件，就能獲取到該接口的子類
下面自己實現(xiàn)一個CustomServiceLoader與系統(tǒng)的ServiceLoader具有同樣的功能
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
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() ; //由于一個接口的實現(xiàn)類可能存在多個jar包中的META-INF目錄下，所以下面使用getResources返回一個URL數(shù)組 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 ; }} |
測試類如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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(); } }} |
輸出：
|
1
2
|
Pig eating...Dog eating... |
java系統(tǒng)定義的ServiceLoader與我們自定義的CustomServiceLoader的loade方法，它們的返回值類型是不一樣的，ServiceLoader的loade方法返回的是ServiceLoader對象，ServiceLoader對象實現(xiàn)了Iterable接口，通過ServiceLoader的成員方法iterator();就能遍歷所有的服務(wù)實例，而我們自定義的CustomServiceLoader的load方法返回的是一個List對象，直接將所有的服務(wù)實例封裝在一個集合里面返回了。
系統(tǒng)的ServiceLoader通過返回一個Iterator對象能夠做到對服務(wù)實例的懶加載 只有當(dāng)調(diào)用iterator.next()方法時才會實例化下一個服務(wù)實例，只有需要使用的時候才進行實例化，具體實現(xiàn)讀者可以去閱讀源碼進行研究，這也是其設(shè)計的亮點之一。
以上這篇詳談ServiceLoader實現(xiàn)原理就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持服務(wù)器之家。
