簡単な紹介
サービスプロバイダインタフェースのSPI完全な名前は、主にメーカーのカスタムコンポーネントやプラグインに適用されます。java.util.ServiceLoaderドキュメントの詳細な説明。JavaのSPIメカニズムの下でのアイデアの簡単な要約:抽象モジュールの我々のシステムは、プログラムは、ロギングモジュール、XML解析モジュール、JDBCモジュールなど、さまざまな実装の多くを持っている傾向があります。オブジェクト指向設計、ハードコーディングされ達成しないプログラム間のインタフェースに基づいて、我々は一般的にモジュールクラスモジュール間をお勧めします。特定のカテゴリに関連するコードと、それはあなたが、実装を交換する必要がある場合は、コードを変更する必要があり、プラグイン可能なの原則に違反します。プログラムを達成するために必要とする、モジュールアセンブリの動的時間で指定することができないサービス発見メカニズム。サービス実装インタフェースのためのメカニズムを見つけるために:そのようなメカニズムを提供するために、JavaのSPI。IOCは、組立工程の制御を越えて移動することで、この機構はモジュール設計において特に重要であるという考えに多少似ています。
SPIの特定の契約
次のようにJavaのSPIは、特定の契約です:ときにプロバイダのサービスのサービス・インターフェースを実装した後、META-INFのjarパッケージ/サービス/ディレクトリ中のサービス・インターフェースへの名前のファイルを作成します。文書には、サービス実装クラスのインタフェースの実現です。そして時に外部プログラムモジュール組立、設定ファイルの読み込みインスタンス化し、完全な注入モジュール内のjarパッケージのMETA-INF /サービス/の名前で特定のカテゴリを見つけるために。あなたは、コードを開発する必要なしに、サービス・インターフェースは、契約に基づいて実装するの良いクラスを見つけることができるようになります。JDKは、我々はサービスのインプリメンテーションツールを見つけるために提供しますjava.util.ServiceLoader
。
簡単な例
まず、インターフェイスクラスを提供IOperation
し、その2つの実装クラスをPlusOperationImpl
とDivisionOperationImpl
では、com.qhong.spi
このパッケージのパス。
package com.qhong.spi;
/**
* @author qhong
* @date 2020/3/22 0:16
**/
public interface IOperation {
int operation(int numberA, int numberB);
}
package com.qhong.spi;
/**
* @author qhong
* @date 2020/3/22 0:17
**/
public class PlusOperationImpl implements IOperation {
public PlusOperationImpl() {
System.out.println("plusOperation construct");
}
public int operation(int numberA, int numberB) {
System.out.println("Operation: plus");
return numberA + numberB;
}
}
package com.qhong.spi;
/**
* @author qhong
* @date 2020/3/22 0:17
**/
public class DivisionOperationImpl implements IOperation {
public DivisionOperationImpl() {
System.out.println("division construct");
}
@Override
public int operation(int numberA, int numberB) {
System.out.println("Operation: division");
return numberA / numberB;
}
}
新しいSPIプロフィール
/services/com.qhong.spi.IOperationを作成したフォルダやファイルのリソースの下で新META-INFフォルダ
テスト
public class testSPI {
public static void main(String[] args) {
ServiceLoader<IOperation> operations = ServiceLoader.load(IOperation.class);
int numberA = 6;
int numberB = 3;
System.out.println("NumberA: " + numberA + ", NumberB: " + numberB);
Iterator<IOperation> iterator = operations.iterator();
while (iterator.hasNext()) {
IOperation operation = iterator.next();
System.out.println(operation.operation(numberA, numberB));
}
}
}
出力:
NumberA: 6, NumberB: 3
division construct
Operation: division
2
plusOperation construct
Operation: plus
9
SPIの実装原理
アプリケーションはServiceLoader.loadメソッドを呼び出します
ServiceLoader.loadメソッド内では、などの新しいServiceLoaderを作成し、クラスのメンバ変数をインスタンス化します:
- クラスローダローダー(クラスローダー)
- AccessControlContextにACC(アクセス制御)
- LinkedHashMap <文字列、S>プロバイダ(成功したクラスのローディングバッファー)
- LazyIterator lookupIterator(イテレータ機能を実装)
アプリケーションは、反復子を介してオブジェクトのインスタンスを取得します
ServiceLoaderメンバ変数は、キャッシュ、直接のリターンがある場合、オブジェクトのキャッシュ・プロバイダーオブジェクトのインスタンスがあるかどうかを判断します。
ノーキャッシュ場合、実行クラスローディング:設定ファイルMETA-INFを読み取る/サービス/反射法により、Class.forNameの()ロードされたクラスのオブジェクトをすべてのクラスの名前を取得するためにインスタンス化、およびインスタンスで洗浄すること下()クラスのメソッドは、インスタンス化されます。プロバイダへのクラス・キャッシュは、オブジェクトとその後、リターンのオブジェクトのインスタンスをインスタンス化。
たとえば、JDBC
java.sql.DriverManager
private static void loadInitialDrivers() {
String drivers;
try {
drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
public String run() {
return System.getProperty("jdbc.drivers");
}
});
} catch (Exception ex) {
drivers = null;
}
// If the driver is packaged as a Service Provider, load it.
// Get all the drivers through the classloader
// exposed as a java.sql.Driver.class service.
// ServiceLoader.load() replaces the sun.misc.Providers()
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
Iterator<Driver> driversIterator = loadedDrivers.iterator();
try{
while(driversIterator.hasNext()) {
driversIterator.next();
}
} catch(Throwable t) {
// Do nothing
}
return null;
}
});
println("DriverManager.initialize: jdbc.drivers = " + drivers);
if (drivers == null || drivers.equals("")) {
return;
}
String[] driversList = drivers.split(":");
println("number of Drivers:" + driversList.length);
for (String aDriver : driversList) {
try {
println("DriverManager.Initialize: loading " + aDriver);
Class.forName(aDriver, true,
ClassLoader.getSystemClassLoader());
} catch (Exception ex) {
println("DriverManager.Initialize: load failed: " + ex);
}
}
}
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
java.util.ServiceLoader
public static <S> ServiceLoader<S> load(Class<S> service) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
return ServiceLoader.load(service, cl);
}
引用文
public static <S> ServiceLoader<S> load(Class<S> service,
ClassLoader loader)
{
return new ServiceLoader<>(service, loader);
}
引用文
private ServiceLoader(Class<S> svc, ClassLoader cl) {
service = Objects.requireNonNull(svc, "Service interface cannot be null");
loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
reload();
}
引用文
public void reload() {
providers.clear();
lookupIterator = new LazyIterator(service, loader);
}
引用文
private class LazyIterator
implements Iterator<S>
{
Class<S> service;
ClassLoader loader;
Enumeration<URL> configs = null;
Iterator<String> pending = null;
String nextName = null;
private LazyIterator(Class<S> service, ClassLoader loader) {
this.service = service;
this.loader = loader;
}
private boolean hasNextService() {
if (nextName != null) {
return true;
}
if (configs == null) {
try {
String fullName = PREFIX + service.getName();
if (loader == null)
configs = ClassLoader.getSystemResources(fullName);
else
configs = loader.getResources(fullName);
} catch (IOException x) {
fail(service, "Error locating configuration files", x);
}
}
while ((pending == null) || !pending.hasNext()) {
if (!configs.hasMoreElements()) {
return false;
}
pending = parse(service, configs.nextElement());
}
nextName = pending.next();
return true;
}
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
}
public boolean hasNext() {
if (acc == null) {
return hasNextService();
} else {
PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
public Boolean run() { return hasNextService(); }
};
return AccessController.doPrivileged(action, acc);
}
}
public S next() {
if (acc == null) {
return nextService();
} else {
PrivilegedAction<S> action = new PrivilegedAction<S>() {
public S run() { return nextService(); }
};
return AccessController.doPrivileged(action, acc);
}
}
public void remove() {
throw new UnsupportedOperationException();
}
}
ことに注意してくださいdriversIterator.next()
最終的に呼び出すことであるClass.forName(DriverName, false, loader)
方法を
フレーズのためClass.forName(DriverName, false, loader)
のクラスコードが存在するjava.util.ServiceLoader
クラス、そしてServiceLoader.class
彼らがBootrapLoaderをロードし、そのため必ずしもローダは、この時間だけTCCLを使用することができ、BootrapLoaderであり、それはTCCLをロードするために彼自身のクラスローダではないにforNameを渡すことはできません()(にThread.currentThreadにより取得し、単にああ浮気されます!)。またTCCLデフォルトの終わりについて話しました上記の記事は、現在、システムクラスローダAppClassLoaderのアプリケーションコードを実行しています。
表示するには、下に見えるServiceLoader.load(Class)
コードを
public static <S> ServiceLoader<S> load(Class<S> service) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
return ServiceLoader.load(service, cl);
}
必要性のいずれかの時点で、そう何のどこ現在のプログラム(BootstrapClassLoaderまたはExtClassLoaderなど)での問題では、スレッド内に配置されていない場合、それが実行されているのでContextClassloaderとデフォルトのストレージ参照がAppClassLoader、にThread.currentThreadを使用することができます()。 getContextClassLoader()操作を完了するためにアプリケーションクラスローダーのニーズを削除します。
ほとんどここSPIのメカニズムを説明します。ぶっきらぼうI(JDK)は限り、あなたは/ META-INFに書かれた(クラス名の規則に従うよう、助けあなたの(サードパーティの実装)(例えばデータベース駆動型、ログデータベースなど)のロードサービスの便利な方法を提供することであると言います年)は、私はすべてのjarパッケージ名は、契約を遵守し、スキャンしたい起動したときに、その後にforNameがロード呼び出すが、私のクラスローダがロードされていないこと、そして、TCCLで現在実行中のスレッドにロードフォローアップあなたはあなたのものである(静的コードブロックのクラスを実現するために、ドライブ)を操作する方法。
概要
JDKは、内蔵のSPIメカニズム自体多くの欠点があり、その利点を持っていますが、比較的簡単です。
利点
使用するJavaメカニズムを切り離す利点のSPIは、分離を達成するための定義インタフェースの特定のサービスは、一緒に結合されていないようなものです。または代わりに、実際の交通状況に応じてアプリケーション固有のコンポーネントを有効にすることができます。
短所
- これは、オンデマンドでロードすることはできません。ServiceLoaderであることを、唯一すべてトラバースすることにより取得遅延ロードが、基本的な缶に行われますが、インタフェースの実装クラスがロードされ、すべての繰り返しインスタンス化する必要があります。あなたが特定のクラスを達成したい、または特定のクラスのインスタンス化に時間がかかりれない場合は、また、廃棄物をもたらした、ロードおよびインスタンス化することができます。
- 実装クラスが柔軟ではない取得し、唯一のいくつかのパラメータに基づいて、対応する実装クラスを取得しないように、イテレータフォームを得ることができます。
- 複数の同時マルチスレッドServiceLoaderクラスの使用例としては、安全ではありません。
- ロードは例外ではなく、実装クラスのための本当の理由、見つけることが困難なエラーをスローしません。
SPIの多くの欠点を考えると、多くのシステムは、ダボとしての彼のクラスローディング機構を実現するために設定されています。また、ユーザーは複雑ではないを達成するためにクラスローダ+積載反射をカスタマイズすることができます。また、オープンソースのソリューションは、ローダークラスを持つJava用のプラグインフレームワーク(PF4J)とそうで。