java中spi使用

文章目录

java中spi使用一、简介二、开发步骤三、使用示例3.1 定义接口和实现类3.2 定义配置文件3.3 启动类中加载服务

一、简介

java中spi(service provider interface)是jdk内置的一种服务发现机制，可以基于配置，在运行时加载指定服务。java中提供了很多服务提供接口，如jdbc、jndi等。

二、开发步骤

spi开发中，涉及接口、实现类、配置文件和服务加载，具体开发步骤如下：

定义接口和实现类(可多个)；

在项目resources目录下创建META-INF/services文件夹，接着在services文件夹下创建以接口完整类路径名(包含包路径和接口名)为文件名的文件，文件内容为需要加载的服务(实现类)的完整类路径名，一行一个； 目录结构类似：

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

文件内容类似：

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

在启动类中加载服务，代码类似：

//加载方式一 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 定义接口和实现类

接口：

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

实现类一：

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

实现类二：

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目录下创建配置文件com.dragon.study.spring_boot_main.spi.Hello，内容如下：

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

3.3 启动类中加载服务

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(); } } }

启动后输出：

hello one hello two