Java的SPI机制

Dubbo等框架使用到必须掌握。

java.sql.Driver 是 Spi,com.mysql.jdbc.Driver 是 Spi 实现,其它的都是 Api。

package org.hadoop.java;

public interface IService {
    public String sayHello();      
    public String getScheme();
}

package org.hadoop.java;

public class HDFSService implements IService {

    @Override
    public String sayHello() {
        return "Hello HDFS!!";
    }

    @Override
    public String getScheme() {
        return "hdfs";
    }
}

package org.hadoop.java;

public class LocalService implements IService {

    @Override
    public String sayHello() {
        return "Hello Local!!";
    }

    @Override
    public String getScheme() {
        return "local";
    }

}

package org.hadoop.java;

import java.util.ServiceLoader;


public class ServiceLoaderTest {
    public static void main(String[] args) {  
        //need to define related class full name in /META-INF/services/....  
        ServiceLoader<IService> serviceLoader = ServiceLoader.load(IService.class);  
        for (IService service : serviceLoader) {
            System.out.println(service.getScheme()+"="+service.sayHello());  
        }  
    }  
}

需要在项目的\src\main\resources\下增加services目录,然后再增加一个文件这个文件是前面的接口的包名+接口名,例如:org.hadoop.java.IService



整个项目



输出:

------------------------------------------------------------------------
Building SPITest 1.0-SNAPSHOT
------------------------------------------------------------------------

--- exec-maven-plugin:1.2.1:exec (default-cli) @ SPITest ---
hdfs=Hello HDFS!!
local=Hello Local!!
------------------------------------------------------------------------
BUILD SUCCESS
------------------------------------------------------------------------
Total time: 0.570s
Finished at: Mon Mar 27 20:45:01 CST 2017
Final Memory: 5M/123M
------------------------------------------------------------------------

参考:设计原则:小议 SPI 和 API

Java spi机制浅谈

java中的SPI机制

1 SPI机制简介
SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思想。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。
2 SPI具体约定
java spi的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader


java.util.ServiceLoader使用

今天在看Hadoop源代的时候发现,在FileSystem中用到了Java.util.ServiceLoader这个类来从配置文件中加载子类或者接口的实现类。以前从来没有使用过这个类,进去大概看了一下具体的实现。主要是从META-INF/services这个目录下的配置文件加载给定接口或者基类的实现,ServiceLoader会根据给定的类的full name来在META-INF/services下面找对应的文件,在这个文件中定义了所有这个类的子类或者接口的实现类,返回一个实例。

### Java 中的 SPI 机制详解 #### 定义与作用 SPI 是 Service Provider Interface 的缩写,是 JDK 内置的一种服务发现机制。通过 SPI 可以使接口与其具体实现解耦合,在运行时动态加载指定的服务实现[^1]。 #### 工作原理 当应用程序启动时,JVM会扫描 `META-INF/services` 文件夹下的配置文件。对于每一个定义好的接口,都会有一个对应的配置文件来指明具体的实现类名称。例如,如果存在名为 `com.example.LoggerService` 接口,则应在资源路径下创建一个名为 `com.example.LoggerService` 的文件,并在此文件中记录该接口的具体实现类名[^2]。 #### 使用案例分析 考虑如下代码片段: ```java public class TestJavaSPI { public static void main(String[] args) { LoggerService loggerService = LoggerService.getService(); loggerService.info("你好"); loggerService.debug("测试Java SPI 机制"); } } ``` 上述例子展示了如何利用 SPI 加载并调用同日志框架的日志功能。这里假设 `LoggerService` 是一个抽象出来的用于获取日志服务实例的方法;而实际执行的日志操作则由特定的日志库(比如 Logback)完成。因此可以看到控制台输出了来自Logback的信息级别和调试级别的消息。 #### 实现方式概述 要让某个接口支持 SPI 功能,开发者只需要遵循一定的约定即可: - 创建接口; - 在项目的 `resources/META-INF/services/` 下建立同包名相同命名规则的文字文件; - 文本文件内容即为对应接口实现者的全限定类名列表,每行一条记录[^3]。 #### 关键特性总结 - **灵活性**: 必硬编码依赖关系,允许外部插件形式接入新的业务逻辑处理单元。 - **可维护性**: 减少了修改源码的需求,便于后期维护和技术栈升级迁移工作。 - **扩展性强**: 支持多版本共存和平滑切换同的算法策略或工具链组件。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值