【JAVA】使用Java SPI ServiceLoader进行Java应用插件模块化开发

时间:2021-09-25 17:23:54

背景:在进行业务定制时需要考虑不同接口的服务实现,每个局点所要求的接口大体都不一致,要求接口服务能够插件化方式提供;

方案分析:

1)采用OSGI框架进行开发,但是考虑到OSGI的框架太重,需要引入的东西比较多,放弃了该方案;

2)采用Java class loader动态加载外部jar机制,动态加载定制的接口服务类,这种方式实现比较复杂,需要完成指定接口服务类的文件加载,同时需要能查找到所有接口服务类,作为备选方案;

3)使用java service provider interface(SPI)机制构建插件化java应用框架,不需要引入新的外部框架,实现也简单,最为优选方案

下面描述使用Java SPI如何实现插件化服务框架开发过程:

1)创建接口服务工程SPI-Service,该工程提供了服务的接口类或抽象类,所有定制的接口服务类都实现或继承该接口完成业务的定制;

2)创建接口实现服务工程SPI-CN-Service,该工程提供了服务接口的定制实现类;该工程导出为jar文件时需要将META-INF目录及其包含的文件都包含在jar文件中;

3)创建接口服务测试工程SPI-Service-Client,该工程提供了如何根据SPI ServiceLoader机制调用定制的服务;

   该工程需要将1)和2)步骤创建的工程打包为jar文件添加到该工程的classpath中

4)工程示意图

   【JAVA】使用Java SPI ServiceLoader进行Java应用插件模块化开发


5) ITimeService.java

package hxb.spi.service;
public abstract class ITimeService {
private String serviceName;

public abstract String getCurrentTime();
public String getServiceName() {
return serviceName;
}
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
}

6)CNTimeService.java

package hxb.spi.service;import java.text.SimpleDateFormat;import java.util.Date;public class CNTimeService extends ITimeService {public CNTimeService(){super.setServiceName("CN-Time-Service");}@Overridepublic String getCurrentTime() {SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");return getServiceName()+":"+sdf.format(new Date());}}

7) USTimeService.java

package hxb.spi.service;import java.text.SimpleDateFormat;import java.util.Date;public class USTimeService extends ITimeService {public USTimeService(){super.setServiceName("US-Time-Service");}@Overridepublic String getCurrentTime() {SimpleDateFormat sdf = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");return getServiceName()+":"+sdf.format(new Date());}}

8) META-INF/services/hxb.spi.service.ITimeService文件

hxb.spi.service.CNTimeServicehxb.spi.service.USTimeServ

9)测试类SPIClient.java

package hxb.spi.test;import hxb.spi.service.ITimeService;import java.util.ServiceLoader;public class SPIClient {public static void main(String[] args) {ServiceLoader<ITimeService> sloader = ServiceLoader.load(ITimeService.class);for (ITimeService iTimeService : sloader) {System.out.println(iTimeService.getCurrentTime());}}}


本文出自 “开普技术” 博客,请务必保留此出处http://kypulo.blog.51cto.com/9227739/1541802