Java的SPI

た入场券 2023-09-24 23:58 118阅读 0赞

Java SPI（Service Provider Interface）是一种在 Java 平台上用于服务发现的机制，允许应用程序在运行时动态加载实现某一接口的类，并通过接口进行交互。  
在 Java SPI 中，有三个角色：服务提供者、服务请求者、配置文件。服务提供者是指实现某一接口的具体类，而服务请求者则是指需要使用这些服务提供者的应用程序。  
具体来说，Java SPI 机制通常包含以下步骤：

1.  定义接口：定义一个接口，该接口包含多个方法，用于提供具体的服务。
2.  编写实现类：编写多个实现该接口的类，这些类将提供具体的服务。
3.  配置文件：在 META-INF/services 目录下创建一个以接口全限定名命名的文件，该文件中包含所有实现该接口的类的全限定名。
4.  加载实现类：使用 Java SPI 机制动态加载所有实现该接口的类，并调用其提供的服务。

Java SPI 机制的优点是可以让应用程序更加灵活，可以在不改变代码的情况下扩展功能，同时也降低了应用程序的耦合度。

下面是一个简单的示例，说明如何实现一个 Java 的 SPI。  
首先定义一个接口，例如：

public interface MyService {
        
        void sayHello();
    }

接下来编写一个或多个实现该接口的类，例如：

public class MyServiceImpl1 implements MyService {
        
        @Override
        public void sayHello() {
        
            System.out.println("Hello from MyServiceImpl1");
        }
    }
    
    public class MyServiceImpl2 implements MyService {
        
        @Override
        public void sayHello() {
        
            System.out.println("Hello from MyServiceImpl2");
        }
    }

创建服务提供者配置文件，在**src/main/resources/META-INF/services**目录下创建一个名为com.example.MyService的文件，文件内容为实现该接口的类的全限定名，例如：

com.example.MyServiceImpl1
    com.example.MyServiceImpl2

加载实现类，使用Java的SPI机制，可以动态地加载实现类并调用它们的方法。例如：

ServiceLoader<MyService> serviceLoader = ServiceLoader.load(MyService.class);
    for (MyService service : serviceLoader) {
        
        service.sayHello();
    }

通过以上步骤，就实现了一个简单的 Java 的 SPI。在实际使用中，可以根据需要在配置文件中替换或添加新的实现类，而不需要修改代码。

我们熟悉的springboot的自动装配也是基于SPI来实现，它通过@EnableAutoConfiguration注解和META-INF/spring.factories文件来实现自动配置。  
spring.factories文件中的配置信息是按照如下格式进行配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.example.demo.config.MyConfiguration,\
    com.example.demo.config.OtherConfiguration

其中，org.springframework.boot.autoconfigure.EnableAutoConfiguration是一个完全限定的注解类名，它用于指定自动配置类。接下来是一个类名列表，每个类名代表一个自动配置类。在Spring Boot启动时，会根据这个配置文件中的信息，自动配置这些类。如果项目中没有这些类的依赖，那么这些自动配置就不会生效。  
\\表示换行符；后面跟着的是自动配置类的全限定名，多个自动配置类之间用逗号分隔。  
这样，就可以将两个自动配置类添加到EnableAutoConfiguration中。