SpringBoot自动装配原理探索

环境

JDK 17
Springboot 2.7

在了解Spring boot自动装配原理之前，需要了解两个很重要的知识点Java SPI机制和Spring的Import注解，把这两个重要的点理解清楚之后就很容易理解Spring boot的自动装配原理了，并且能很好的应用到实际项目中。

JDK实现

SPI ，全称为 Service Provider Interface(服务提供者接口)，是一种服务发现机制。它通过在classpath路径下的META-INF/services文件夹查找文件，自动加载文件中所定义的类。

自己编码实现

1.新建一个接口类Anima

package com.wxy97.springbootstudy.demo;

public interface Anima {
    void call();
}

2.新建一个Cat类实现Anima接口

SPI的实现类必须携带一个无参构造方法

package com.wxy97.springbootstudy.demo;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 08:49:00
 */
public class Cat implements Anima {
    @Override
    public void call() {
        System.out.println("喵喵喵");
    }
}

3.新建一个Dog类实现Anima接口

package com.wxy97.springbootstudy.demo;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 08:49:00
 */
public class Dog implements Anima {
    @Override
    public void call() {
        System.out.println("汪汪汪");
    }
}

4.写配置文件实现自动装配

classpath下新建META-INF/services文件夹

创建文件com.wxy97.springbootstudy.demo.Anima

接口的全限定类名就是文件名

编辑文件，写入两个实现类全路径

com.wxy97.springbootstudy.demo.Cat
com.wxy97.springbootstudy.demo.Dog

5.Main方法测试

package com.wxy97.springbootstudy.demo;

import java.util.ServiceLoader;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 08:51:00
 */
public class Main {
    public static void main(String[] args) {
        ServiceLoader<Anima> load = ServiceLoader.load(Anima.class);
        load.forEach(anima -> {
            anima.call();
        }); // 打印出汪汪汪和喵喵喵
    }
}

ServiceLoader探索

通过该过程可以了解到SPI是面向接口编程，不关注接口的具体实现，由配置文件配置具体要实例化的厂商接口。JDK也提供了具体的实现，我们一起来看看ServiceLoader是如何实现的，通过load方法跟入JDK源码（以下只列出核心代码）。

打开ServiceLoader类

load方法

    @CallerSensitive
    public static <S> ServiceLoader<S> load(Class<S> service) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return new ServiceLoader<>(Reflection.getCallerClass(), service, cl);
    }

@CallerSensitive
当检查权限时``Reflection.getCallerClass()会跳过ServiceLoader类，直接获取原始调用者的对象，进行权限判断。比如线程1--->反射1--->反射2，当反射2检查权限时，会检查到反射1，而不是真正的线程1的调用权限。这个是解决黑客利用双反射来绕过权限，获得资源。所以后面JVM对标注@CallerSensitive`的类会跳过，来到没有这个注解类的位置,来获取真正的权限。
Thread.currentThread().getContextClassLoader
没有loader传入，就会返回线程的ContextClassLoader，每当创建一个线程时，就会继承父线程classLoader，创建一个ContextClassLoader，需要被显示的调用，否则永远不会被使用。main线程的getContextClassLoader就是SystemClassloader

找到hasNextService方法

 @SuppressWarnings("unchecked")
        private boolean hasNextService() {
            while (nextProvider == null && nextError == null) {
                try {
                    Class<?> clazz = nextProviderClass();
                    if (clazz == null)
                        return false;

                    if (clazz.getModule().isNamed()) {
                        // ignore class if in named module
                        continue;
                    }

                    if (service.isAssignableFrom(clazz)) {
                        Class<? extends S> type = (Class<? extends S>) clazz;
                        Constructor<? extends S> ctor
                            = (Constructor<? extends S>)getConstructor(clazz);
                        ProviderImpl<S> p = new ProviderImpl<S>(service, type, ctor, acc);
                        nextProvider = (ProviderImpl<T>) p;
                    } else {
                        fail(service, clazz.getName() + " not a subtype");
                    }
                } catch (ServiceConfigurationError e) {
                    nextError = e;
                }
            }
            return true;
        }

可以看出调用了nextProviderClass这个方法从方法名大概可以看出是找到下一个提供者

找到nextProviderClass这个方法

        /**
         * Loads and returns the next provider class.
         */
        private Class<?> nextProviderClass() {
            if (configs == null) {
                try {
                    String fullName = PREFIX + service.getName();
                    if (loader == null) {
                        configs = ClassLoader.getSystemResources(fullName);
                    } else if (loader == ClassLoaders.platformClassLoader()) {
                        // The platform classloader doesn't have a class path,
                        // but the boot loader might.
                        if (BootLoader.hasClassPath()) {
                            configs = BootLoader.findResources(fullName);
                        } else {
                            configs = Collections.emptyEnumeration();
                        }
                    } else {
                        configs = loader.getResources(fullName);
                    }
                } catch (IOException x) {
                    fail(service, "Error locating configuration files", x);
                }
            }
            while ((pending == null) || !pending.hasNext()) {
                if (!configs.hasMoreElements()) {
                    return null;
                }
                pending = parse(configs.nextElement());
            }
            String cn = pending.next();
            try {
                return Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
                fail(service, "Provider " + cn + " not found");
                return null;
            }
        }

看到方法头部注释:加载并返回下一个提供者类

String fullName = PREFIX + service.getName();

configs = ClassLoader.getSystemResources(fullName);

加载资源文件路径前缀是

static final String PREFIX = "META-INF/services/";

Set<String> providerNames = new HashSet<>(); // 避免服务提供者重复

不足：

不能按需加载，需要遍历配置文件中所有的实现并实例化。
不能很直接的获取某个实例化对象，只能通过迭代的形式获取。

Spring中的@Import

在Spring中类似于@Component，@Bean，@EnableXxxxx 这样的注解肯定见过吧，

比如：EnableAsync开启异步，EnableTransactionManagement开启事务

点击去发现里面是Import注解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({AsyncConfigurationSelector.class})
public @interface EnableAsync {
    Class<? extends Annotation> annotation() default Annotation.class;

    boolean proxyTargetClass() default false;

    AdviceMode mode() default AdviceMode.PROXY;

    int order() default Integer.MAX_VALUE;
}

Import注解的3种使用方式

1.普通的组件

新建一个类Car

package com.wxy97.springbootstudy.demoImport;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 09:50:00
 */
public class Car {
    public Car() {
        System.out.println("Car is Init");
    }
}

新建一个类CarMainConf

package com.wxy97.springbootstudy.demoImport;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 09:51:00
 */
@Import(Car.class)
@Configuration
public class CarMainConf {

}

启动项目打印 “Car is Init”

2.实现`ImportSelector`接口

新建类Boy

package com.wxy97.springbootstudy.demoImport;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 09:55:00
 */
public class Boy {
    public Boy() {
        System.out.println("boy is Init");
    }
}

新建类MyImport实现ImportSelector 接口重新方法selectImports

package com.wxy97.springbootstudy.demoImport;

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 09:56:00
 */
public class MyImport implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.wxy97.springbootstudy.demoImport.Boy"};
    }
}

新建类BoyMainConf

package com.wxy97.springbootstudy.demoImport;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 09:57:00
 */
@Import(MyImport.class)
@Configuration
public class BoyMainConf {
}

启动项目打印 “boy is Init”

这种方式往Spring中注入的是一个ImportSelector，当Spring扫描到MyImport，将会调用selectImports方法，将selectImports中返回的String数组中的类注入到容器中。

3.实现`ImportBeanDefinitionRegistrar`接口

新建类Girl

package com.wxy97.springbootstudy.demoImport;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 10:00:00
 */
public class Girl {
    public Girl() {
        System.out.println("girl is Init");
    }
}

新建类MyImportBeanDefinitionRegistrar 实现MyImportBeanDefinitionRegistrar接口得registerBeanDefinitions方法

package com.wxy97.springbootstudy.demoImport;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 10:01:00
 */
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        BeanDefinition beanDefinition = new RootBeanDefinition(Girl.class);
        registry.registerBeanDefinition("my-girl", beanDefinition);
    }
}

新建类GirlMainConf

package com.wxy97.springbootstudy.demoImport;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

/**
 * @author wxy
 * @email wxy@wxy97.com
 * @createTime 2022年06月15日 10:02:00
 */
@Import(MyImportBeanDefinitionRegistrar.class)
@Configuration
public class GirlMainConf {
}

启动项目打印"girl is Init"

类似于第二种，当Spring扫描到该类时，将会调用registerBeanDefinitions方法，在该方法中，我们手动往Spring中注入了一个Baby的Bean，理论上可以通过这种方式不限量的注入任何的Bean

Snipaste_2022-06-15_10-06-04