【java】spi使用

一.spi的定义

1.spi的全称：Service Provider Interface。
2.服务提供者接口、服务发现机制。
3.通过在ClassPath路径下的META-INF/services文件夹中查找文件，并自动加载文件里所定义的类。
4.从java1.6开始引入的，是一种基于ClassLoader来发现并加载服务的机制。
5.ClassLoader除了可以加载类之外，还提供了方法getResource/getResources，可以根据指定的路径，读取classpath中对应的文件。来读取jar包中的配置文件，这样只需要引入jar即可

二.核心组件

1.service:是一个公开的接口或抽象类，定义了一个抽象的功能模块。
2.service provider: 是service接口的一个实现类。
3.ServiceLoader: 是spi机制中的核心组件，负责在运行时发现并加载Service Provider。

三.规范要素

1.文件路径：必须在jar包中的META-INF/services目录下
2.文件名称：Service接口的全限定名
3.文件内容：Service实现类（即Service Provider类）的全限定名。如果有多个实现类，每一个实现类在文件中单独占据一行
4.Service Provider类必须具备无参的默认构造方法。Service接口的实现类Service Provider类，必须具备无参的默认构造方法。后面通过反射技术实例化是不带参数的。
5.保证能加载到配置文件和Service Provider类。
	a.将Service Provider的jar包放到classpath中（常用）
	b.将jar包安装到jre的扩展目录中
	c.自定义一个ClassLoader

四.作用

1.提供了一种组件发现和注册的方式，可以用于实现各种插件，或灵活替换框架所使用的组件。

五.优点

1.基于面向接口编程，优雅实现模块之间解耦

六.设计思想

1.面向接口、配置文件、反射技术

七.应用场景

1.jdbc
2.slf4j
3.servlet容器初始化

八.代码示例

1.父项目

a.pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.learning</groupId>
    <artifactId>spi-learning</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
    	<!--接口模块-->
        <module>api</module>
        <!--移动模块-->
        <module>isp-mobile</module>
        <!--联通模块-->
        <module>isp-unicom</module>
        <!--应用模块-->
        <module>company</module>
    </modules>
</project>

2.api模块

a.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spi-learning</artifactId>
        <groupId>com.learning</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api</artifactId>
</project>

b.InternetService代码

package com.learning.spi;

// 定义spi的service接口
public interface InternetService {
    void connectInternet();
}

3.spi-mobile移动模块

a.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spi-learning</artifactId>
        <groupId>com.learning</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>isp-mobile</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.learning</groupId>
            <artifactId>api</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

b.北京移动

package com.learning.mobile;

import com.learning.spi.InternetService;

/**
 * @Author wangyouhui
 * @Description
 **/
public class BeijingChinaMobile implements InternetService {
    @Override
    public void connectInternet() {
        System.out.println("connect internet by Beijing China Mobile");
    }
}

c.中国移动

package com.learning.mobile;

import com.learning.spi.InternetService;

/**
 * @Author wangyouhui
 * @Description
 **/
public class ChinaMobile implements InternetService {
    @Override
    public void connectInternet() {
        System.out.println("connect internet by [China Mobile]");
    }
}

d.spi配置

com.learning.mobile.ChinaMobile
com.learning.mobile.BeijingChinaMobile

4.spi-unicom联通模块

a.pom.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spi-learning</artifactId>
        <groupId>com.learning</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>isp-unicom</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.learning</groupId>
            <artifactId>api</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

b.中国联通

package com.learning.unicom;

import com.learning.spi.InternetService;

/**
 * @Author wangyouhui
 * @Description TODO
 **/
public class ChinaUnicom implements InternetService {
    @Override
    public void connectInternet() {
        System.out.println("connect internet by [China Unicom]");
    }
}

c.spi配置

com.learning.unicom.ChinaUnicom

5.应用模块

a.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spi-learning</artifactId>
        <groupId>com.learning</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>company</artifactId>

    <dependencies>
        <!-- 移动实现 -->
        <dependency>
            <groupId>com.learning</groupId>
            <artifactId>isp-mobile</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!-- 联通实现 -->
<!--        <dependency>-->
<!--            <groupId>com.learning</groupId>-->
<!--            <artifactId>isp-unicom</artifactId>-->
<!--            <version>1.0-SNAPSHOT</version>-->
<!--        </dependency>-->
    </dependencies>
</project>

b.Application测试代码

import com.learning.spi.InternetService;

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

/**
 * @Author wangyouhui
 * @Description TODO
 **/
public class Application {
    public static void main(String[] args) {
        ServiceLoader<InternetService> load = ServiceLoader.load(InternetService.class);
        Iterator<InternetService> iterator = load.iterator();
        while(iterator.hasNext()){
            InternetService next = iterator.next();
            next.connectInternet();
        }
    }
}

九.相关截图

1.项目结构图

2.应用模块结构图

3.实现接口结构图

4.打印效果图

十.特别注意

新建META-INF/services的时候一定要一层一层创建，如果直接新建META-INF.services的时候，则会创建一层名为META.services的目录，而非二层目录结构，但在idea中展示的却是一样的，从系统文件夹目录中看是不同的，如果没有打印的效果，检查下是否是这个问题导致的。