Spring Boot の SPI メカニズムの詳細な分析

一緒に創造し、成長するために一緒に働きましょう!「ナゲッツデイリー新プラン・8月アップデートチャレンジ」に参加して21日目、イベント詳細はこちら

序章

SPI (Service Provider Interface) は JDK に組み込まれたサービス プロバイダ ディスカバリ メカニズムであり、これを使用してフレームワークの拡張を有効にし、コンポーネントを置き換えることができます. 同じインターフェイスを異なるユーザーに提供するために異なる実装が使用されるため、フレームワークの拡張性が向上します.

Java SPI の実装

Java の組み込み SPI は、java.util.ServiceLoader クラスを使用して、classPath と、jar パッケージの META-INF/services/ ディレクトリ内のインターフェイスの完全修飾名で名前が付けられたファイルを解析し、指定されたインターフェイス実装クラスをロードします。ファイルで呼び出しを完了します。

例の説明

動的インターフェイスを作成する

public interface VedioSPI
{
    void call();
}

复制代码

実装クラス 1

public class Mp3Vedio implements VedioSPI
{
    @Override
    public void call()
    {
        System.out.println("this is mp3 call");
    }

}
复制代码

実装クラス 2

public class Mp4Vedio implements VedioSPI
{
    @Override
    public void call()
    {
       System.out.println("this is mp4 call");
    }

}
复制代码

プロジェクトのソース ディレクトリに新しい META-INF/services/ ディレクトリを作成し、com.skywares.fw.juc.spi.VedioSPI ファイルを作成します。

画像.png

関連するテスト

public class VedioSPITest
{
    public static void main(String[] args)
    {
        ServiceLoader<VedioSPI> serviceLoader =ServiceLoader.load(VedioSPI.class);
        
        serviceLoader.forEach(t->{
            t.call();
        });
    }
}
复制代码

説明: spi の Java 実装は、サービスを検索するために ServiceLoader によって提供されるツール クラスです。

操作結果:

画像.png

ソースコード分析

上記はjavaの組み込みSPI機能を実現する簡単な例です。実装原理は、ServiceLoader はサービス提供インターフェースを見つけるために使用される Java の組み込みツール クラスであり、load() メソッドを呼び出すことによってサービス提供インターフェースを検索し、最後にトラバースしてサービス提供の実装クラスにアクセスすることです。インターフェースを一つずつ。

画像.png

ソースコードから見つけることができます:

  • ServiceLoader クラス自体が Iterable インターフェースを実装し、反復子メソッドを実装します。反復子メソッドの実装は、内部クラス LazyIterator のメソッドを呼び出します。サービス提供のインターフェース ファイルを解析した後、最終結果は反復子で返されますが、これは実行されません。サポート サービス. インターフェイス実装クラスへの直接アクセスを提供します。

  • サービス プロバイダー インターフェイスの対応するすべてのファイルは META-INF/services/ ディレクトリに置かれ、最終的なタイプは PREFIX ディレクトリを変更できないことを決定します。

虽然java提供的SPI机制的思想非常好,但是也存在相应的弊端。具体如下:

  • Java内置的方法方式只能通过遍历来获取
  • 服务提供接口必须放到META-INF/services/目录下。

针对java的spi存在的问题,Spring的SPI机制沿用的SPI的思想,但对其进行扩展和优化。

Spring SPI

Spring SPI沿用了Java SPI的设计思想,Spring采用的是spring.factories方式实现SPI机制,可以在不修改Spring源码的前提下,提供Spring框架的扩展性。

Spring 示例

定义接口

public interface DataBaseSPI
{
   void getConnection();
}

复制代码

相关实现

#DB2实现
public class DB2DataBase implements DataBaseSPI
{
    @Override
    public void getConnection()
    {
        System.out.println("this database is db2");
    }

}

#Mysql实现
public class MysqlDataBase implements DataBaseSPI
{
    @Override
    public void getConnection()
    {
       System.out.println("this is mysql database");
    }

}
复制代码

1.在项目的META-INF目录下,新增spring.factories文件

画像.png

2.填写相关的接口信息,内容如下:

com.skywares.fw.juc.springspi.DataBaseSPI = com.skywares.fw.juc.springspi.DB2DataBase, com.skywares.fw.juc.springspi.MysqlDataBase
复制代码

说明多个实现采用逗号分隔。

相关测试类

public class SpringSPITest
{
    public static void main(String[] args)
    {
         List<DataBaseSPI> dataBaseSPIs =SpringFactoriesLoader.loadFactories(DataBaseSPI.class, 
                 Thread.currentThread().getContextClassLoader());
         
         for(DataBaseSPI datBaseSPI:dataBaseSPIs){
            datBaseSPI.getConnection();
         }
    }
}
复制代码

输出结果

画像.png

从示例中我们看出,Spring 采用spring.factories实现SPI与java实现SPI非常相似,但是spring的spi方式针对java的spi进行的相关优化具体内容如下:

  • Java SPI是一个服务提供接口对应一个配置文件,配置文件中存放当前接口的所有实现类,多个服务提供接口对应多个配置文件,所有配置都在services目录下;
  • Spring factories SPI是一个spring.factories配置文件存放多个接口及对应的实现类,以接口全限定名作为key,实现类作为value来配置,多个实现类用逗号隔开,仅spring.factories一个配置文件。

那么spring是如何通过加载spring.factories来实现SpI的呢?我们可以通过源码来进一步分析。

源码分析

画像.png

说明:loadFactoryNames解析spring.factories文件中指定接口的实现类的全限定名,具体实现如下:

画像.png説明: すべての jar パッケージの META-INF/spring.factories のファイル パスを取得し、それらを列挙値として返します。spring.factories ファイルのパスをたどり、1 つずつロードして解析し、factoryClass 型の実装クラスの名前を統合し、実装クラスの完全なクラス名を取得してから、クラスのインスタンス操作を実行します。関連するソースコードは次のとおりです。

画像.png

説明: インスタンス化とは、リフレクションを通じて対応する初期化を実現することです。

要約する

この記事では、Java と Spring の SPI メカニズムについて詳しく説明します. SPI テクノロジは、サービス インターフェイスをサービス実装から分離してデカップリングを実現し、それによってプログラムのスケーラビリティを向上させます。ご不明な点がございましたら、お気軽にフィードバックをお寄せください。

おすすめ

転載: juejin.im/post/7132742686099898398