Java隐藏技-ServiceLoaderServiceL

这是我参与8月更文挑战的第7天,活动详情查看:8月更文挑战

ServiceLoader使用介绍

Java SE 6 平台提供一个新的 API,可以帮助查找、加载和使用服务提供程序。
其实,从 Java 平台的 1.3 版本开始, java.util.ServiceLoader类就已经悄悄存在了,但它在 Java SE 6 中才成为了一个公共 API。

1. 是什么

ServiceLoader类用于在应用程序的类路径(classPath)或运行时环境的扩展目录(java.ext.dirs)中搜索服务提供程序。
它加载这些服务并给程序使用,如何新的扩展加入进来,ServiceLoader就可以找到它们,在知道接口的情况下,可以找到并使用该接口的各种实现。

2. 如何使用

从官方的文档来说,它主要是用来装载一系列的service provider。而且ServiceLoader可以通过service provider的配置文件来装载指定的service provider
看完这段话,还是比较懵,开始上示例吧。我们定义两个MessageService接口,如下:

public interface MessageService {
    String getMessage();
}
复制代码

有如下两种实现
RawMessage如下实现:

package com.test.raw;
import com.test.service.MessageService;
public class RawMessage implements MessageService {
    public String getMessage() {
        return "Raw message";
    }
}
复制代码

FormattedMessage如下实现:

package com.test.format;

import com.test.service.MessageService;

public class FormattedMessage implements MessageService {
    public String getMessage() {
        return "Formatted message";
    }
}
复制代码

在原来代码的目录下面创建一个META-INF/services的目录,并创建一个com.test.service.MessageService的文件。文件名必须和我们前面定义的MessageService类的全名一样,内容如下:

com.test.raw.RawMessage
com.test.format.FormattedMessage
复制代码

加载所有服务并使用:

public class MessageConsumer {
	public static void main(String[] args) {
		ServiceLoader<MessageService> serviceLoader = ServiceLoader.load(MessageService.class);
		for(MessageService service : serviceLoader) {
			System.out.println(service.getMessage());
		}
	}
}
复制代码

运行结果:

Raw message
Formatted message
复制代码

像不像依赖注入的一个简单实现?我们通过配置文件可以提供一些特定的类给使用程序。
当然,这里针对ServiceLoader还有一个特定的限制,就是我们提供的这些具体实现的类必须提供无参数的构造函数,否则ServiceLoader就会报错。

项目中使用的例子

 try {
        FrameworkFactory frameworkFactory = ServiceLoader.load(FrameworkFactory.class).iterator().next();
        ...
     } catch (BundleException e) {
        ...
     }
复制代码

3. 一些限制

ServiceLoader API 很有用处,但是它有一些限制。

  • 不能继承 ServiceLoader,所以也无法修改其行为。

您可以使用自定义的 ClassLoader 子类来改变找到类的方式,但是无法扩展 ServiceLoader 本身。

  • 当运行时有新的提供程序可用时,当前的 ServiceLoader 类不会告诉应用程序。
    同时,您无法通过添加变化监听器给加载程序,来发现是否有新的提供程序被放到特定于应用程序的扩展目录中。