Spring高手之路14——深入浅出：SPI机制在JDK与Spring Boot中的应用

1. SPI解读：什么是SPI?

  SPI (Service Provider Interface) 是一种服务发现机制，它允许第三方提供者为核心库或主框架提供实现或扩展。这种设计允许核心库/框架在不修改自身代码的情况下，通过第三方实现来增强功能。

• 定义和发现：JDK的SPI主要通过在META-INF/services/目录下放置特定的文件来指定哪些类实现了给定的服务接口。这些文件的名称应为接口的全限定名，内容为实现该接口的全限定类名。

• 加载机制：ServiceLoader类使用Java的类加载器机制从META-INF/services/目录下加载和实例化服务提供者。例如，ServiceLoader.load(MyServiceInterface.class)会返回一个实现了MyServiceInterface的实例迭代器。

• 缺点：JDK原生的SPI每次通过ServiceLoader加载时都会初始化一个新的实例，没有实现类的缓存，也没有考虑单例等高级功能。

• 更加灵活：Spring的SPI不仅仅是服务发现，它提供了一套完整的插件机制。例如，可以为Spring定义新的PropertySource，ApplicationContextInitializer等。

• 与IoC集成：与JDK的SPI不同，Spring的SPI与其IoC (Inversion of Control) 容器集成，使得在SPI实现中可以利用Spring的全部功能，如依赖注入。

• 条件匹配：Spring提供了基于条件的匹配机制，这允许在某些条件下只加载特定的SPI实现，例如，可以基于当前运行环境的不同来选择加载哪个数据库驱动。

• 配置：Spring允许通过spring.factories文件在META-INF目录下进行配置，这与JDK的SPI很相似，但它提供了更多的功能和灵活性。

举个类比的例子：

  想象我们正在建造一个电视机，SPI就像电视机上的一个USB插口。这个插口可以插入各种设备（例如U盘、游戏手柄、电视棒等），但我们并不关心这些设备的内部工作方式。这样只需要提供一个标准的接口，其他公司（例如U盘制造商）可以为此接口提供实现。这样，电视机可以在不更改自己内部代码的情况下使用各种新设备，而设备制造商也可以为各种电视机制造兼容的设备。

  总之，SPI是一种将接口定义与实现分离的设计模式，它鼓励第三方为一个核心产品或框架提供插件或实现，从而使核心产品能够轻松地扩展功能。

2. SPI在JDK中的应用示例

  在Java的生态系统中，SPI 是一个核心概念，允许开发者提供扩展和替代的实现，而核心库或应用不必更改，下面举出一个例子来说明。

全部代码和步骤如下：

步骤1：定义一个服务接口，文件名: MessageService.java

package com.example.demo.service;

public interface MessageService {
    String getMessage();
}

步骤2：为服务接口提供实现，这里会提供两个简单的实现类。

HelloMessageService.java

package com.example.demo.service;

public class HelloMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hello from HelloMessageService!";
    }
}

HiMessageService.java

package com.example.demo.service;

public class HiMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hi from HiMessageService!";
    }
}

这些实现就像不同品牌或型号的U盘或其他USB设备。每个设备都有自己的功能和特性，但都遵循相同的USB标准。

步骤3：注册服务提供者

  在资源目录（通常是src/main/resources/）下创建一个名为META-INF/services/的文件夹。在这个文件夹中，创建一个名为com.example.demo.service.MessageService的文件（这是我们接口的全限定名），这个文件没有任何文件扩展名，所以不要加上.txt这样的后缀。文件的内容应为我们的两个实现类的全限定名，每个名字占一行：

com.example.demo.service.HelloMessageService
com.example.demo.service.HiMessageService

  META-INF/services/ 是 Java SPI (Service Provider Interface) 机制中约定俗成的特定目录。它不是随意选择的，而是 SPI 规范中明确定义的。因此，当使用 JDK 的 ServiceLoader 类来加载服务提供者时，它会特意去查找这个路径下的文件。

  请确保文件的每一行只有一个名称，并且没有额外的空格或隐藏的字符，文件使用UTF-8编码。

步骤4：使用ServiceLoader加载和使用服务

package com.example.demo;

import com.example.demo.service.MessageService;

import java.util.ServiceLoader;

public class DemoApplication {

    public static void main(String[] args) {
        ServiceLoader loaders = ServiceLoader.load(MessageService.class);

        for (MessageService service : loaders) {
            System.out.println(service.getMessage());
        }
    }
}

运行结果如下：

  这说明ServiceLoader成功地加载了我们为MessageService接口提供的两个实现，并且我们可以在不修改Main类的代码的情况下，通过添加更多的实现类和更新META-INF/services/com.example.MessageService文件来扩展我们的服务。

想象一下买了一台高端的智能电视，这台电视上有一个或多个HDMI端口，这就是它与外部设备连接的接口。

3. SPI在Spring框架中的应用

  Spring官方在其文档和源代码中多次提到了SPI（Service Provider Interface）的概念。但是，当我们说“Spring的SPI”时，通常指的是Spring框架为开发者提供的一套可扩展的接口和抽象类，开发者可以基于这些接口和抽象类实现自己的版本。

在Spring中，SPI的概念与Spring Boot使用的spring.factories文件的机制不完全一样，但是它们都体现了可插拔、可扩展的思想。

• Spring的核心框架提供了很多接口和抽象类，如BeanPostProcessor, PropertySource, ApplicationContextInitializer等，这些都可以看作是Spring的SPI。开发者可以实现这些接口来扩展Spring的功能。这些接口允许开发者在Spring容器的生命周期的不同阶段介入，实现自己的逻辑。

• spring.factories是Spring Boot的一个特性，允许开发者自定义自动配置。通过spring.factories文件，开发者可以定义自己的自动配置类，这些类在Spring Boot启动时会被自动加载。

• 在这种情况下，SpringFactoriesLoader的使用，尤其是通过spring.factories文件来加载和实例化定义的类，可以看作是一种特定的SPI实现方式，但它特定于Spring Boot。

3.1 传统Spring框架中的SPI思想

  在传统的Spring框架中，虽然没有直接使用名为"SPI"的术语，但其核心思想仍然存在。Spring提供了多个扩展点，其中最具代表性的就是BeanPostProcessor。在本节中，我们将通过一个简单的MessageService接口及其实现来探讨如何利用Spring的BeanPostProcessor扩展点体现SPI的思想。

提供两个简单的实现类。

HelloMessageService.java

package com.example.demo.service;

public class HelloMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hello from HelloMessageService!";
    }
}

HiMessageService.java

package com.example.demo.service;

public class HiMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hi from HiMessageService!";
    }
}

定义BeanPostProcessor

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;

public class MessageServicePostProcessor implements BeanPostProcessor {
    
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if(bean instanceof MessageService) {
            return new MessageService() {
                @Override
                public String getMessage() {
                    return ((MessageService) bean).getMessage() + " [Processed by Spring SPI]";
                }
            };
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

修改Spring配置

将MessageServicePostProcessor添加到Spring配置中：

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

@Configuration
public class MessageServiceConfig {
    
    @Bean
    public MessageService helloMessageService() {
        return new HelloMessageService();
    }

    @Bean
    public MessageService hiMessageService() {
        return new HiMessageService();
    }
    
    @Bean
    public MessageServicePostProcessor messageServicePostProcessor() {
        return new MessageServicePostProcessor();
    }
}

执行程序

使用之前提供的DemoApplication示例类：

package com.example.demo;

import com.example.demo.configuration.MessageServiceConfig;
import com.example.demo.service.MessageService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class DemoApplication {

    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(MessageServiceConfig.class);
        MessageService helloMessageService = context.getBean("helloMessageService", MessageService.class);
        MessageService hiMessageService = context.getBean("hiMessageService", MessageService.class);

        System.out.println(helloMessageService.getMessage());
        System.out.println(hiMessageService.getMessage());
    }
}

运行结果：

  现在，每一个MessageService实现都被BeanPostProcessor处理了，添加了额外的消息“[Processed by Spring SPI]”。这演示了Spring的SPI概念，通过BeanPostProcessor来扩展或修改Spring容器中的bean。

  有人可能留意到这里红色的警告，这个之前在讲BeanPostProcessor的时候也提到过，当BeanPostProcessor自身被一个或多个BeanPostProcessor处理时，就会出现这种情况。简单地说，由于BeanPostProcessor需要在其他bean之前初始化，所以某些BeanPostProcessor无法处理早期初始化的bean，包括配置类和其他BeanPostProcessor。解决办法就是不要把MessageServicePostProcessor放在配置类初始化，在配置类删掉，再把MessageServicePostProcessor加上@Component注解。

类比文章开头的电视机的例子：

  总的来说，与之前的例子相比，这个新示例提供了一个更加动态的场景，其中Spring的BeanPostProcessor扩展点允许我们拦截并修改bean的行为，就像一个能够干预并改变电视机显示内容的智能设备。

3.2 Spring Boot中的SPI思想

  Spring Boot有一个与SPI相似的机制，但它并不完全等同于Java的标准SPI。

  Spring Boot的自动配置机制主要依赖于spring.factories文件。这个文件可以在多个jar中存在，并且Spring Boot会加载所有可见的spring.factories文件。我们可以在这个文件中声明一系列的自动配置类，这样当满足某些条件时，这些配置类会自动被Spring Boot应用。

接下来会展示Spring SPI思想的好例子，但是它与Spring Boot紧密相关。

定义接口

package com.example.demo.service;

public interface MessageService {
    String getMessage();
}

这里会提供两个简单的实现类。

HelloMessageService.java

package com.example.demo.service;

public class HelloMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hello from HelloMessageService!";
    }
}

HiMessageService.java

package com.example.demo.service;

public class HiMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hi from HiMessageService!";
    }
}

注册服务

在resources/META-INF下创建一个文件名为spring.factories。这个文件里，可以注册MessageService实现类。

com.example.demo.service.MessageService=com.example.demo.service.HelloMessageService,com.example.demo.service.HiMessageService

  注意这里com.example.demo.service.MessageService是接口的全路径，而com.example.demo.service.HelloMessageService,com.example.demo.service.HiMessageService是实现类的全路径。如果有多个实现类，它们应当用逗号分隔。

  spring.factories文件中的条目键和值之间不能有换行，即key=value形式的结构必须在同一行开始。但是，如果有多个值需要列出（如多个实现类），并且这些值是逗号分隔的，那么可以使用反斜杠（）来换行。spring.factories 的名称是约定俗成的。如果试图使用一个不同的文件名，那么 Spring Boot 的自动配置机制将不会识别它。

这里spring.factories又可以写为

com.example.demo.service.MessageService=com.example.demo.service.HelloMessageService,
  com.example.demo.service.HiMessageService

直接在逗号后面回车IDEA会自动补全反斜杠，保证键和值之间不能有换行即可。

使用SpringFactoriesLoader来加载服务

package com.example.demo;

import com.example.demo.service.MessageService;
import org.springframework.core.io.support.SpringFactoriesLoader;

import java.util.List;

public class DemoApplication {

    public static void main(String[] args) {
        List services = SpringFactoriesLoader.loadFactories(MessageService.class, null);
        for (MessageService service : services) {
            System.out.println(service.getMessage());
        }
    }
}

SpringFactoriesLoader.loadFactories的第二个参数是类加载器，此处我们使用默认的类加载器，所以传递null。

运行结果：

  这种方式利用了Spring的SpringFactoriesLoader，它允许开发者提供接口的多种实现，并通过spring.factories文件来注册它们。这与JDK的SPI思想非常相似，只是在实现细节上有所不同。这也是Spring Boot如何自动配置的基础，它会查找各种spring.factories文件，根据其中定义的类来初始化和配置bean。

我们继续使用电视机的例子来解释：

简化解释:

• 当插入USB设备到电视机，期望电视机能够识别并显示该设备的内容。

• 在我们的例子中，USB设备的内容就是从MessageService实现类返回的消息。

• spring.factories文件就像电视机的内置目录，告诉电视机哪些USB设备是已知的和可以使用的。

• 当我们的DemoApplication（电视机）运行时，它使用SpringFactoriesLoader（USB扫描功能）来检查哪些服务（USB设备）是可用的，并输出相应的消息（显示USB内容）。

  总结：在这个Spring Boot的SPI例子中，我们展示了核心Spring应用如何自动地识别和使用spring.factories文件中注册的实现，这与电视机自动地识别和使用所有插入的USB设备有相似之处。

4. SPI在JDBC驱动加载中的应用

  数据库驱动的SPI主要体现在JDBC驱动的自动发现机制中。JDBC 4.0 引入了一个特性，允许驱动自动注册到DriverManager。这是通过使用Java的SPI来实现的。驱动jar包内会有一个META-INF/services/java.sql.Driver文件，此文件中包含了该驱动的Driver实现类的全类名。这样，当类路径中有JDBC驱动的jar文件时，Java应用程序可以自动发现并加载JDBC驱动，而无需明确地加载驱动类。

  这意味着任何数据库供应商都可以编写其自己的JDBC驱动程序，只要它遵循JDBC驱动程序的SPI，它就可以被任何使用JDBC的Java应用程序所使用。

当我们使用DriverManager.getConnection()获取数据库连接时，背后正是利用SPI机制加载合适的驱动程序。

以下是SPI机制的具体工作方式：

在这里，接口已经由Java平台定义，即java.sql.Driver。

各大数据库厂商（如Oracle, MySQL, PostgreSQL等）为其数据库提供了JDBC驱动程序，它们都实现了java.sql.Driver接口。例如，MySQL的驱动程序中有一个类似于以下的类：

public class com.mysql.cj.jdbc.Driver implements java.sql.Driver {
    // 实现接口方法...
}

直接上图：

对于MySQL的驱动程序，可以在其JAR文件的META-INF/services目录下找到一个名为java.sql.Driver的文件，文件内容如下：

com.mysql.cj.jdbc.Driver

直接上图：

看到这里是不是发现和第2节举的JDK SPI的例子一样？体会一下。

  当我们调用DriverManager.getConnection(jdbcUrl, username, password)时，DriverManager会使用ServiceLoader来查找所有已注册的java.sql.Driver实现。然后，它会尝试每一个驱动程序，直到找到一个可以处理给定jdbcUrl的驱动程序。

以下是一个简单的示例，展示如何使用JDBC SPI获取数据库连接：

import java.sql.Connection;
import java.sql.DriverManager;

public class JdbcExample {
    public static void main(String[] args) {
        String jdbcUrl = "jdbc:mysql://localhost:3306/mydatabase";
        String username = "root";
        String password = "password";

        try {
            Connection connection = DriverManager.getConnection(jdbcUrl, username, password);
            System.out.println("Connected to the database!");
            connection.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

  在上述代码中，我们没有明确指定使用哪个JDBC驱动程序，因为DriverManager会自动为我们选择合适的驱动程序。

  这种模块化和插件化的机制使得我们可以轻松地为不同的数据库切换驱动程序，只需要更改JDBC URL并确保相应的驱动程序JAR在类路径上即可。

  在Spring Boot中，开发者通常不会直接与JDBC的SPI机制交互来获取数据库连接。Spring Boot的自动配置机制隐藏了许多底层细节，使得配置和使用数据库变得更加简单。

一般会在application.properties或application.yml中配置数据库连接信息。

例如：

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

  在上述步骤中，Spring Boot的自动配置机制会根据提供的依赖和配置信息来初始化和配置DataSource对象，这个对象管理数据库连接。实际上，添加JDBC驱动依赖时，Spring Boot会使用JDK的SPI机制（在JDBC规范中应用）来找到并加载相应的数据库驱动。开发者虽然不直接与JDK的SPI交互，但在背后Spring Boot确实利用了JDK SPI机制来获取数据库连接。

5. 如何通过Spring Boot自动配置理解SPI思想

  这种机制有点类似于Java的SPI，因为它允许第三方库提供一些默认的配置。但它比Java的SPI更为强大和灵活，因为Spring Boot提供了大量的注解（如@ConditionalOnClass、@ConditionalOnProperty、@ConditionalOnMissingBean等）来控制自动配置类是否应该被加载和应用。

  总的来说，Spring Boot的spring.factories机制和Java的SPI在概念上是相似的，但它们在实现细节和用途上有所不同。

让我们创建一个简化的实际例子，假设我们要为不同的消息服务（如SMS和Email）创建自动配置。

MessageService接口：

package com.example.demo.service;

public interface MessageService {
    void send(String message);
}

SMS服务实现：

package com.example.demo.service.impl;

import com.example.demo.service.MessageService;

public class SmsService implements MessageService {
    @Override
    public void send(String message) {
        System.out.println("Sending SMS: " + message);
    }
}

Email服务实现：

package com.example.demo.service.impl;

import com.example.demo.service.MessageService;

public class EmailService implements MessageService {
    @Override
    public void send(String message) {
        System.out.println("Sending Email: " + message);
    }
}

自动配置类：

package com.example.demo.configuration;

import com.example.demo.service.EmailService;
import com.example.demo.service.MessageService;
import com.example.demo.service.SmsService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MessageAutoConfiguration {

    @Bean
    @ConditionalOnProperty(name = "message.type", havingValue = "sms")
    public MessageService smsService() {
        return new SmsService();
    }

    @Bean
    @ConditionalOnProperty(name = "message.type", havingValue = "email")
    public MessageService emailService() {
        return new EmailService();
    }
}

  这个类提供两个条件性的beans（组件），分别是SmsService和EmailService。这些beans的创建取决于application.properties文件中特定的属性值。

• @ConditionalOnProperty(name = "message.type", havingValue = "sms")

  当application.properties或application.yml中定义的属性message.type的值为sms时，此条件为true。此时，smsService()方法将被调用，从而创建一个SmsService的bean。

• @ConditionalOnProperty(name = "message.type", havingValue = "email")

  当application.properties或application.yml中定义的属性message.type的值为email时，此条件为true。此时，emailService()方法将被调用，从而创建一个EmailService的bean。

spring.factories文件：

在src/main/resources/META-INF目录下创建一个spring.factories文件，内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.example.demo.configuration.MessageAutoConfiguration

application.properties文件：

message.type=sms

MessageTester组件：

package com.example.demo;

import com.example.demo.service.MessageService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

@Component
public class MessageTester {

    @Autowired
    private MessageService messageService;

    @PostConstruct
    public void init() {
        messageService.send("Hello World");
    }
}

DemoApplication主程序：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

运行结果：

  在上述例子中，我们创建了一个MessageService接口和两个实现（SmsService和EmailService）。然后，我们创建了一个自动配置类，其中包含两个bean定义，这两个bean定义分别基于application.properties中的属性值条件性地创建。在spring.factories文件中，我们声明了这个自动配置类，以便Spring Boot在启动时能够自动加载它。

在此，继续用电视机的例子升华理解下

电视机类比

• 假设电视机（TV）是一个Java应用。

• 电视机的各种插槽，如HDMI、USB、VGA等，可以视为应用中的SPI接口。

• 插入这些插槽的设备（如DVD播放器、游戏机、USB驱动器等）可以视为SPI的实现。

• 当我们购买电视机时，不知道将会连接哪种设备，可能是DVD播放器，也可能是游戏机。

• 但是，只要这些设备遵循了插槽的标准（例如，HDMI标准），就可以将其插入电视机并使其工作。

• 这就像Java的SPI机制：为了能让多个供应商提供实现，Java定义了一个接口，供应商提供具体的实现。

• 现在，想象一下现代的智能电视。当插入一个设备，电视机不仅可以识别它，还可能根据所连接的设备类型自动调整设置，例如选择正确的输入源、优化图像质量等。

• 这就像Spring Boot的自动配置：当Spring Boot应用启动时，它会检查classpath上的库，并根据存在的库自动配置应用。

• 电视机的自动设置可以类比为Spring Boot中的spring.factories和各种@Conditional...注解。它们决定在什么条件下进行哪种配置。

• 如果电视制造商想为新型的插槽或连接技术开发电视，它可以很容易地在其电视机型中添加新的插槽。

• 同样地，使用Spring Boot，如果要为应用添加新功能或库，只需添加相关的依赖，然后Spring Boot会自动识别并配置这些新功能。

  通过这种类比，电视机的插槽和自动设置功能为我们提供了一个直观的方式来理解Java的SPI机制和Spring Boot的自动配置如何工作，以及它们如何为应用开发者提供便利。

6. SPI（Service Provider Interface）总结

  SPI，即服务提供者接口，是一种特定的设计模式。它允许框架或核心库为第三方开发者提供一个预定义的接口，从而使他们能够为框架提供自定义的实现或扩展。

核心目标:

价值:

• 为框架或库的用户提供更多的自定义选项和灵活性。

• 允许框架的核心部分保持稳定，同时能够容纳新的功能和扩展。

SPI与“开闭原则”：

  “开闭原则”提倡软件实体应该对扩展开放，但对修改封闭。即在不改变现有代码的前提下，通过扩展来增加新的功能。

SPI如何体现“开闭原则”:

  总之，SPI是一种使软件框架或库更加模块化、可扩展和可维护的有效方法。通过遵循“开闭原则”，SPI确保了系统的稳定性和灵活性，从而满足了不断变化的业务需求。

欢迎一键三连~

有问题请留言，大家一起探讨学习

----------------------Talk is cheap, show me the code-----------------------