詳談ServiceLoader實現理

NO IMAGE

在java中根據一個子類獲取其父類或介面資訊非常方便,但是根據一個介面獲取該介面的所有實現類卻沒那麼容易。

有一種比較笨的辦法就是掃描classpath所有的class與jar包中的class,然後用ClassLoader載入進來,然後再判斷是否是給定介面的子類。但是很顯然,不會使用這種方法,代價太大。

java本身也提供了一種方式來獲取一個介面的子類,那就是使用java.util.ServiceLoader#load(java.lang.Class<S>) 方法,但是直接使用該方法也是不能獲取到給定介面所有的子類的。

需要介面的子類以配置的方式主動註冊到一個介面上,才能使用ServiceLoader進行載入到子類,並且子類需要有一個無參構造方法,用於被ServiceLoader進行例項化

下面介紹使用ServiceLoader的步驟

1、 編寫Service


package com.mogujie.uni.sl;
/**
* Created by laibao
*/
public interface Animal {
void eat();
}  

2、編寫實現類(注意:實現類不一定要與介面在同一個工程中,可以存在於其他的jar包中)


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目錄,該目錄是固定的,一定要按照規定的名稱去建立,該目錄用於配置介面與實現類的對映關係

然後根據介面全名 在該目錄建立一個檔案,例如上面例子中介面全名是com.mogujie.uni.sl.Animal,那麼就需要在實現類的工程中建立META-INF/services/com.mogujie.uni.sl.Animal這樣一個檔案,然後在該檔案中配置該介面的實現類,如果該介面有多個實現類,一行寫一個(以換行符分割),例如:


com.mogujie.uni.sl.Pig
com.mogujie.uni.sl.Dog

4、接下來就能使用ServiceLoader的方法獲取com.mogujie.uni.sl.Animal介面的所有子類了。

測試類如下:


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的原理其實很簡單,就是根據給定的引數(介面)就能定位到該介面與實現類的對映配置檔案的路徑了,然後讀取該配置檔案,就能獲取到該介面的子類

下面自己實現一個CustomServiceLoader與系統的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() ;
//由於一個介面的實現類可能存在多個jar包中的META-INF目錄下,所以下面使用getResources返回一個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物件,直接將所有的服務例項封裝在一個集合裡面返回了。

系統的ServiceLoader通過返回一個Iterator物件能夠做到對服務例項的懶載入 只有當呼叫iterator.next()方法時才會例項化下一個服務例項,只有需要使用的時候才進行例項化,具體實現讀者可以去閱讀原始碼進行研究,這也是其設計的亮點之一。

以上這篇詳談ServiceLoader實現原理就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支援指令碼之家。