美文网首页Java
Java SPI 的简单使用

Java SPI 的简单使用

作者: nimo10050 | 来源:发表于2020-03-29 10:33 被阅读0次

    开篇

    本文主要谈一下 Java SPI(Service Provider Interface) ,因为最近在看 Dubbo 的相关内容,其中涉及到了 一个概念- Dubbo SPI, 最后又牵扯出来了 JAVA SPI, 所以先从 Java SPI 开整。

    正文

    平常学习一个知识点,我们的常规做法是:

    • 是什么
    • 有什么用
    • 怎么用

    这次我们倒着做,先不谈什么是 SPI 及其作用,来看下如何使用。

    使用

    1. 创建一个 maven 工程

    在这里插入图片描述

    2. 创建一个接口类以及实现类

    
    // 接口
    public interface HelloService {
    
        void sayHello();
    
    }
    
    // 实现类 1
    public class HelloServiceImpl1 implements HelloService {
        @Override
        public void sayHello() {
            System.out.println("hello impl1");
        }
    }
    
    // 实现类 2
    public class HelloServiceImpl2 implements HelloService {
        @Override
        public void sayHello() {
            System.out.println("hello impl2");
        }
    }
    

    3. 创建一个 META-INF/services 文件夹,并添加一个文件

    在 classpath 下面创建一个META-INF/services目录,再在下面创建一个
    以接口类全路径名 命名的文件
    即:com.nimo.spidemo.service.HelloService

    4. 在第三步创建的文件中写入如下内容

    写入两个实现类的全路径名

    com.nimo.spidemo.service.impl.HelloServiceImpl1
    com.nimo.spidemo.service.impl.HelloServiceImpl2
    

    5. 启动函数

    public class App {
    
        public static void main(String[] args) throws ClassNotFoundException, SQLException {
            // 方式 一
            Iterator<HelloService> providers = Service.providers(HelloService.class);
            while(providers.hasNext()) {
                HelloService ser = providers.next();
                ser.sayHello();
            }
    
            System.out.println("-----------------分割线---------------");
            // 方式 二
            ServiceLoader<HelloService> load = ServiceLoader.load(HelloService.class);
            Iterator<HelloService> iterator = load.iterator();
            while(iterator.hasNext()) {
                HelloService ser = iterator.next();
                ser.sayHello();
            }
        }
    
    }
    

    运行结果如下:

    hello impl1
    hello impl2
    -----------------分割线---------------
    hello impl1
    hello impl2
    

    使用要素

    针对上面的 demo,可以看出使用 Java SPI 的几个关键要素:

    1. 接口类,比如 HelloService
    2. 对应接口的实现类
      实现类必须携带一个不带参数的构造方法
    3. 文件夹 META-INF/services
      放置 classpath 目录下
    4. 以“接口全限定名”命名的文件
    5. 文件内容为接口实现类的全路径

    主程序通过java.util.ServiceLoder扫描META-INF/services下的配置文件,然后会找到实现类的全限定名,最后把类加载到JVM;

    SPI 的作用

    从上面的 demo 中可以看到,Java SPI 就是把某个接口的 指定实现类 (通过在指定文件配置的方式)给实例化出来了。

    准确+官方的说:

    SPI 是一种将服务接口与服务实现分离以达到解耦、大大提升了程序可扩展性的机制。引入服务提供者就是引入了 spi 接口的实现者,通过本地的注册发现获取到具体的实现类,轻松可插拔。

    ~~~ 如果还是不懂就接着往下看⬇️

    SPI 的应用场景

    一个典型的案例就是 jdbc 。

    数据库各大厂商(如Mysql、Oracle)会根据一个统一的接口规范( java.sql.Driver )开发各自的驱动实现逻辑。
    客户端使用 jdbc 时不需要去改变代码,直接引入不同的 spi 接口服务即可。
    例如 :
    Mysql 是 com.mysql.jdbc.Drive
    Oracle 是 oracle.jdbc.driver.OracleDriver

    一段熟悉的代码:

    使用操作 mysql 数据库的前置工作:

     //1.加载驱动程序
    Class.forName("com.mysql.jdbc.Driver");
    //2. 获得数据库连接
    Connection conn = DriverManager.getConnection(URL, USER, PASSWORD);
    

    当我们需要切到 oracle 数据库时,更改驱动为 oracle.jdbc.driver.OracleDriver, 最后修改连接信息【用户名,密码等】即可。

    总结

    Java SPI 是一种服务发现机制。它通过在 classPath 路径下的 META-INF/services 文件夹查找文件,自动加载文件里所定义的类。

    它的核心关键作用就是 扩展

    其他应用场景:

    • 日志门面接口实现类加载

      SLF4J加载不同提供商的日志实现类

    • Spring

      Spring中大量使用了 SPI,比如:对 servlet3.0 规范 ServletContainerInitializer 的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等

    • Dubbo

      Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装,允许用户扩展实现Filter接口

    其中 Dubbo 中的 SPI 是接下来研究的重点。

    相关文章

      网友评论

        本文标题:Java SPI 的简单使用

        本文链接:https://www.haomeiwen.com/subject/qaeyuhtx.html