ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

在java中使用SPI创建可扩展的应用程序

2022-07-24 09:36:16  阅读:209  来源: 互联网

标签:ModuleService service com 应用程序 SPI module java flydean


简介

什么是可扩展的应用程序呢?可扩展的意思是不需要修改原始代码,就可以扩展应用程序的功能。我们将应用程序做成插件或者模块。

这样可以在不修改原应用的基础上,对系统功能进行升级或者定制化。

本文将会向大家介绍如何通过java中的SPI机制实现这种可扩展的应用程序。

SPI简介

SPI的全称是Java Service Provider Interface。是java提供的一种服务发现的机制。

通过遵循相应的规则编写应用程序之后,就可以使用ServiceLoader来加载相应的服务了。

SPI的实现主要分为4个部分:

Service Provider Interface: SPI是一个interface或者是抽象类,其中定义了我们需要扩展实现的功能。

Service Providers:这是SPI的具体实现,提供了具体的实现功能

SPI Configuration File:SPI的配置文件,通过在配置文件我们来配置相关的SPI发现信息。

ServiceLoader: ServiceLoader是用来加载和发现服务的java类,并提供了很多有用的方法。

SPI的普通java实现

讲完SPI的定义,大家可能还是不清楚SPI到底是做什么的,又该怎么使用它。

不用急,我们下面通过一个例子来说明。

首先创建一个module:SPI-service,里面主要定义了一个ModuleService接口:

public interface ModuleService {}
 

然后再分别创建两个module,作为ModuleService的实现:

public class ModuleServiceA implements ModuleService {

    public ModuleService getModuleService(){
        return new ModuleServiceA();
    }}
public class ModuleServiceB implements ModuleService {

    public ModuleService getModuleService(){
        return new ModuleServiceB();
    }}

接着分别在两个module中创建META-INF/services文件夹,并且在里面创建两个以 Service Provider Interface限定名为名字的文件,这里文件名是:com.flydean.base.service.ModuleService,文件里面存放的是SPI的具体实现类:

com.flydean.base.servicea.ModuleServiceA
com.flydean.base.serviceb.ModuleServiceB
   

最后,我们需要创建一个使用SPI的类:

public class ModuleController {

    public static void main(String[] args) {
        List<ModuleService> moduleServices = ServiceLoader
                .load(ModuleService.class).stream()
                .map(ServiceLoader.Provider::get)
                .collect(toList());
        log.info("{}", moduleServices);
    }}
 

为了更好的展示扩展应用的实际使用,我们分别创建4个模块。在实际应用中,只需要将这些jar包加入应用程序的classpath即可。

运行看下输出结果:

[com.flydean.base.servicea.ModuleServiceA@16f65612, 
com.flydean.base.serviceb.ModuleServiceB@311d617d]

从结果看到,我们获得了两个ModuleService。证明系统扩展成功。

SPI在JPMS模块化系统下的实现

上面我们讲的是基本的操作,考虑一下,如果是在JDK9之后,引入了JPMS模块化系统之后,应该怎么使用SPI呢?

代码肯定是一样,我们需要修改的是SPI配置文件。

如果在JPMS中,我们就不需要使用META-INF/services了,我们只需要创建相应的module-info.java文件即可。

先看下SPI模块的module-info.java文件:

module com.flydean.service {
    exports com.flydean.service;}

这个模块我们对外暴露了service package,供其他模块调用。

 

接下来是SPI的实现模块:

module com.flydean.servicea {
    requires com.flydean.service;
    provides com.flydean.service.ModuleService with com.flydean.servicea.ModuleServiceA;
    exports com.flydean.servicea;}

这里我们使用了provides命令,定义了两个类的关联关系。

 

最后是调用的模块:

module com.flydean.controller {
    uses com.flydean.service.ModuleService;
    requires com.flydean.service;
    requires lombok;
    requires slf4j.api;}

这里我们使用uses关键词来引用ModuleService。

 

总结

本文介绍了SPI在模块化和非模块化系统中的应用。

本文中的例子:https://github.com/ddean2009/learn-java-base-9-to-20

作者小F,金融科技从业多年,懂技术又懂金融,主攻Java和区块链方向,篇篇都是用心之作,笔耕不辍,持续更新!

更多教程请访问码农之家

标签:ModuleService,service,com,应用程序,SPI,module,java,flydean
来源: https://www.cnblogs.com/myhomepages/p/16513875.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有