SPI的简单介绍

谁践踏了优雅 2022-12-10 03:47 96阅读 0赞

## 1：SPI是什么 ##

首先，`SPI`是jdk制定的一种规范 ，满足服务使用者在符合`开闭原则`基础上来编写代码，而能能够实现使用不同的服务提供方提供的服务，既然是规范肯定就需要有接口，而后还要有接口的具体实现，以及具体实现如何暴露给使用者，最后使用者如何使用这些具体实现，都会在`SPI`中进行制定。如数据库驱动，日志等，有些抽象，接下里使用一个实例来进行说明其具体的使用方法。

## 2：实例-搭建项目 ##

本例子会采用maven父子项目方式创建`5`个项目（模块）,分别如下：

1：spiparent，作为父项目。
    2：spiinterface，指定spi规范的接口，简单定义一个sayHi的方法。
    3：spiconcrete-english，实现spiinterface中的接口，实现方式为使用英语sayHi。
    4：spiconcrete-chinese，实现spiinterface的接口，实现方式为使用汉语sayHi。
    5：spi-invoker，spiconcrete-english和spiconcrete-chinese的具体使用者。

先看最终项目创建完毕结构:  
![在这里插入图片描述][202009231801116.jpg_pic_center]

### 2.1：创建`spiparent` ###

*  new->project  
    ![在这里插入图片描述][20200923173346173.jpg_pic_center]
 *  选择`maven`，不勾选`Create from archetype`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]
 *  输入`GAV`信息  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]
 *  next,输入项目名称  
    一般和`Artifactid`保持一致，因此可不做修改。  
    ![在这里插入图片描述][20200923173814125.jpg_pic_center]
 *  finish  
    ![在这里插入图片描述][20200923174028138.jpg_pic_center]
 *  删除src  
    因为作为父项目存在，所以只需要保留`pom.xml`，不需要源代码文件和资源文件等，因此直接删除`src`。  
    ![在这里插入图片描述][20200923174058815.jpg_pic_center]

### 2.2：创建`spiinterface` ###

*  鼠标选中`spiparent`
 *  new->module  
    ![在这里插入图片描述][2020092317473282.jpg_pic_center]
 *  选择`maven`，不选择`Create from archetype`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 2]
 *  输入`ArtifactId为spiinterface`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 3]
 *  next->finish  
    ![在这里插入图片描述][20200923175054807.jpg_pic_center]

### 2.3：创建`spiconcrete-english` ###

同`2.2`,只不过`ArtifactId=spiconcrete-english`，设置完如下：  
![在这里插入图片描述][20200923175515125.jpg_pic_center]

### 2.4：创建`spiconcrete-chinese` ###

同`2.2`,只不过`ArtifactId=spiconcrete-chinese`，设置完如下：  
![在这里插入图片描述][20200923175752831.jpg_pic_center]

### 2.5：创建`spi-invoker` ###

同`2.2`,只不过`ArtifactId=spi-invoker`，设置完如下：  
![在这里插入图片描述][20200923180047469.jpg_pic_center]

## 3：实例-写代码 ##

### 3.1：在`spiinterface`定义接口 ###

public interface SayHi { 
        void sayHi();
    }

### 3.2：在`spiconcrete-chinese`实现接口 ###

*  引入依赖项目`spiinterface`

<dependencies>
        <dependency>
          <groupId>dongshi.daddy</groupId>
          <artifactId>spiinterface</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
      </dependencies>

*  实现接口

public class ChineseSayHi implements SayHi { 
    
        public void sayHi() { 
            System.out.println("你好，欢迎来到叶寨村！！！");
        }
    }

*  定义services  
    做法为在资源文件夹下创建`META-INF/services`文件夹，然后创建名称为`SPI接口全限定名`的文件，并将`ChineseSayHi全限定名`写到文件中，如下：  
    ![在这里插入图片描述][20200923181849530.jpg_pic_center]

dongshi.daddy.ChineseSayHi

### 3.3：在`spiconcrete-english`实现接口 ###

*  引入依赖项目`spiinterface`

*  实现接口

public class EnglishSayHi implements SayHi { 
    
        public void sayHi() { 
            System.out.println("welcome to yezhaicun country!!!");
        }
    }

*  定义services  
    做法为在资源文件夹下创建`META-INF/services`文件夹，然后创建名称为`SPI接口全限定名`的文件，并将`EnglishSayHi全限定名`写到文件中，如下：  
    ![在这里插入图片描述][20200923182141409.jpg_pic_center]

dongshi.daddy.EnglishSayHi

## 4：实例-测试 ##

具体使用会用到SPI规范中提供的工具类`java.util.ServiceLoader`，该工具类专门用来从`classpath下的META-INF/services`下加载对应的具体服务的实现。

### 4.1：在`spi-invoker`编写测试类 ###

*  引入依赖（先使用`spiconcrete-chinese`）

<dependencies>
        <dependency>
          <groupId>dongshi.daddy</groupId>
          <artifactId>spiinterface</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
          <groupId>dongshi.daddy</groupId>
          <artifactId>spiconcrete-chinese</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
      </dependencies>

*  测试代码

public class SayHiTestMain { 
    
        public static void main(String[] args) { 
            ServiceLoader<SayHi> load = ServiceLoader.load(SayHi.class);
            for (SayHi sayHi : load) { 
                sayHi.sayHi();
            }
        }
    }

*  运行

你好，欢迎来到叶寨村！！！

如果此时我们想要使用英语来sayHi，怎么办呢？只需要将`spiconcrete-chinese`换为`spiconcrete-english`的依赖即可，如下：

<dependencies>
        <dependency>
          <groupId>dongshi.daddy</groupId>
          <artifactId>spiinterface</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
          <groupId>dongshi.daddy</groupId>
          <artifactId>spiconcrete-english</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
      </dependencies>

*  再次运行

welcome to yezhaicun country!!!

满足了`开闭原则`。

## 5：源码 ##

[这里][Link 1]下载。

## 6：在数据库驱动中应用 ##

数据库在计算机领域具有非常重要的地位，因此对于数据相关的驱动则无疑是更加重要的，因为我们使用操作数据库必须依赖于这些驱动程序，因此`驱动领域中的规范`就显的尤为的重要了，对于此，jdk大佬们基于SPI的规范定义了数据库驱动的规范接口，该接口是`java.sql.Driver`,具体定义如下：

package java.sql;
    public interface Driver {
    }

接下来以mysql驱动程序为例进行说明。如下是MySQL数据库驱动包截图，可以看到里面定义了`META-INF/services/java.sql.Driver`文件，内容为该类的具体实现类：  
![在这里插入图片描述][20200926120549800.png_pic_center]

com.mysql.jdbc.Driver

`com.mysql.jdbc.Driver`类定义如下：

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
        public Driver() throws SQLException {
        }
    
        static {
            try {
                DriverManager.registerDriver(new Driver());
            } catch (SQLException var1) {
                throw new RuntimeException("Can't register driver!");
            }
        }
    }

可以看到其实现了数据库驱动SPI规范接口`java.sql.Driver`。

## 最后：都让开，我要喝瑞幸 ##

![在这里插入图片描述][20200828090303329.png_pic_center]

[202009231801116.jpg_pic_center]: /images/20221123/4ab7f163638c4f48850791c53a791e53.png
[20200923173346173.jpg_pic_center]: /images/20221123/2b1b9a7d5b324d0fbe11ef78b2e9a2b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/38ae353f73b84df3ae9999ecf8ead138.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/4f37cce45c4145a98409337b48ac349f.png
[20200923173814125.jpg_pic_center]: /images/20221123/4d8e8862ecb245acb818499e12253c91.png
[20200923174028138.jpg_pic_center]: /images/20221123/f72936bf52754feeaf4cfaf9e2ae7e49.png
[20200923174058815.jpg_pic_center]: /images/20221123/cf7dd1113e7c4cf08fce976293e16190.png
[2020092317473282.jpg_pic_center]: /images/20221123/ff6ce2c55d87485c8a3115994973b104.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/e8ba1ba55f0140a0baaa8946bd1aff3c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/3b017116789a47f2bd27a92180490ea7.png
[20200923175054807.jpg_pic_center]: /images/20221123/ec2bc08471354b5386a112175e475f6a.png
[20200923175515125.jpg_pic_center]: /images/20221123/faeed99dafec4fcfbfd510048015495e.png
[20200923175752831.jpg_pic_center]: /images/20221123/c15f95117cd64cb3a38cb54b9bdb4dba.png
[20200923180047469.jpg_pic_center]: /images/20221123/fc64308166e641f683dd427eb435f038.png
[20200923181849530.jpg_pic_center]: /images/20221123/7bd5e63f4176458da7e9b12c6a864451.png
[20200923182141409.jpg_pic_center]: /images/20221123/f767520323794a309db72a88017c93b5.png
[Link 1]: https://gitee.com/dongsir2020/spiparent/repository/archive/master.zip
[20200926120549800.png_pic_center]: /images/20221123/fd487a133a0542ba8758593188b63d5b.png
[20200828090303329.png_pic_center]: /images/20221123/613079eb7cf34d0cb2f42a728bdadd3a.png