背景

我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。 java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。

一、介绍

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

二、原理

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

  • loadFactories。根据接口类获取其实现类的实例，这个方法返回的是对象列表。
  • loadFactoryNames。根据接口获取其接口类的名称，这个方法返回的是类名的列表。

在这个方法中会遍历整个ClassLoader中所有jar包下的spring.factories文件。也就是说我们可以在自己的jar中配置spring.factories文件，不会影响到其它地方的配置，也不会被别人的配置覆盖。

(通过Properties解析得到的，所以我们在写文件中的内容都是安装下面这种方式配置的。如果一个接口希望配置多个实现类，可以使用','进行分割。)

com.xxx.interface=com.xxx.classname

三、抛砖引玉

启动的项目中引用其他驱动包或者jar包，在目录不同的情况下，我们如何引入第三方包下的配置或者bean

四、实现

4.1、基础代码

  • 1、bean文件
@Data
public class Stu {

    String name;

    public Stu(String name) {
        this.name = name;
    }

    public Stu() {
    }

    @Override
    public String toString() {
        return "Stu{" +
                "name='" + name + '\'' +
                '}';
    }

}
  • 2、配置文件
@Configuration
public class StuConfiguration {

    @Bean
    public Stu stu() {
        System.out.println("自动装配学生bean");
        return new Stu();
    }

}
  • 3、引入项目模块
compile project (":spring-boot-base")

4.2、启动看日志

从这里可以看得出，上面那个打印没有输出，那么有哪些办法了
image.png

4.3、解决办法

  • 1、resources新建META-INF目录，再新建spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.qw.boot.examples.base.config.StuConfiguration
  • 2、启动类添加引入文件
@Import({StuConfiguration.class})
  • 3、启动类添加扫描路径
@ComponentScan(value = "com.qw.boot.examples.base.config")
  • 4、查看启动日志
    image.png

五、总结

在日常工作中，我们可能需要实现一些SDK或者Spring Boot Starter给别人使用，这个使用我们就可以使用Factories机制。Factories机制可以让SDK或者Starter的使用只需要很少或者不需要进行配置，只需要在服务中引入我们的jar包。因为具体引用config配置已经封装好了，不需要在主程序中扫描配置