java spi机制

Java SPI(Service Provider Interface)简介

SPI，Service ProviderInterface，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，mysql和postgresql都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现。

当服务的提供者提供了一种接口的实现之后，需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件，这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候，就可以通过查找这个jar包（一般都是以jar包做依赖）的META-INF/services/中的配置文件，配置文件中有接口的具体实现类名，可以根据这个类名进行加载实例化，就可以使用该服务了。JDK中查找服务的实现的工具类是：java.util.ServiceLoader。

 

1．提供一个接口把它放在META-INF/services目录下，文件的命名为该服务接口的全限定名

 

package com.jd.testjsf.test.spi;

public interface SPIDemoService {
    String sayHello(String msg);
}

 

2. 给这个接口提供多个实现类：把这些实现类的权限的定名放在上面那个文件里面。

比如有这么两个实现类：SPIDemoServiceImplA 和SPIDemoServiceImplB

package com.jd.testjsf.test.spi;
public class SPIDemoServiceImplA implements SPIDemoService {
    @Override
    public String sayHello(String msg) {
        return msg+"AAAAAAAAAAAA";
    }
}

package com.jd.testjsf.test.spi;
public class SPIDemoServiceImplB implements SPIDemoService {
    @Override
    public String sayHello(String msg) {
        return msg+"BBBBBBBBBBBB";
    }
}

把要注入的实现类的权限的名写到文件里面

#实现类A
com.jd.testjsf.test.spi.SPIDemoServiceImplA
#实现类B
com.jd.testjsf.test.spi.SPIDemoServiceImplB

3. 然后，可以通过ServiceLoader.load(Classclass); 来动态加载Service的实现类。

package com.jd.testjsf.test.spi;

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


public class RunSpiDemoService {
    public static void main(String[] args) {
        ServiceLoader<SPIDemoService> demoServices = ServiceLoader.load(SPIDemoService.class);
        Iterator<SPIDemoService> iterator = demoServices.iterator();
        while (iterator!=null && iterator.hasNext()){
            SPIDemoService next = iterator.next();
            System.out.println(next.sayHello("hello "));
        }
    }
}

运行结果：

 

优点：把实现类的注入由程序内部转移到了程序外部，这样基于SPI机制，可以很方便地构建出易于扩展的应用，方便模块化编程，方便标准的定义

 

缺点：只能通过遍历全部获取，也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类，它也被加载并实例化了，这就造成了浪费。

获取某个实现类的方式不够灵活，只能通过Iterator形式获取，不能根据某个参数来获取对应的实现类