Java SPI简单应用案例详解

开篇

本文主要谈一下 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简单应用案例详解的文章就介绍到这了,更多相关java spi简单应用内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！