Java利用SPI实现解耦的示例详解

 更新时间:2023年04月07日 11:20:30   作者:少年的我  
SPI的全称是服务提供接口,可以用其来启动框架的扩展和替换组件。本文将利用SPI实现解耦,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以参考一下

概述

SPI的全称是服务提供接口,可以用其来启动框架的扩展和替换组件。

其本质是利用 接口实现+策略模式+配置文件来实现对实现类的动态加载。

在具体的使用中,存在一些约定:

(1)规定在 classPath 的 META-INF/services/ 下,创建该接口的全名称文件

(2)在该文件中,写入该接口实现类全称(路径+文件名),多个实现类的话,分行写。

(3)用的2时候,使用 java.util.ServiceLoader 的 load(Interface.class),获取到实现类,就可以使用了。

值得注意的是,接口实现类必须有一个不带参数的构造方法。

实现案例

在本应用中,存在两个模块,分别为A模块和B模块,这两个模块中,A模块是主模块,B是从模块,B模块是依赖A模块的。但是在目前有一个类,该类中实现在B模块中,A模块需要调用这个类的函数,而模块不能再依赖B模块,此时需要进行解耦。在本实现中,利用SPI的方式进行解耦实现。具体实现方案为:

(1)在A模块新建一个接口:MyLogAppender,具体实现为:

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

public interface MyLogAppender {

    /**
     * 获取实现的appender
     * @return  返回新建的appender对象
     * */
    Appender getAppender();
}

这个接口很简单,只是返回一个appender的对象。对于对象的实际操作,在接口的实现中进行操作。

(2)在B模块添加对这个接口的实现,具体的操作为:

/**
 * @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("发布日志时,广播失败");
        }
    }

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

在该接口的申明和接口的实现中,存在一些小的技巧的实现。在接口中,只声明一个类的获取,并没有实现具体的方法。在实现类中,对这个类进行实例化,new一个新的类并返回,此时用户根据这个get方法就可以拿到这个实现类,然后进行实现类的一些操作。这样写可以带来两个好处: i. 代码更简洁,接口的代码简单易懂 ii. 可以在实现类的构造方法中注入一些参数,当用户使用时,直接在get方法里面注入即可。

(3) 在实现类所在文件夹下,也就是sandbox-app-epoch-starter中添加一个配置文件,其配置文件的路径默认为: resources/META-INF/services/,在这个文件夹下新建一个问题,文件名为接口的路径,内容是实现类的路径。由此可以实现接口-->实现类的映射。

如上图中,文件名为:com.alibaba.halo.sandbox.app.util.MyLogAppender

其文件中的内容为:com.alibaba.lattice2.epoch.util.MeshLogAppender

其原理是,当用户使用接口时,会扫描项目下的所有文件,查找文件名为com.alibaba.halo.sandbox.app.util.MyLogAppender,然后根据其内容来查找到相关的实现类

(4)在A,可以直接使用接口来进行调用,具体实现如下:

				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);
        }

从上面可以看到,其可以直接调用MyLogAppender接口,利用这个接口获取的Appender,之后直接赋值即可。

优势和不足

优点:可以实现代码的解耦

缺点:存在多个实现类的话,无法根据某个参数或者标志位获取实例,只能通过遍历获取,没有实现所谓的懒加载

到此这篇关于Java利用SPI实现解耦的示例详解的文章就介绍到这了,更多相关Java SPI解耦内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SSM框架中entity mapper dao service controller层的使用

    SSM框架中entity mapper dao service controll

    这篇文章主要介绍了SSM框架中entity mapper dao service controller层的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • Java 实现一个汉诺塔实战练习

    Java 实现一个汉诺塔实战练习

    汉诺塔是源于印度一个古老传说的益智玩具。大梵天创造世界时做了三根石柱,在一根柱子上从下往上按大小顺序摞着64片黄金圆盘。大梵天命令婆罗门把圆盘从下面开始按大小顺序重新摆放在另一根柱子上。并且规定,在小圆盘上不能放大圆盘,三根柱子之间一次只能移动一个圆盘
    2021-10-10
  • Mybatis查询语句返回对象和泛型集合的操作

    Mybatis查询语句返回对象和泛型集合的操作

    这篇文章主要介绍了Mybatis查询语句返回对象和泛型集合的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java实现文件图片的预览和下载功能

    Java实现文件图片的预览和下载功能

    这篇文章主要为大家详细介绍了如何使用Java实现文件图片的预览和下载功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-04-04
  • 快速解决VS Code报错:Java 11 or more recent is required to run. Please download and install a recent JDK

    快速解决VS Code报错:Java 11 or more recent is required to run. Ple

    这篇文章主要介绍了快速解决VS Code报错:Java 11 or more recent is required to run. Please download and install a recent JDK的相关资料,需要的朋友可以参考下
    2020-09-09
  • Java中Velocity快速对变量中的引号特殊字符进行转义

    Java中Velocity快速对变量中的引号特殊字符进行转义

    Velocity是一个基于Java的模板引擎,与Freemarker类似,这篇文章主要介绍了Java中Velocity如何对变量中的引号特殊字符进行转义,主要记录一下在使用中碰到的要对引号特殊字符进行转义的问题,需要的朋友可以参考下
    2023-07-07
  • java防反编译最简单的技巧分享

    java防反编译最简单的技巧分享

    这篇文章主要给大家分享了关于java防反编译最简单的技巧,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧。
    2017-09-09
  • Spring中利用SchedulingConfigurer实现动态定时任务配置的示例

    Spring中利用SchedulingConfigurer实现动态定时任务配置的示例

    定时任务是一项至关重要的功能,它们使得我们能够按照预定的时间执行特定的任务,本文主要介绍了Spring中利用SchedulingConfigurer实现动态定时任务配置的示例,感兴趣的可以了解一下
    2024-05-05
  • java 使用poi动态导出的操作

    java 使用poi动态导出的操作

    这篇文章主要介绍了java 使用poi动态导出的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • IntelliJ IDEA 2022.1.1创建java项目的详细方法步骤

    IntelliJ IDEA 2022.1.1创建java项目的详细方法步骤

    最近安装了IntelliJ IDEA 2022.1.1,发现新版本的窗口还有些变化的,所以下面这篇文章主要给大家介绍了关于IntelliJ IDEA 2022.1.1创建java项目的详细方法步骤,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-07-07

最新评论