Java利用SPI實(shí)現(xiàn)解耦的示例詳解

更新時(shí)間：2023年04月07日 11:20:30 作者：少年的我

SPI的全稱是服務(wù)提供接口，可以用其來啟動(dòng)框架的擴(kuò)展和替換組件。本文將利用SPI實(shí)現(xiàn)解耦，文中的示例代碼講解詳細(xì)，具有一定的借鑒價(jià)值，需要的可以參考一下

概述

SPI的全稱是服務(wù)提供接口，可以用其來啟動(dòng)框架的擴(kuò)展和替換組件。

其本質(zhì)是利用接口實(shí)現(xiàn)+策略模式+配置文件來實(shí)現(xiàn)對(duì)實(shí)現(xiàn)類的動(dòng)態(tài)加載。

在具體的使用中，存在一些約定：

（1）規(guī)定在 classPath 的 META-INF/services/ 下，創(chuàng)建該接口的全名稱文件

（2）在該文件中，寫入該接口實(shí)現(xiàn)類全稱（路徑+文件名），多個(gè)實(shí)現(xiàn)類的話，分行寫。

（3）用的2時(shí)候，使用 java.util.ServiceLoader 的 load(Interface.class)，獲取到實(shí)現(xiàn)類，就可以使用了。

值得注意的是，接口實(shí)現(xiàn)類必須有一個(gè)不帶參數(shù)的構(gòu)造方法。

實(shí)現(xiàn)案例

在本應(yīng)用中，存在兩個(gè)模塊，分別為A模塊和B模塊,這兩個(gè)模塊中，A模塊是主模塊，B是從模塊，B模塊是依賴A模塊的。但是在目前有一個(gè)類，該類中實(shí)現(xiàn)在B模塊中，A模塊需要調(diào)用這個(gè)類的函數(shù)，而模塊不能再依賴B模塊，此時(shí)需要進(jìn)行解耦。在本實(shí)現(xiàn)中，利用SPI的方式進(jìn)行解耦實(shí)現(xiàn)。具體實(shí)現(xiàn)方案為：

（1）在A模塊新建一個(gè)接口：MyLogAppender，具體實(shí)現(xiàn)為：

/**
 * @author Huang gen(kenfeng)
 * @description 自定義的appender接口
 * @Since 2021/02/21
 **/

public interface MyLogAppender {

    /**
     * 獲取實(shí)現(xiàn)的appender
     * @return  返回新建的appender對(duì)象
     * */
    Appender getAppender();
}

這個(gè)接口很簡單，只是返回一個(gè)appender的對(duì)象。對(duì)于對(duì)象的實(shí)際操作，在接口的實(shí)現(xiàn)中進(jìn)行操作。

（2）在B模塊添加對(duì)這個(gè)接口的實(shí)現(xiàn)，具體的操作為：

/**
 * @author Huang gen(kenfeng)
 * @description 自定義的appender
 * @Since 2021/02/21
 **/
@Component
public class MeshLogAppender extends UnsynchronizedAppenderBase<ILoggingEvent> implements MyLogAppender,ApplicationContextAware {

    private ApplicationContext applicationContext;

    public MeshLogAppender(){ }

    @Override
    public Appender getAppender() {
        MeshLogAppender meshLogAppender = new MeshLogAppender();
        return meshLogAppender;
    }

    @Override
    protected void append(ILoggingEvent iLoggingEvent) {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String std = simpleDateFormat.format(new Date(Long.parseLong(String.valueOf(iLoggingEvent.getTimeStamp()))));
        String log = std + "\t" + iLoggingEvent.getLevel() +"\t"+"--- ["+ iLoggingEvent.getThreadName()+"]\t"+iLoggingEvent.getCallerData()[0]+":\t "+iLoggingEvent.getMessage();
        FlowMessage input = new FlowMessage();
        MeshFlowService meshFlowService = SandboxSystemServiceFactory.getService(MeshFlowService.class);
        Map<String, Object> body = new HashMap<>(2);
        body.put("log",log);
        input.setTenantCode(DefaultTenant.get());
        input.setAppCode("epoch");
        input.setFlowCode("log_broadcast");
        input.setBody(body);
        FlowMessage output = meshFlowService.process(input);
        if(!StringUtils.isEmpty(output.getErrorMessage())){
            throw new RuntimeException("發(fā)布日志時(shí)，廣播失敗");
        }
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

在該接口的申明和接口的實(shí)現(xiàn)中，存在一些小的技巧的實(shí)現(xiàn)。在接口中，只聲明一個(gè)類的獲取，并沒有實(shí)現(xiàn)具體的方法。在實(shí)現(xiàn)類中，對(duì)這個(gè)類進(jìn)行實(shí)例化，new一個(gè)新的類并返回，此時(shí)用戶根據(jù)這個(gè)get方法就可以拿到這個(gè)實(shí)現(xiàn)類，然后進(jìn)行實(shí)現(xiàn)類的一些操作。這樣寫可以帶來兩個(gè)好處： i. 代碼更簡潔，接口的代碼簡單易懂 ii. 可以在實(shí)現(xiàn)類的構(gòu)造方法中注入一些參數(shù)，當(dāng)用戶使用時(shí)，直接在get方法里面注入即可。

（3）在實(shí)現(xiàn)類所在文件夾下，也就是sandbox-app-epoch-starter中添加一個(gè)配置文件，其配置文件的路徑默認(rèn)為： resources/META-INF/services/,在這個(gè)文件夾下新建一個(gè)問題，文件名為接口的路徑，內(nèi)容是實(shí)現(xiàn)類的路徑。由此可以實(shí)現(xiàn)接口-->實(shí)現(xiàn)類的映射。

如上圖中，文件名為：com.alibaba.halo.sandbox.app.util.MyLogAppender

其文件中的內(nèi)容為：com.alibaba.lattice2.epoch.util.MeshLogAppender

其原理是，當(dāng)用戶使用接口時(shí)，會(huì)掃描項(xiàng)目下的所有文件，查找文件名為com.alibaba.halo.sandbox.app.util.MyLogAppender，然后根據(jù)其內(nèi)容來查找到相關(guān)的實(shí)現(xiàn)類

（4）在A，可以直接使用接口來進(jìn)行調(diào)用，具體實(shí)現(xiàn)如下：

				ServiceLoader<MyLogAppender> myLoaderInterfaceServiceLoader = ServiceLoader.load(MyLogAppender.class);
        Iterator<MyLogAppender> myLoaderInterfaceIterator = myLoaderInterfaceServiceLoader.iterator();
        while (myLoaderInterfaceIterator.hasNext()){
            MyLogAppender myLoaderInterface = myLoaderInterfaceIterator.next();

            Appender newAppender = myLoaderInterface.getAppender();
            newAppender.setName("application");
            newAppender.setContext(loggerContext);
            newAppender.start();
            rootLogger.addAppender(newAppender);
        }

從上面可以看到，其可以直接調(diào)用MyLogAppender接口，利用這個(gè)接口獲取的Appender，之后直接賦值即可。