記事のディレクトリ
シニアJava開発者は、SPIのメカニズムを理解する必要があります
分析を通じて、JDKが提供する、より一般的に使用されているJava SPI機構では、オープンソースプロジェクトは、我々はオープンソースプロジェクトは、リファレンスを提供し学習、実際に開発したいと考えています。
1つのSPIとは何ですか
SPIのフルサービスプロバイダインタフェース、Javaが第三者によって実装または拡張APIのセットを提供するために使用され、アセンブリと交換フレームを有効にするために拡張することができます。
次のように全体のメカニズムは次のとおりです。
JavaのSPI実際「インターフェースベースのプログラミングモード+戦略+設定ファイルの組み合わせを達成するための動的ローディング機構」。
多くの場合、多くの異なる実装、オブジェクト指向設計を有する、抽象様々なシステム設計、クラス間のインターフェースモジュールとの間に実装されていないハードコーディングされたベースのプログラミングは、一般的に、モジュールをお勧めします。特定のカテゴリに関連するコードと、それはあなたが、実装を交換する必要がある場合は、コードを変更する必要があり、プラグイン可能なの原則に違反します。プログラムを達成するためにサービス発見メカニズムを必要とする、モジュールアセンブリの動的時間で指定することができません。
サービス実装インタフェースのためのメカニズムを見つけるために:そのようなメカニズムを提供するために、JavaのSPI。IOCは、組立工程の制御を越えて移動することで、この機構はモジュール設計において特に重要であるという考えに多少似ています。だから、SPIの核となるアイデアはあるにデカップル。
2利用シーン
:大まかに適用される、話す実装戦略のフレームワークを拡張または交換、有効化、実際のニーズに応じて、発信者
より一般的な例:
- ロードデータベースドライバインタフェースクラスのロード
データベースのJDBCドライバのロード異なる種類 - ログファサードインタフェースクラスローダ
SLF4Jロギング実装クラスのロード異なるプロバイダ - スプリング
SPIの春広範な使用、例えば:ServletContainerInitializerのservlet3.0仕様の実現、自動型変換タイプ変換SPI(コンバータSPI、フォーマッタ SPI) 、等 - ダボ
ダボSPIフレームの拡張を達成するためにも広く使用されている方法、それは、ユーザーがインターフェイス実装フィルタを拡張することができ、JavaのネイティブSPI製パッケージを提供します
3使用はじめに
JavaのSPIを使用するには、次の規則に従ってくださいする必要があります。
- ;サービスプロバイダは、コンテンツクラスの完全修飾名を達成するために、META-INFのjarパッケージ/ servicesディレクトリにという名前として「インタフェースの完全修飾名」を持つファイルを作成した後、インタフェースの特定の実装を提供します1、
- 図2に示すように、パケットベースのインタフェースクラスパスメインプログラムでJAR。
- 3、動的な負荷がメインプログラムモジュールjava.util.ServiceLoderによって達成され、それがスキャンMETA-INF / servicesディレクトリ内の設定ファイルで実装クラスの完全修飾名を見つけ、クラスがJVMにロードされます。
- 4、SPI実装クラスは、引数なしのコンストラクタを運ぶ必要があります。
サンプルコード
ステップ1、org.foo.demo.animal.Dog、org.foo.demo.animalを仮定すると(、インターフェイス(org.foo.demo.IShoutと仮定して)のセットを定義し、インターフェイスの1つ以上の実施を書き込みます.cat)。
public interface IShout {
void shout();
}
public class Cat implements IShout {
@Override
public void shout() {
System.out.println("miao miao");
}
}
public class Dog implements IShout {
@Override
public void shout() {
System.out.println("wang wang");
}
}
ステップ2、インターフェイスファイル(org.foo.demo.IShoutファイル)への/ META-INF /新しい名前の下のsrc /メイン/リソース/中servicesディレクトリを確立し、コンテンツのクラスを達成するために適用される(ここではORG .foo.demo.animal.Dogとorg.foo.demo.animal.Cat、ライン型に1つ)。
ファイルの場所
- src
-main
-resources
- META-INF
- services
- org.foo.demo.IShout
ファイルの内容
org.foo.demo.animal.Dog
org.foo.demo.animal.Cat
ステップ3 ServiceLoaderを使用しては、指定された設定ファイルをロードするために実装しました。
public class SPIMain {
public static void main(String[] args) {
ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
for (IShout s : shouts) {
s.shout();
}
}
}
コード出力:
wang wang
miao miao
4分析の原則
クラスのメンバ変数の署名ServiceLoaderクラスで最初に見て:
public final class ServiceLoader<S> implements Iterable<S>{
private static final String PREFIX = "META-INF/services/";
// 代表被加载的类或者接口
private final Class<S> service;
// 用于定位,加载和实例化providers的类加载器
private final ClassLoader loader;
// 创建ServiceLoader时采用的访问控制上下文
private final AccessControlContext acc;
// 缓存providers,按实例化的顺序排列
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 懒查找迭代器
private LazyIterator lookupIterator;
......
}
次のように処理を実現するためのソートビットアウト587コメント行の合計特定のソースコードボリュームにServiceLoaderの特定の参照は、、、です。
- 1 ServiceLoader.loadアプリケーションは、メソッドを呼び出して
新しいServiceLoaderを作成するために、ServiceLoader.loadメソッド内で、クラスのメンバ変数をインスタンス化し、含みます:- ローダー(クラスローダタイプ、クラスローダ)
- ACC(のAccessControlContextタイプ、アクセス・コントローラ)
- プロバイダ(のLinkedHashMap <文字列、S>タイプ、正常にロードされたクラスをキャッシュします)
- lookupIterator(イテレータ機能を実装)
- アプリケーションインターフェースを介して2イテレータオブジェクトインスタンス取得する
オブジェクトのキャッシュされたインスタンスかどうかを最初に決定ServiceLoaderオブジェクトメンバ変数プロバイダ(のLinkedHashMap <文字列、S>型)、キャッシュが存在する場合、ダイレクトリターン。
キャッシュは、エグゼクティブクラスをロードされていない場合は、次のように実装: - (1)は、すべてのクラスの名前を取得するためにインスタンス化され、下に、それは注目に値する/ ServiceLoader META-INF /プロファイル・サービスを読み取るMETA内のJARパケット取得プロファイル-INF横切って、負荷の特定の構成を次のようにコードは次のとおりです。
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);
}
- クラスインスタンスのクラスオブジェクトと使用インスタンス()メソッドをロードするための反射法により(2)にClass.forName()。
- インスタンス化オブジェクトクラスキャッシュプロバイダ(のLinkedHashMap <文字列、S>型)の後(3)
と、オブジェクトのインスタンスを返します。
5まとめ
利点:
JavaのSPIデカップリング機構を使用することの利点は、個別論理そのような発信者、第三者サービス制御モジュールのサービスコードがアセンブリ、一緒に結合されていないこと。アプリケーションは、実際の交通状況に応じて組み立てたフレームのフレームを有効にするために拡張または交換することができます。
短所:
- ServiceLoader遅延ロードを使用するためと考えられますが、すべては基本的にのみすべてやり直す負荷およびインスタンス化するために、インタフェースの実装クラスである歩行によって取得することができますが。あなたには、いくつかの実装クラスを使用したくない場合は、廃棄物をもたらした、ロードされ、インスタンス化されます。実装クラスが柔軟ではない取得し、唯一のいくつかのパラメータに基づいて、対応する実装クラスを取得しないように、イテレータフォームを得ることができます。
- 複数の同時マルチスレッドServiceLoaderクラスの使用例としては、安全ではありません。
JavaのSPIメカニズムで、春-MVC開始とservlet3.0
主要なJavaのクラスローディング機構、servlet3.0新機能、Javaの-SPIの仕組みの見直しだけでなく、初期化と、スプリングMVCのロード。
SpringMVC初期化
私は春とspringMVCを使用した場合の前に、リスナー内のweb.xmlで定義されているorg.springframework.web.context.ContextLoaderListener
春を初期化し、サーブレットがorg.springframework.web.servlet.DispatcherServlet
springMVCを初期化するために使用されます。
私が見たDispatcherServlet
DispatcherServletの初期化時間を示すように、ソースコードの初期化処理、WebApplicationInitializerを作成します。三つの左は、継承です。
WebApplicationContext和ApplicationContext有什么不同呢? 前者实现了后者,我们可以配置多个servlet对应不同的mapping,每个servlet会对应一个WebApplicationContext(wac),但是ApplicationContext(ac)只有一个,wac之间可以共享ac里面配置的bean,如共享数据源,缓存等,而且如果不需要这些配置,ac也不是必须的。ac和wc是一个parent-child的层级关系。
随着servlet3.0的到来,web.xml也不是必须的了,我们可以定义一个WebApplicationInitializer
来初始化一个WebApplicationContext,下面我讲讲WebApplicationInitializer
的加载机制
看下面介绍的<a href="#ServletContext的性能增强"">servlet3对ServletContext的增强可以知道,javaee容器在启动的时候会通过spi机制来寻找javax.servlet.ServletContainerInitializer
的实现类,在spring-web
jar包,如下图所示
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
@Override
public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
throws ServletException {
List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();
if (webAppInitializerClasses != null) {
for (Class<?> waiClass : webAppInitializerClasses) {
// Be defensive: Some servlet containers provide us with invalid classes,
// no matter what @HandlesTypes says...
if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
try {
initializers.add((WebApplicationInitializer) waiClass.newInstance());
}
...
}
SpringServletContainerInitializer
的onStartup()方法里面有如下一段注释
Because this class declares @HandlesTypes(WebApplicationInitializer.class), Servlet 3.0+ containers will automatically scan the classpath for implementations of Spring’s WebApplicationInitializer interface and provide the set of all such types to the webAppInitializerClasses parameter of this method.
因为这个类@HandlesTypes注解的是WebApplicationInitializer.class
,Servlet3.0容器会自动的扫描classpath下面WebApplicationInitializer
接口的实现类,并提供给SpringServletContainerInitializer
的onStartup()方法
SPI机制
SPI的全名是Service Provider Interface,在java.util.ServiceLoader里面有比较详细的介绍。
如jdk提供了java.sql.Driver
接口,我们将oracle的驱动包丢入classpath
驱动包目录结构如下,在/META-INF/services/java.sql.Driver
文件中有一行内容,
oracle.jdbc.Driver
如下代码jdk提供了服务实现的一个工具类,,所以通过这种方式就没必要写来加载驱动了
ServiceLoader<Driver> d= ServiceLoader.load(Driver.class);
Iterator<Driver> it = d.iterator();
while(it.hasNext()){
Driver dd =it.next();
System.out.println(dd.toString());//oracle.jdbc.OracleDriver@498e2a42
}
查看ServiceLoader
源码可知,他使用的类加载器是线程上下文类加载器
public static <S> ServiceLoader<S> load(Class<S> service) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
return ServiceLoader.load(service, cl);
}
服务的提供者,提供了服务的接口实现之后,在jar包的META-INF/services/
下面创建一个以服务接口命名的文件,文件内容是提供着实现的接口实现类。
API 和 SPI的区别
API(Application Programming Interface )。在java中,我们使用java提供的很多类、类的方法、数据结构来编写我们的应用程序,最终完成我们需求的程序功能,这里的类、方法、数据结构即是jdk提供的api。api的意义,其实就是这些提供给你完成某项功能的类、接口或者方法。
而SPI(Service Provider Interface)是指一些提供给你继承、扩展,完成自定义功能的类、接口或者方法。
Servlet3.0新特性
目前servlet4还正在开发过程中,目前最新的应该就是3了,最新的spring也用到了很多servlet3.0的特性,所以很有必要了解一下。
新特性概述:
- 异步处理支持,之前是servlet一直阻塞直到业务完成,现在可以将耗时任务委派给另外一个线程处理,自己不生成相应的情况下返回到容器
- 新增注解,简化servlet、filter、listener,所以可以无需配置web.xml
- 可插件支持,类似于开发应用时,将jar包放入classpath
异步处理支持
在web.xml配置<async-supported>true</async-supported>
或者在注解里面添加asyncSupported = true
新增注解支持
@WebServlet
声明一个类为servlet,注解在部署时被容器自动处理
WebInitParam
通常配合@WebServlet和@WebFilter使用,类似于web.xml里面的<init-param>
标签,指定初始化参数
WebFilter
声明一个类为过滤器
WebListener
声明一个类为监听器,该类必须实现如下最少一个接口
- ServletContextListener
- ServletContextAttributeListener
- ServletRequestListener
- ServletRequestAttributeListener
- HttpSessionListener
- HttpSessionAttributeListener
@MultipartConfig
该注解主要是为了辅助 Servlet 3.0 中 HttpServletRequest 提供的对上传文件的支持。
可插性支持
以配置servlet为例,有三种方式
- 最原始的在web.xml里面配置servlet
- 使用servlet3.0的@WebServlet注解
- 利用可插性,将类继承HttpServlet,然后打成jar包,在jar包的META-INF里面放置一个 web-fragment文件,在文件中声明Servlet配置
我觉得spring可能就是利用了可插性,等有时间验证一下。
ServletContext的性能增强
支持运行时,动态的部署servlet、过滤器、监听器,通过ServletContext
的方法实现。
ServletContainerInitializer
也是 Servlet 3.0 新增的一个接口,容器在启动时使用SPI来发现 ServletContainerInitializer 的实现类,并且容器将 WEB-INF/lib 目录下 JAR 包中的类都交给该类的 onStartup() 方法处理,我们通常需要在该实现类上使用 @HandlesTypes 注解来指定希望被处理的类,过滤掉不希望给 onStartup() 处理的类。
Implementations of this interface must be declared by a JAR file resource located inside the META-INF/services directory and named for the fully qualified class name of this interface
这个接口的实现必须打包在一个jar文件里面,并且需要在META-INF/services/
通过spi来定义
类加载器
Java源程序经过java编译器编译之后转换成Java字节码,类加载器负责读取Java字节码转换成java.lang.Class类的一个实例,通过实例的new Instance()方法可以创建出该类的一个对象。
系统提供的类加载器
- 引导类加载器(bootstrap class loader):它用来加载 Java 的核心库,是用原生代码来实现的,并不继承自 java.lang.ClassLoader。
- 扩展类加载器(extensions class loader):它用来加载 Java 的扩展库。Java 虚拟机的实现会提供一个扩展库目录。该类加载器在此目录里面查找并加载 Java 类。
- 系统类加载器(system class loader):它根据 Java 应用的类路径(CLASSPATH)来加载 Java 类。一般来说,Java 应用的类都是由它来完成加载的。可以通过 ClassLoader.getSystemClassLoader()来获取它。
加载类的过程
每个java类维护着一个指向它的类加载器的引用,可以通过getClassLoader()来获取。
下面是类加载器的层级关系
Java虚拟机判定两个类相同,不仅要看类的全名是否相同,还要看加载类的类加载器是否相同。 在的方法里面有下面的代码,类加载器首先代理给父加载器来尝试加载。所以,真正完成类加载的类加载器(defining loader)可能和启动这个加载过程的类加载器(initiating loader)不是同一个。真正完成类加载工作是通过defineClass实现,启动类加载过程是通过loadClass实现。一个类的定义加载器是它引用的其他类的初始加载器。
// 根据名称来加载类
protected Class<?> loadClass(String name, boolean resolve)
throws ClassNotFoundException {
...
try {
if (parent != null) {
c = parent.loadClass(name, false);
} else {
c = findBootstrapClassOrNull(name);
}
} catch (ClassNotFoundException e) {
// ClassNotFoundException thrown if class not found
// from the non-null parent class loader
}
...
}
// 根据类的字节码加载类
protected final Class<?> defineClass(String name, byte[] b, int off, int len,
ProtectionDomain protectionDomain)
throws ClassFormatError{}
线程上下文类加载器
Thread.currentThread().getContextClassLoader()
context class loader,java应用运行的初始线程上下文加载器是系统类加载器,在线程中运行的代码可以通过此类加载器加载。
例子
SPI机制核心库提供了JDBC的接口,由引导类加载器加载,而JDBC的SPI实现类通常定义在第三方驱动包一般由系统类加载器加载,引导类加载器通过代理无法加载驱动包。所以这种情况就可以通过线程上下文类加载器来加载。
类加载器与web应用
对于运行在 Java EE的web应用来说,每个web应用都会有一个对应的类加载器实例,该类加载器也使用代理模式,不同的是它会首先尝试加载某个类,如果找不到再代理给父类加载器。与一般类加载器相反,这是Servlet规范推荐做法,目的是使Web应用自己的类优先级高于Web容器提供的类。
SPI机制在servlet3.0中的应用
1、spi简单说明
spi,即service privider interface,是jdk为厂商和插件提供的一种解耦机制。
spi的具体规范为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并通过反射机制实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader
2、spring-web中的具体应用
从servlet3.0开始,web容器启动时为提供给第三方组件机会做一些初始化的工作,例如注册servlet或者filtes等,servlet规范中通过ServletContainerInitializer实现此功能。每个框架要使用ServletContainerInitializer就必须在对应的jar包的META-INF/services 目录创建一个名为javax.servlet.ServletContainerInitializer的文件,文件内容指定具体的ServletContainerInitializer实现类,那么,当web容器启动时就会运行这个初始化器做一些组件内的初始化工作。
一般伴随着ServletContainerInitializer一起使用的还有HandlesTypes注解,通过HandlesTypes可以将感兴趣的一些类注入到ServletContainerInitializerde的onStartup方法作为参数传入。
spring-web的jar定义了一个具体的实现类,SpringServletContainerInitializer,并且在META-INF/services/目录下定义了如下文件:
文件的具体的内容为:org.springframework.web.SpringServletContainerInitializer。
3、SpringServletContainerInitializer
通过源码发现,配合注解@HandlesTypes它可以将其指定的Class对象作为参数传递到onStartup方法中。进而在onStartup方法中获取Class对象的具体实现类,进而调用实现类中的具体方法。SpringServletContainerInitializer类中@HandlesTypes指定的是Class对象是WebApplicationInitializer.Class。
利用这个机制,若实现WebApplicationInitializer这个接口,我们就可以自定义的注入Servlet,或者Filter,即可以不再依赖web.xml的配置。
4.tomcat启动时webConfig() 的调用链:
Tomcat.start()->各种代理的start()->org.apache.catalina.core.StandardContext.startInternal->LifecycleBase.fireLifecycleEvent->org.apache.catalina.startup.ContextConfig.lifecycleEvent->configureStart->webConfig
5.@HandlesTypes的实现原理:
首先这个注解最开始令我非常困惑,他的作用是将注解指定的Class对象作为参数传递到onStartup(ServletContainerInitializer)方法中。
然而这个注解是要留给用户扩展的,他指定的Class对象并没有要继承ServletContainerInitializer,更没有写入META-INF/services/的文件(也不可能写入)中,那么Tomcat是怎么扫描到指定的类的呢。
答案是Byte Code Engineering Library (BCEL),这是Apache Software Foundation 的Jakarta 项目的一部分,作用同ASM类似,是字节码操纵框架。
webConfig() 在调用processServletContainerInitializers()时记录下注解的类名,然后在Step 4和Step 5中都来到processAnnotationsStream这个方法,使用BCEL的ClassParser在字节码层面读取了/WEB-INF/classes和某些jar(应该可以在叫做fragments的概念中指定)中class文件的超类名和实现的接口名,判断是否与记录的注解类名相同,若相同再通过org.apache.catalina.util.Introspection类load为Class对象,最后保存起来,于Step 11中交给org.apache.catalina.core.StandardContext,也就是tomcat实际调用
ServletContainerInitializer.onStartup()的地方。
参考文章:
https://www.jianshu.com/p/46b42f7f593c
https://www.jianshu.com/p/bd36c023ddf0
https://blog.csdn.net/pingnanlee/article/details/80940993
https://www.cnblogs.com/feixuefubing/p/11593411.html