快捷導(dǎo)航

java中spi使用詳解

更新時(shí)間：2020年09月03日 08:54:47 作者：panda-star

java中spi(service provider interface)是jdk內(nèi)置的一種服務(wù)發(fā)現(xiàn)機(jī)制，可以基于配置，在運(yùn)行時(shí)加載指定服務(wù)。這篇文章主要介紹了java中spi使用,需要的朋友可以參考下

一、簡(jiǎn)介

java中spi(service provider interface)是jdk內(nèi)置的一種服務(wù)發(fā)現(xiàn)機(jī)制，可以基于配置，在運(yùn)行時(shí)加載指定服務(wù)。java中提供了很多服務(wù)提供接口，如jdbc、jndi等。

1.什么是SPI

SPI全稱Service Provider Interface，是Java提供的一套用來被第三方實(shí)現(xiàn)或者擴(kuò)展的接口，它可以用來啟用框架擴(kuò)展和替換組件。 SPI的作用就是為這些被擴(kuò)展的API尋找服務(wù)實(shí)現(xiàn)。

2.SPI和API的使用場(chǎng)景

API （Application Programming Interface）在大多數(shù)情況下，都是實(shí)現(xiàn)方制定接口并完成對(duì)接口的實(shí)現(xiàn)，調(diào)用方僅僅依賴接口調(diào)用，且無權(quán)選擇不同實(shí)現(xiàn)。從使用人員上來說，API 直接被應(yīng)用開發(fā)人員使用。

SPI （Service Provider Interface）是調(diào)用方來制定接口規(guī)范，提供給外部來實(shí)現(xiàn)，調(diào)用方在調(diào)用時(shí)則選擇自己需要的外部實(shí)現(xiàn)。從使用人員上來說，SPI 被框架擴(kuò)展人員使用。

二、開發(fā)步驟

spi開發(fā)中，涉及接口、實(shí)現(xiàn)類、配置文件和服務(wù)加載，具體開發(fā)步驟如下：

定義接口和實(shí)現(xiàn)類(可多個(gè))；

在項(xiàng)目resources目錄下創(chuàng)建META-INF/services文件夾，接著在services文件夾下創(chuàng)建以接口完整類路徑名(包含包路徑和接口名)為文件名的文件，文件內(nèi)容為需要加載的服務(wù)(實(shí)現(xiàn)類)的完整類路徑名，一行一個(gè)；
目錄結(jié)構(gòu)類似：

resources--
|-services--
|-com.dragon.study.spring_boot_main.spi.Hello

文件內(nèi)容類似：

com.dragon.study.spring_boot_main.spi.HelloOne
com.dragon.study.spring_boot_main.spi.HelloTwo

在啟動(dòng)類中加載服務(wù)，代碼類似：

//加載方式一
Iterator<Hello> it = Service.providers(Hello.class);
while(it.hasNext()){
	it.next().hello();
}

//加載方式二
ServiceLoader<Hello> hellos = ServiceLoader.load(Hello.class);
for (Hello h : hellos){
	h.hello();
}

三、使用示例

3.1 定義接口和實(shí)現(xiàn)類

接口：

package com.dragon.study.spring_boot_main.spi;
public interface Hello {
  void hello();
}

實(shí)現(xiàn)類一：

package com.dragon.study.spring_boot_main.spi;
public class HelloOne implements Hello {
  @Override
  public void hello() {
    System.out.println("hello one");
  }
}

實(shí)現(xiàn)類二：

package com.dragon.study.spring_boot_main.spi;
public class HelloTwo implements Hello {
  @Override
  public void hello() {
    System.out.println("hello two");
  }
}

3.2 定義配置文件

在resources/META-INF/services目錄下創(chuàng)建配置文件com.dragon.study.spring_boot_main.spi.Hello，內(nèi)容如下：

com.dragon.study.spring_boot_main.spi.HelloOne
com.dragon.study.spring_boot_main.spi.HelloTwo

3.3 啟動(dòng)類中加載服務(wù)

package com.dragon.study.spring_boot_main.spi;

import sun.misc.Service;

import java.util.Iterator;
import java.util.ServiceLoader;

public class SpiMain {
  public static void main(String[] args) {
    //加載方式一
//    Iterator<Hello> it = Service.providers(Hello.class);
//    while(it.hasNext()){
//      it.next().hello();
//    }

    //加載方式二
    ServiceLoader<Hello> hellos = ServiceLoader.load(Hello.class);
    for (Hello h : hellos){
      h.hello();
    }
  }
}

啟動(dòng)后輸出：