Java spi详解 示例

  1.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的扩展实现等等框架；

2.使用spi的好处：

将服务接口与服务实现分离以达到解耦、大大提升了程序可扩展性的机制。引入服务提供者就是引入了spi接口的实现者，通过本地的注册发现获取到具体的实现类，轻松可插拔

3.示例

定义一个动作接口

package com.xiaolc.siyu.service;

/**
 * @Author: lc
 * @Date: 2019/12/18 9:56
 */
public interface IOperation {

    int operation(int numberA, int numberB);
}

 

两个不同实现

package com.xiaolc.siyu.service.impl;

import com.xiaolc.siyu.service.IOperation;

/**
 * @Author: lc
 * @Date: 2019/12/18 9:58
 */
public class DivisionOperationImpl implements IOperation {
    @Override
    public int operation(int numberA, int numberB) {
        return numberA / numberB;
    }
}

package com.xiaolc.siyu.service.impl;

import com.xiaolc.siyu.service.IOperation;

/**
 * @Author: lc
 * @Date: 2019/12/18 9:57
 */
public class PlusOperationImpl implements IOperation {
    @Override
    public int operation(int numberA, int numberB) {
        return numberA + numberB;
    }
}

在resources目录下新建 META-INF-》Services（idea建议到文件夹创建）

在services下新建文件按名称为 接口的相对路径

文件里面填写两个实现了的相对路径  多个换行

测试

public static void main(String[] args) {
        IOperation plus = new PlusOperationImpl();
        IOperation division = new DivisionOperationImpl();
        System.out.println(plus.operation(6, 3));
        System.out.println(division.operation(6, 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));
        }
    }

结果