cn.hutool.core.util.ServiceLoaderUtil Maven / Gradle / Ivy
package cn.hutool.core.util;
import cn.hutool.core.collection.ListUtil;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;
/**
* SPI机制中的服务加载工具类，流程如下
*
*
* 1、创建接口，并创建实现类
* 2、ClassPath/META-INF/services下创建与接口全限定类名相同的文件
* 3、文件内容填写实现类的全限定类名
*
* 相关介绍见：https://www.jianshu.com/p/3a3edbcd8f24
*
* @author looly
* @since 5.1.6
*/
public class ServiceLoaderUtil {
/**
* 。加载第一个可用服务，如果用户定义了多个接口实现类，只获取第一个不报错的服务
*
* @param 接口类型
* @param clazz 服务接口
* @return 第一个服务接口实现对象，无实现返回{@code null}
*/
public static T loadFirstAvailable(Class clazz) {
final Iterator iterator = load(clazz).iterator();
while (iterator.hasNext()) {
try {
return iterator.next();
} catch (ServiceConfigurationError ignore) {
// ignore
}
}
return null;
}
/**
* 加载第一个服务，如果用户定义了多个接口实现类，只获取第一个。
*
* @param 接口类型
* @param clazz 服务接口
* @return 第一个服务接口实现对象，无实现返回{@code null}
*/
public static T loadFirst(Class clazz) {
final Iterator iterator = load(clazz).iterator();
if (iterator.hasNext()) {
return iterator.next();
}
return null;
}
/**
* 加载服务
*
* @param 接口类型
* @param clazz 服务接口
* @return 服务接口实现列表
*/
public static ServiceLoader load(Class clazz) {
return load(clazz, null);
}
/**
* 加载服务
*
* @param 接口类型
* @param clazz 服务接口
* @param loader {@link ClassLoader}
* @return 服务接口实现列表
*/
public static ServiceLoader load(Class clazz, ClassLoader loader) {
return ServiceLoader.load(clazz, ObjectUtil.defaultIfNull(loader, ClassLoaderUtil::getClassLoader));
}
/**
* 加载服务 并已list列表返回
*
* @param 接口类型
* @param clazz 服务接口
* @return 服务接口实现列表
* @since 5.4.2
*/
public static List loadList(Class clazz) {
return loadList(clazz, null);
}
/**
* 加载服务 并已list列表返回
*
* @param 接口类型
* @param clazz 服务接口
* @param loader {@link ClassLoader}
* @return 服务接口实现列表
* @since 5.4.2
*/
public static List loadList(Class clazz, ClassLoader loader) {
return ListUtil.list(false, load(clazz, loader));
}
}