亲宝软件园·资讯

展开

JAVA SPI机制

cloneme01 人气:0

写在前面

Java SPI提供了一种为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,SPI的核心思想就是解耦。

SPI的调用流程

什么是SPI

SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件。Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。在面向对象的编程与设计中,一般推荐模块之间要基于接口编程,模块之间不对实现类进行硬编码,一旦代码里涉及了具体的实现类,就违反了可拔插的原则,如果需要替换另外一种实现,就需要修改代码。

使用场景

使用Java SPI机制的优势是实现解耦,使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离,而不是耦合在一起,应用程序可以根据实际业务情况启用框架扩展或替换框架组件,常见的场景如下:
(1). JDBC加载不同类型的驱动
(2). SLF4J对Log4j/Logback的支持

实现约定

(1). 服务提供者提供接口的具体实现,在JAVA包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名;
(2). 接口具体实现类所在的JAR包需要放在主程序的CLASSPATH中;
(3). 主程序通过java.util.ServiceLoder动态加载具体的实现模块,它通过扫描META-INF/services目录下的配置文件,找到具体实现类并把它加载到JVM中;
(4). SPI的实现类必须携带一个不带参数的构造函数。

四种角色

(1). 提供某种功能的接口(SLF4J 提供了一组接口类)
(2). 提供某种功能接口的具体实现(每个具体的实现需要包含:META-INF/services目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名。Log4j/Logback提供了具体的实现)
(3). 提供发现和加载CLASSPATH中所有的接口具体实现的对象
(4). 客户端(接口的使用者)

关于JAVA SPI详细的介绍请看:JAVA - SPI机制使用详解(一)

基于JAVA原生特性实现的JAVA SPI机制的DEMO

1. 主要角色

主要角色有:接口、多个实现类以及测试客户端,在每个实现类中需要创建信息文件:resources/META-INF/services/接口全限定名一致的文件。接口、多个实现类以及客户端分别在不同的MODULE中。

2. 示例代码

①. 接口:

package com.hadoopx.javax.spi;
public interface Coder {
    public String write();
}

②. 第一个实现类:

package com.hadoopx.javax.spi;
public class Javaer implements Coder {
    public String write() {
        return "I'M JAVA CODER, USE JAVA TO WRITE EVERYTHING.";
    }
}
创建信息说明文件:resources/META-INF/services/com.hadoopx.javax.spi.Coder,
里面的内容为:com.hadoopx.javax.spi.Javaer

③. 第二个实现类:

package com.hadoopx.javax.spi;
public class Rubyer implements Coder {
    public String write() {
        return "I'M RUBY CODER, USE RUBY TO WRITE EVERYTHING.";
    }
}
创建信息说明文件:resources/META-INF/services/com.hadoopx.javax.spi.Coder,
里面的内容为:com.hadoopx.javax.spi.Rubyer

④. 客户端:

添加依赖:
<dependencies>
    <dependency>
        <groupId>com.hadoopx</groupId>
        <artifactId>javax-spi001-javaer</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>com.hadoopx</groupId>
        <artifactId>javax-spi001-rubyer</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>
客户端代码:
package com.hadoopx.javax.spi;
public class MyTest {
    public static void main(String[] args) {
        ServiceLoader<Coder> s = ServiceLoader.load(Coder.class);
        Iterator<Coder> iterator = s.iterator();
        while (iterator.hasNext()) {
            Coder lang =  iterator.next();
            String content = lang.write();
            System.out.println(content);
        }
    }
}

输出结果为:

I'M JAVA CODER, USE JAVA TO WRITE EVERYTHING.
I'M RUBY CODER, USE RUBY TO WRITE EVERYTHING.

3. 说明

在实际的使用过程中,需要指定不同的类型来创建不同的实现类实例。

基于SPRING BOOT实现的JAVA SPI机制的DEMO

注意: 在每个实现类中不需要创建信息文件。

①. 接口:

package com.hadoopx.javax.spi;
public interface Coder {
    public String write();
}

②. 第一个实现类:

package com.hadoopx.javax.spi;
@Service
@Primary
public class Javaer implements Coder {
    public String write() {
        return "I'M JAVA CODER, USE JAVA TO WRITE EVERYTHING.";
    }
}

③. 第二个实现类:

package com.hadoopx.javax.spi;
@Service
public class Rubyer implements Coder {
    public String write() {
        return "I'M RUBY CODER, USE RUBY TO WRITE EVERYTHING.";
    }
}

④. 客户端一:

添加依赖:
<dependencies>
    <dependency>
        <groupId>com.hadoopx</groupId>
        <artifactId>javax-spi002-javaer</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>com.hadoopx</groupId>
        <artifactId>javax-spi002-rubyer</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>
客户端代码:
@RestController
@RequestMapping("/t")
@Api(value = "测试服务", description = "该服务仅仅用于完成验证、学习和测试")
public class TestController {
	// 切换不同的服务
    @Autowired
    @Qualifier("javaer")
    private Coder coder;
    @ApiOperation(value = "测试", notes = "基于SPRING BOOT实现的JAVA SPI机制的DEMO")
    @GetMapping("/spi")
    public String test() {
        System.out.println(coder.write());
        return "ok";
    }
}

输出结果为:

I'M JAVA CODER, USE JAVA TO WRITE EVERYTHING.

⑤. 客户端二:

有时会根据不同的情况,调用不同服务的方法,所以在客户端中需要多增加下面这个文件:

@Service
public class CoderContext {
	// 通过 @Autowired 把Coder所有的实现类注入到map(coders)中.
	// Spring会查找应用的上下文里类型为Coder的Bean, 并把查找到的Bean注入到Map<String, Coder> 或者 List<Coder>中
    @Autowired
    Map<String, Coder> coders;
    public Coder getCoder(String key){
        return coders.get(key);
    }
}
客户端代码:
@RestController
@RequestMapping("/t")
@Api(value = "测试服务", description = "该服务仅仅用于完成验证、学习和测试")
public class TestController {
    @Autowired
    private CoderContext coderContext;
    @ApiOperation(value = "测试", notes = "基于SPRING BOOT实现的JAVA SPI机制的DEMO")
    @GetMapping("/spi")
    public String test(String type) {
        System.out.println(coderContext.getCoder(type).write());
        return "ok";
    }
}

加载全部内容

相关教程
猜你喜欢
用户评论