Java SPI - Service Provider Interface

2019独角兽企业重金招聘Python工程师标准>>>

Java SPI_Service Provider Interface

最近看到公司的一些框架和之前看到的开源的一些框架的一些服务发现和接入都采用了java的spi机制。所以简单的总结下java spi机制的思想。

我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。 

 

为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。

 

Java SPI的具体约定如下 ：当服务的提供者，提供了服务接口的一种实现之后，在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。 

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

 

示例如下，使用Java SPI机制实现Compatator接口的服务实现。

package com.usoft;

/**
 * Created by xinxingegeya on 15/12/29.
 */
public class MyItem {

    private String name;
    private int level;

    public MyItem(String name, int level) {
        this.name = name;
        this.level = level;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getLevel() {
        return level;
    }

    public void setLevel(int level) {
        this.level = level;
    }

    @Override
    public String toString() {
        return "MyItem{" + "level=" + level + ", name='" + name + '\'' + '}';
    }
}

Comparator实现一：

package com.usoft;

import java.util.Comparator;

/**
 * Created by xinxingegeya on 15/12/29.
 */
public class ComparatorProviderByLevel implements Comparator<MyItem> {
    @Override
    public int compare(MyItem o1, MyItem o2) {
        return o1.getLevel() - o2.getLevel();
    }
}

Comparator实现二：

package com.usoft;

import java.util.Comparator;

/**
 * Created by xinxingegeya on 15/12/29.
 */
public class ComparatorProviderByName implements Comparator<MyItem> {
    @Override
    public int compare(MyItem o1, MyItem o2) {
        return o1.getName().compareTo(o2.getName());
    }
}

classpath路径下的META-INF/services路径下建立以接口为名的文件，

java.util.Comparator

#为注释

#com.usoft.ComparatorProviderByName
com.usoft.ComparatorProviderByLevel

Main方法，

package com.usoft;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.ServiceLoader;

/**
 * Created by xinxingegeya on 15/12/29.
 */
public class Main {

    private static ServiceLoader<Comparator> serviceLoader = ServiceLoader
        .load(Comparator.class, Thread.currentThread().getContextClassLoader());

    public static void main(String args[]) {
        List<MyItem> myList = new ArrayList<>();
        myList.add(new MyItem("c", 2));
        myList.add(new MyItem("a", 7));
        myList.add(new MyItem("d", 4));
        myList.add(new MyItem("b", 5));
//        Collections.sort(myList, new Comparator<MyItem>() {
//            @Override
//            public int compare(MyItem o1, MyItem o2) {
//                return o1.getLevel() - o2.getLevel();
//            }
//        });

        Collections.sort(myList, getComparator());
        showMyList(myList);

    }

    private static void showMyList(List<MyItem> list) {
        list.forEach(System.out::println);
    }

    private static Comparator<MyItem> getComparator() {
        for (Comparator<MyItem> comparator : serviceLoader) {
            System.out.println(comparator.getClass().getName());
            return comparator;
        }
        throw new RuntimeException("comparator is not found");
    }
}

参考文献：

http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html

=========END=========

转载于:https://my.oschina.net/xinxingegeya/blog/552996