Java SPI机制和使用示例

JAVA SPI 简介

SPI 是 Java 提供的一种服务加载方式,全名为 Service Provider Interface。根据 Java 的 SPI 规范,我们可以定义一个服务接口,具体的实现由对应的实现者去提供,即服务提供者。然后在使用的时候再根据 SPI 的规范去获取对应的服务提供者的服务实现。通过 SPI 服务加载机制进行服务的注册和发现,可以有效的避免在代码中将服务提供者写死。从而可以基于接口编程,实现模块间的解耦。

SPI 机制的约定

1 在 META-INF/services/ 目录中创建以接口全限定名命名的文件,该文件内容为API具体实现类的全限定名

2 使用 ServiceLoader 类动态加载 META-INF 中的实现类

3 如 SPI 的实现类为 Jar 则需要放在主程序 ClassPath 中

4 API 具体实现类必须有一个不带参数的构造方法

SPI 应用场景举例

JDBC

jdbc4.0以前, 开发人员还需要基于Class.forName("xxx")的方式来装载驱动,jdbc4也基于spi的机制来发现驱动提供商了,可以通过METAINF/services/java.sql.Driver文件里指定实现类的方式来暴露驱动提供者.

COMMON-LOGGING

apache最早提供的日志的门面接口。只有接口,没有实现。具体方案由各提供商实现, 发现日志提供商是通过扫描METAINF/services/org.apache.commons.logging.LogFactory配置文件,通过读取该文件的内容找到日志提工商实现类。只要我们的日志实现里包含了这个文件,并在文件里制定 LogFactory工厂接口的实现类即可。

SPI 机制代码示例

接口 People.java

package org.louis.spi.test;

public interface People {
     public String speak();
}

实现类 Chinese.java

package org.louis.spi.test;

public class Chinese implements People{

    public String speak() {

        return "Chinese speak Chinese.";

    }

}

实现类 American.java

package org.louis.spi.test;

public class American implements People{

    public String speak() {

        return "American speak English.";

    }

}

创建一个文件,放置到 META-INF/Services 目录:

文件名:org.louis.spi.test.People

文件内容:

org.louis.spi.test.Chinese
org.louis.spi.test.American

新建一个测试工程,引入以上代码生成的Jar包

测试类SpiTest.java

package org.louis.test;

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

import org.louis.spi.test.People;import org.louis.spi.test.Chinese;import org.louis.spi.test.American;
public class SpiTest {

    public static void main(String[] args) {
        ServiceLoader<People> peoples = ServiceLoader.load(People.class);
        Iterator<IOperation> iterator = peoples.iterator();       while (iterator.hasNext()) {

            People people = iterator.next();

            System.out.println(people.speak());

        }
    }
}

运行结果:

Chinese speak Chinese.

American speak English.

通过上面例子,我们看到,假如我要新加入一个韩国人的实现,那只需要新建一个新的工程,创建一个Koeran类实现People接口,并在自己工程 META-INF/Services 目录下放置一个配置文件指定Koeran实现类,将工程打成Jar包,就完成了一个新的服务实现的开发。



作者:西风小马
出处:https://www.cnblogs.com/xifengxiaoma/
版权所有,欢迎转载,转载请注明原文作者及出处。

原文地址:https://www.cnblogs.com/xifengxiaoma/p/9443922.html

时间: 2024-10-29 04:44:13

Java SPI机制和使用示例的相关文章

JAVA SPI机制分析

简介 SPI的全名为Service Provider Interface,主要是应用于厂商自定义组件或插件中.在java.util.ServiceLoader的文档里有比较详细的介绍.简单的总结下java SPI机制的思想:我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块.xml解析模块.jdbc模块等方案.面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码.一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码.为

你应该了解的 Java SPI 机制

前言 不知大家现在有没有去公司复工,我已经在家办公将近 3 周了,同时也在家呆了一个多月:还好工作并没有受到任何影响,我个人一直觉得远程工作和 IT 行业是非常契合的,这段时间的工作效率甚至比在办公室还高,同时由于我们公司的业务在海外,所以疫情几乎没有造成太多影响. 扯远了,这次主要是想和大家分享一下 Java 的 SPI 机制.周末没啥事,我翻了翻我之前的写的博客 <设计一个可拔插的 IOC 容器>,发现当时的实现并不那么优雅. 还没看过的朋友的我先做个前景提要,当时的需求: 我实现了一个类

Java SPI机制简介

SPI是Service Provider Interfaces的简称.根据Java的SPI规范,我们可以定义一个服务接口,具体的实现由对应的实现者去提供,即Service Provider(服务提供者).然后在使用的时候只要根据SPI的规范去获取对应的服务提供者的服务实现即可.为了便于理解,我们先来看一个使用SPI的示例.下载 假设我们有一个日志服务LogService,其只定义了一个info方法用于输出日志信息,我们希望把它作为SPI,然后具体的实现由对应的服务提供者去实现.LogServic

Java SPI机制原理和使用场景

SPI的全名为Service Provider Interface.这个是针对厂商或者插件的.一般来说对于未知的实现或者对扩展开放的系统,通常会把一些东西抽象出来,抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块.jdbc模块的方案等.这个可以通过我们的抽象工厂方法来理解这个含义,实现是可以又厂商或者开发人员自己实现.由于代码上是处于上层的一个封装者,是不会知道底层怎么去实现,那么只能通过spi的形式,让上层知道应该调用哪个抽象的具体实现.所以这里可以理解为某些jar

Java的SPI机制与简单的示例

一.SPI机制 这里先说下SPI的一个概念,SPI英文为Service Provider Interface单从字面可以理解为Service提供者接口,正如从SPI的名字去理解SPI就是Service提供者接口:我对SPI的定义:提供给服务提供厂商与扩展框架功能的开发者使用的接口. 在我们日常开发的时候都是对问题进行抽象成Api然后就提供各种Api的实现,这些Api的实现都是封装与我们的Jar中或框架中的虽然当我们想要提供一种Api新实现时可以不修改原来代码只需实现该Api就可以提供Api的新实

高级开发必须理解的Java中SPI机制

https://www.jianshu.com/p/46b42f7f593c 本文通过探析JDK提供的,在开源项目中比较常用的Java SPI机制,希望给大家在实际开发实践.学习开源项目提供参考. 1 SPI是什么 SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件. 整体机制图如下: Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制. 系统设计的各个抽象,往

Dubbo的SPI机制与JDK机制的不同及原理分析

从今天开始,将会逐步介绍关于DUbbo的有关知识.首先先简单介绍一下DUbbo的整体概述. 概述 Dubbo是SOA(面向服务架构)服务治理方案的核心框架.用于分布式调用,其重点在于分布式的治理. 简单的来说,可以把它分为四个角色.服务提供方(Provider).服务消费方(Consumer).注册中心和监控中心.通过注册中心对服务进行注册和订阅,通过监控中心对服务进行监控. 核心功能 Remoting:远程通讯,提供对多种NIO框架抽象封装,包括"同步转异步"和"请求-响应

java中的SPI机制

1.定义 SPI 全称为 (Service Provider Interface) ,是JDK内置的一种服务提供发现机制. 一个服务(Service)通常指的是已知的接口或者抽象类,服务提供方就是对这个接口或者抽象类的实现,然后按照SPI 标准存放到资源路径META-INF/services目录下,文件的命名为该服务接口的全限定名. 2.SPI机制的约定 在META-INF/services/目录中创建以Service接口全限定名命名的文件,该文件内容为Service接口具体实现类的全限定名,文

Dubbo 扩展点加载机制:从 Java SPI 到 Dubbo SPI

SPI 全称为 Service Provider Interface,是一种服务发现机制.当程序运行调用接口时,会根据配置文件或默认规则信息加载对应的实现类.所以在程序中并没有直接指定使用接口的哪个实现,而是在外部进行装配. 要想了解 Dubbo 的设计与实现,其中 Dubbo SPI 加载机制是必须了解的,在 Dubbo 中有大量功能的实现都是基于 Dubbo SPI 实现解耦,同时也使得 Dubbo 获得如此好的可扩展性. Java SPI 通过完成一个 Java SPI 的操作来了解它的机