java中SPI服務(wù)提供者的接口使用總結(jié)

更新時(shí)間：2024年10月11日 11:50:45 作者：醉臥雕龍舫、

SPI英文全稱(chēng)為Service?Provider?Interface,顧名思義,服務(wù)提供者接口,它是jdk提供給“服務(wù)提供廠商”或者“插件開(kāi)發(fā)者”使用的接口

一：什么是SPI

SPI：“服務(wù)提供者的接口”，是一種服務(wù)發(fā)現(xiàn)機(jī)制

用于實(shí)現(xiàn)框架或庫(kù)的擴(kuò)展點(diǎn)，允許在運(yùn)行時(shí)動(dòng)態(tài)地插入或更換組件實(shí)現(xiàn)。

它提供了一個(gè)框架(JDK1.6后ServiceLoader)來(lái)發(fā)現(xiàn)和加載服務(wù)實(shí)現(xiàn)，使得軟件模塊能夠靈活地選擇和使用不同的服務(wù)提供商。

在這里插入圖片描述

在java中通俗講就是：

對(duì)框架或第三方j(luò)ar包提供者來(lái)說(shuō)可制定規(guī)范，提供給開(kāi)發(fā)者可擴(kuò)展性
對(duì)開(kāi)發(fā)者來(lái)說(shuō)可以根據(jù)需要輕松替換框架或第三方j(luò)ar包中提供了SPI機(jī)制的接口的實(shí)現(xiàn)

在AJ-Captcha與Nacos中均提供了SPI擴(kuò)展。

二：java SPI示例

1.SPI服務(wù)提供方

SPI服務(wù)提供方架構(gòu)圖：

在這里插入圖片描述

定義接口規(guī)范：

public interface SpiService {
    /**
     * 呼叫方式
     */
    void call();
}

加載具體的服務(wù)實(shí)現(xiàn)：

package com.lmy.config;

import com.lmy.service.SpiService;

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

/**
 * @author : lmy
 * @date : 2024/9/14 上午 11:35
 * 加載具體的服務(wù)實(shí)現(xiàn)
 */
public class SpiServiceLoader {
    private static volatile SpiServiceLoader LOADER;

    private final SpiService spiService;

    private final List<SpiService> spiServiceList;

    /**
     * 加載服務(wù)
     * */
    private SpiServiceLoader() {
        ServiceLoader<SpiService> loader = ServiceLoader.load(SpiService.class);
        List<SpiService> list = new ArrayList<>();
        for (SpiService spiService : loader) {
            list.add(spiService);
        }
        spiServiceList = list;
        if (!list.isEmpty()) {
            // 取第一個(gè)
            spiService = list.get(0);
        } else {
            spiService = null;
        }
    }

    /**
     * SpiServiceLoader 單例加載
     * */
    public static SpiServiceLoader getLOADER() {
        if (LOADER == null) {
            synchronized (SpiServiceLoader.class) {
                if (LOADER == null) {
                    LOADER = new SpiServiceLoader();
                }
            }
        }
        return LOADER;
    }


    public void call(){
        if(spiServiceList.isEmpty()){
            System.out.println("SpiService服務(wù)未加載！");
        }else {
            SpiService spiService = spiServiceList.get(0);
            spiService.call();
        }
    }

}

默認(rèn)實(shí)現(xiàn)：

package com.lmy.service.impl;

import com.lmy.service.SpiService;

/**
 * @author : lmy
 * @date : 2024/9/14 上午 10:58
 * 默認(rèn)實(shí)現(xiàn)
 */
public class SpiServiceImpl implements SpiService {
    @Override
    public void call() {
        System.out.println("默認(rèn)手機(jī)呼叫");
    }
}

指定服務(wù)實(shí)現(xiàn)方式：
須在resource下創(chuàng)建META-INF.services，文件名為接口全限定類(lèi)名，配置為需要被加載的接口實(shí)現(xiàn)類(lèi)的全限定類(lèi)名

在這里插入圖片描述

com.lmy.service.impl.SpiServiceImpl

項(xiàng)目打包發(fā)布本地：

在這里插入圖片描述

2.SPI服務(wù)應(yīng)用方開(kāi)發(fā)者

開(kāi)發(fā)者引入jar包使用服務(wù)：

<dependency>
    <groupId>com.lmy</groupId>
    <artifactId>SPI-interface</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

package com.lmy.Spi;

import com.lmy.config.SpiServiceLoader;
import org.junit.Test;

/**
 * @author : lmy
 * @date : 2024/9/14 上午 11:48
 */
public class SpiTest {

    @Test
    public void spiTest () {
        SpiServiceLoader loader = SpiServiceLoader.getLOADER();
        loader.call();
    }
}

執(zhí)行結(jié)果：

在這里插入圖片描述

開(kāi)發(fā)者根據(jù)需要擴(kuò)展替換為自己的服務(wù)實(shí)現(xiàn)：

package com.lmy.Spi.service;

import com.lmy.service.SpiService;

/**
 * @author : lmy
 * @date : 2024/9/14 下午 2:09
 */
public class SpiServiceNewImpl implements SpiService {
    @Override
    public void call() {
        System.out.println("衛(wèi)星直呼");
    }
}

在這里插入圖片描述