“自动扫描”技术SPI机制详解

Java的SPI机制

一、简介

SPI 机制,英文全称为Service Provider Interface ,字面意思为服务提供者接口,它是JDK提供给"服务提供厂商"或者"插件开发者"使用的接口。

SPI的设计思想:在系统的各个模块中,往往有着多个实现,例如日志,数据库驱动...,其实就是为了在使用某个接口的时候不用指定实现类,可以通过SPI机制来发现和加载这些的实现类,Spring的自动装配也是参考了Java的SPI机制所实现的。


二、SPI实现流程

  1. 定义SPI顶级接口

  2. 创建SPI实现类,可以是一个或者多个

  3. 在resources目录下创建 META-INF 文件夹

    1. META-INF 下创建SPI顶级接口全路径为名称的文件。例:cn.yufire.demo.spi.CarEngine
  4. 将所有SPI实现类的全路径写入此文件中,多个换行分割

  5. 使用java.util包下的ServiceLoader加载所有的API实现类

    1. 调用实现类中实现好的方法

三、SPI的应用场景

目前很多主流的软件都在使用SPI进行开发,例如JDBC的数据库驱动,在各家数据库厂商的提供的驱动中,基本都采用了SPI机制来加载自家的数据库驱动。

  1. 例如MySQL的驱动包
  • 在DriverManager中就能看到加载SPI的地方和代码
scss 复制代码
 static {
   loadInitialDrivers();
   println("JDBC DriverManager initialized");
 }
 ​
 private static void loadInitialDrivers() {
   .....
     AccessController.doPrivileged(new PrivilegedAction<Void>() {
       public Void run() {
         //使用ServiceLoader动态加载具体的驱动实现类
         ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
         Iterator<Driver> driversIterator = loadedDrivers.iterator();
         try{
           while(driversIterator.hasNext()) {
             driversIterator.next();
           }
         } catch(Throwable t) {
           // Do nothing
         }
         return null;
       }
     });
   .....
 }

2.例如日志框架,log4jlogback都是通过SPI机制加载的

3.例如dubbo的负载均衡策略

类似SPI机制的技术例如,Spring Boot的自动装配,其思想也是借鉴与SPI,也是在META-INF包下创建一个名为spring.factories的文件,将需要自动装配的类的全地址写入到这个文件内,就可以实现,自动装配所需要的Bean


四、SPI实现简单实现

1. 首先定义一个服务的顶级通用接口

csharp 复制代码
 package cn.yufire.spi;
 ​
 /**
  * @author Yu
  * @date 2022/5/9 14:55
  * 汽车引擎顶级接口,用于定义顶级SPI接口实现
  */
 public interface CarEngine {
 ​
     /**
      * 装载引擎
      */
     void loadingEngine();
 }

2. 创建SPI顶级接口实现类

为了测试多实现类,所以创建2个SPI接口实现类

  • 创建V8引擎实现类
java 复制代码
 package cn.yufire.spi.impl;
 ​
 import cn.yufire.spi.CarEngine;
 ​
 /**
  * @author Yu
  * @date 2022/5/9 14:58
  * V8发动机SPI实现
  */
 public class V8_Engine implements CarEngine {
     @Override
     public void loadingEngine() {
         System.out.println("v8发动机引擎加载中...");
     }
 }
  • 创建V12引擎实现类
java 复制代码
 package cn.yufire.spi.impl;
 ​
 import cn.yufire.spi.CarEngine;
 ​
 /**
  * @author Yu
  * @date 2022/5/9 14:58
  * v12发动机SPI实现
  */
 public class V12_Engine implements CarEngine {
     @Override
     public void loadingEngine() {
         System.out.println("v12发动机引擎加载中...");
         System.out.println("v12发动机引擎加载完毕! 我是最强的!");
     }
 }

3. 创建存放SPI实现类的文件

  • resources目录下创建 META-INF文件夹
  • META-INF下创建SPI顶级接口类全地址为名称文件

4. 将SPI实现类写入此文件中

  • 多个实现换行隔开即可
rust 复制代码
 cn.yufire.spi.impl.V12_Engine
 cn.yufire.spi.impl.V8_Engine

5. 创建测试类

php 复制代码
 /**
  * @author Yu
  * @date 2022/5/9 15:00
  * spi测试
  */
 public class Tests {
 ​
     public static void main(String[] args) {
         // 获取所有的CarEngine实现类
         ServiceLoader<CarEngine> serviceLoader = ServiceLoader.load(CarEngine.class);
         // 执行所有实现类的loadingEngine方法
         serviceLoader.forEach(CarEngine::loadingEngine);
     }
 }
  • 执行后输出
erlang 复制代码
 v12发动机引擎加载中...
 v12发动机引擎加载完毕! 我是最强的!
 v8发动机引擎加载中...

相关推荐
是店小二呀几秒前
【C++】掌握C++类的六个默认成员函数:实现高效内存管理与对象操作
后端
pjx9871 分钟前
超越单体:进入微服务世界与Spring Cloud概述
java·spring cloud·微服务
Victor3561 分钟前
Dubbo(86)如何设计一个多租户的Dubbo服务?
后端
天天摸鱼的java工程师2 分钟前
爆肝 30 天!从 JVM 调优到百万级 QPS,我的 Java 性能飞升全记录
java·后端
TDengine (老段)6 分钟前
TDengine 订阅不到数据问题排查
java·数据库·tdengine
刘立军7 分钟前
本地大模型编程实战(26)用langgraph实现基于SQL数据构建的问答系统(5)
人工智能·后端·python
冼紫菜8 分钟前
Spring Cloud 项目中优雅地传递用户信息:基于 Gateway + ThreadLocal 的用户上下文方案
java·开发语言·spring boot·后端·spring cloud·gateway
为美好的生活献上中指9 分钟前
java每日精进 4.29【框架之自动记录日志并插入如数据库流程分析】
java·linux·数据库
初心_202414 分钟前
2. python协程/异步编程详解
java·前端·python
camellia15 分钟前
SpringBoot(三十九)SpringBoot集成RabbitMQ实现流量削峰添谷
java·后端