[SpringBoot]深入浅出剖析SpringBoot中Spring Factories机制

发布时间:2020-08-07 14:00:13 作者:GitShare
来源:网络 阅读:12538

微信号:GitShare
微信公众号:爱折腾的稻草
如有问题或建议,请在公众号留言[1]

前续

为帮助广大SpringBoot用户达到“知其然,更需知其所以然”的境界,作者将通过SpringBoot系列文章全方位对SpringBoot2.0.0.RELEASE版本深入分解剖析,让您深刻的理解其内部工作原理。 

Java SPI机制
SpringBoot中的SPI机制

在Spring中也有一种类似与Java SPI的加载机制。它在META-INF/spring.factories文件中配置接口的实现类名称,然后在程序中读取这些配置文件并实例化。
这种自定义的SPI机制是Spring Boot Starter实现的基础。

Spring Factories实现原理

spring-core包里定义了SpringFactoriesLoader类,这个类实现了检索META-INF/spring.factories文件,并获取指定接口的配置的功能。
在这个类中定义了两个对外的方法:

1、loadFactories

根据接口类获取其实现类的实例,这个方法返回的是对象列表,其源代码:

public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {
    Assert.notNull(factoryClass, "'factoryClass' must not be null");
    ClassLoader classLoaderToUse = classLoader;
    if (classLoaderToUse == null) {
        classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
    }
    List<String> factoryNames = loadFactoryNames(factoryClass, classLoaderToUse);
    if (logger.isTraceEnabled()) {
        logger.trace("Loaded [" + factoryClass.getName() + "] names: " + factoryNames);
    }
    List<T> result = new ArrayList<>(factoryNames.size());
    for (String factoryName : factoryNames) {
        result.add(instantiateFactory(factoryName, factoryClass, classLoaderToUse));
    }
    AnnotationAwareOrderComparator.sort(result);
    return result;
}
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
    //获取到类名
    String factoryClassName = factoryClass.getName();
    //在当前ClassLoader下的所有META-INF/spring.factories文件的配置信息的Map中获取指定的factory的值,如果不存在,则返回空列表
    return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    //去缓存中获取对应的
    MultiValueMap<String, String> result = cache.get(classLoader);
    if (result != null)
        return result;
    try {
        //获取当前ClassLoader下的所有包含META-INF/spring.factories文件的URL路径
        Enumeration<URL> urls = (classLoader != null ?
                classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
        //初始返回对象
        result = new LinkedMultiValueMap<>();
        //遍历所有的包含META-INF/spring.factories文件URL集合
        while (urls.hasMoreElements()) {
            URL url = urls.nextElement();
            UrlResource resource = new UrlResource(url);
            //转换为Properties对象
            Properties properties = PropertiesLoaderUtils.loadProperties(resource);
            //遍历META-INF/spring.factories文件中的所有属性
            for (Map.Entry<?, ?> entry : properties.entrySet()) {
                //如果一个接口希望配置多个实现类,可以使用','进行分割,将当前Key对应的值转换为List
                List<String> factoryClassNames = Arrays.asList(StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));
                //添加到返回对象中
                result.addAll((String) entry.getKey(), factoryClassNames);
            }
        }
        //添加到缓存中
        cache.put(classLoader, result);
        //返回结果
        return result;
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load factories from location [" +
                FACTORIES_RESOURCE_LOCATION + "]", ex);
    }
}

我们可以在自己的jar中配置spring.factories文件,不会影响到其它地方的配置,也不会被别人的配置覆盖。
这一点非常有利于后期我们进行自定义扩展。

private static <T> instantiateFactory(String instanceClassName, Class<T> factoryClass, ClassLoader classLoader) {
    try {
        //根据类名获取类的实例,这个源码在上一篇中已经剖析过了。
        Class<?> instanceClass = ClassUtils.forName(instanceClassName, classLoader);
        //isAssignableFrom()是判断instanceClassName的对象是否是FactoryClass的子类或者相同的类,如果是返回true。
        if (!factoryClass.isAssignableFrom(instanceClass)) {
            //如果实例化的目标类不是Factory类的子类或者不是Factory类,则抛出异常
            throw new IllegalArgumentException("Class [" + instanceClassName + "] is not assignable to [" + factoryClass.getName() + "]");
        }
        //通过java反射机制,实例化目标类
        return (T) ReflectionUtils.accessibleConstructor(instanceClass).newInstance();
    }
    catch (Throwable ex) {
        throw new IllegalArgumentException("Unable to instantiate factory class: " + factoryClass.getName(), ex);
    }
}

从这段代码中我们可以知道,它只支持没有参数的构造方法。

2、loadFactoryNames

根据接口获取其接口类的名称,这个方法返回的是类名的列表,其源代码已经在上面分析过了。

SpringBoot启动时的应用

在SpringBoot启动过程中,创建SpringApplication对象是,有如下两行代码:

setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
Spring Factories机制的应用

在日常工作中,我们可能需要实现一些SDK或者Spring Boot Starter给被人使用,这个使用我们就可以使用Factories机制。
Factories机制可以让SDK或者Starter的使用只需要很少或者不需要进行配置,只需要在服务中引入我们的jar包。

知识点
public native boolean isAssignableFrom(Class<?> cls);

由方法签名可见是一个本地方法,即C代码编写的。  
其作用:  
有两个Class类型的类象,一个是调用isAssignableFrom方法的类对象(后称对象a),以及方法中作为参数的这个类对象(称之为对象b),这两个对象如果满足以下条件则返回true,否则返回false:

后记

为帮助广大SpringBoot用户达到“知其然,更需知其所以然”的境界,作者将通过SpringBoot系列文章全方位对SpringBoot2.0.0.RELEASE版本深入分解剖析,让您深刻的理解其内部工作原理。 敬请关注[爱折腾的稻草(GitShare)]公众号,为您提供更多更优质的技术教程。


[SpringBoot]深入浅出剖析SpringBoot中Spring Factories机制图注:爱折腾的稻草


推荐阅读:
  1. 小程序websocket人实现SpringMVC+Spring+Mybatis的方法
  2. Spring数据怎么在Java项目中进行单元配置

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

spring boot factor

上一篇:Spring框架功能模块构成及概念是什么

下一篇:git单独针对一个仓库实现子目录提交修改

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》