Java的SPI机制与简单的示例

一、SPI机制

这里先说下SPI的一个概念,SPI英文为Service Provider Interface单从字面可以理解为Service提供者接口,正如从SPI的名字去理解SPI就是Service提供者接口;我对SPI的定义:提供给服务提供厂商与扩展框架功能的开发者使用的接口。

在我们日常开发的时候都是对问题进行抽象成Api然后就提供各种Api的实现,这些Api的实现都是封装与我们的Jar中或框架中的虽然当我们想要提供一种Api新实现时可以不修改原来代码只需实现该Api就可以提供Api的新实现,但我们还是生成新Jar或框架(虽然可以通过在代码里扫描某个目录已加载Api的新实现,但这不是Java的机制,只是hack方法),而通过Java SPI机制我们就可以在不修改Jar包或框架的时候为Api提供新实现。

     很多框架都使用了java的SPI机制,如java.sql.Driver的SPI实现(mysql驱动、oracle驱动等)、common-logging的日志接口实现、dubbo的扩展实现等等框架;

 

SPI机制的约定:

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

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

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

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

                                SPI机制结构图

二、SPI机制示例

 

                        实例结构图

IOperation接口:

1
2
3
4
5
6
7
8
/**
  * Created by LX on 2015/3/8.
  */
public  interface  IOperation {
 
     public  int  operation( int  numberA,  int  numberB);
 
}

PlusOperationImpl实现:

1
2
3
4
5
6
7
8
9
10
11
12
import  co.solinx.demo.api.IOperation;
 
/**
  * Created by LX on 2015/3/8.
  */
public  class  PlusOperationImpl  implements  IOperation {
 
     @Override
     public  int  operation( int  numberA,  int  numberB) {
         return  numberA + numberB;
     }
}

SPI接口的实现类:DivisionOperationImpl

1
2
3
4
5
6
7
8
9
10
11
12
import  co.solinx.demo.api.IOperation;
 
/**
  * Created by LX on 2015/3/8.
  */
public  class  DivisionOperationImpl  implements  IOperation {
 
     @Override
     public  int  operation( int  numberA,  int  numberB) {
         return  numberA / numberB;
     }
}

META-INF/Services目录中的文件:

文件名:co.solinx.demo.api.IOperation,内容:co.solinx.demo.spi.DivisionOperationImpl

Main类:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
import  co.solinx.demo.api.IOperation;
import  co.solinx.demo.impl.PlusOperationImpl;
import  co.solinx.demo.spi.DivisionOperationImpl;
 
import  java.util.Iterator;
import  java.util.ServiceLoader;
 
/**
  * Created by LX on 2015/3/8.
  */
public  class  main {
 
     public  static  void  main(String[] args) {
         IOperation plus =  new  PlusOperationImpl();
 
         IOperation division =  new  DivisionOperationImpl();
         System.out.println(plus.operation( 5 3 ));
 
         System.out.println(division.operation( 9 3 ));
 
         ServiceLoader<IOperation> operations = ServiceLoader.load(IOperation. class );
         Iterator<IOperation> operationIterator = operations.iterator();
         System.out.println( "classPath:" +System.getProperty( "java.class.path" ));
         while  (operationIterator.hasNext()) {
             IOperation operation = operationIterator.next();
             System.out.println(operation.operation( 6 3 ));
         }
     }
}

运行结果:

 

如把SPI实现打包为jar需要把jar放在classpath目录中,SPI jar包运行结果:

 

文章首发地址:Solinx

http://www.solinx.co/archives/142

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值