欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Java SPI机制原理及代码实例

程序员文章站 2022-05-26 09:54:02
spi的全名为:service provider interface,大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.serviceloader的文档里有比较详细的介绍。...

spi的全名为:service provider interface,大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.serviceloader的文档里有比较详细的介绍。

简单的总结下 java spi 机制的思想。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。

一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。

java spi 就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似ioc的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。

java spi 的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的meta-inf/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。

而当外部程序装配这个模块的时候,就能通过该jar包meta-inf/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。

基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.serviceloader。

1.common-logging

apache最早提供的日志的门面接口。只有接口,没有实现。具体方案由各提供商实现, 发现日志提供商是通过扫描 meta-inf/services/org.apache.commons.logging.logfactory配置文件,通过读取该文件的内容找到日志提工商实现类。

只要我们的日志实现里包含了这个文件,并在文件里制定 logfactory工厂接口的实现类即可。关注java技术栈微信公众号,在后台回复关键字:java,可以获取更多栈长整理的java技术干货。

2.jdbc

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

一个内容管理系统有一个搜索模块。是基于接口编程的。搜索的实现可能是基于文件系统的搜索,也可能是基于数据库的搜索

接口定义如下:

package my.xyz.spi;
import java.util.list;
public interface search {
 public list serch(string keyword);
}

a公司采用文件系统搜索的方式实现了 search接口,b公司采用了数据库系统的方式实现了search接口。

a公司实现的类:com.a.spi.impl.filesearch

b公司实现的类:com.b.spi.impl.databasesearch

那么a公司发布 实现jar包时,则要在jar包中meta-inf/services/my.xyz.spi.search文件中写下如下内容:

com.a.spi.impl.filesearch

那么b公司发布 实现jar包时,则要在jar包中meta-inf/services/my.xyz.spi.search文件中写下如下内容:

com.b.spi.impl.databasesearch

下面是 spi 测试代码:

package com.xyz.factory;
import java.util.iterator;
import java.util.serviceloader;
import my.xyz.spi.search;
public class searchfactory {
 private searchfactory() {
 }
 public static search newsearch() {
  search search = null;
  serviceloader<search> serviceloader = serviceloader.load(search.class);
  iterator<search> searchs = serviceloader.iterator();
  if (searchs.hasnext()) {
   search = searchs.next();
  }
  return search;
 }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。

相关标签: Java SPI 机制