Java SPI模块化解耦的技术指南_Java

1、简述

java 的 service provider interface (spi) 是一种提供模块化和扩展性的方法，使得程序能够通过动态加载服务实现类来实现解耦。本文将详细介绍 java spi 的机制、应用场景及实现步骤，并通过示例代码展示如何使用 spi。

2、java spi 是什么？

spi 是 java 提供的一种服务发现机制，允许模块化开发中的服务实现类被动态加载，而无需硬编码具体实现类。
主要特点包括：

解耦：服务提供者和消费者之间通过接口进行通信。
动态加载：在运行时发现并加载实现类。
扩展性：便于插件化开发。

2.1 spi 的核心组成

服务接口：定义服务的规范或功能。
服务提供者：实现服务接口。
服务加载器：通过 java.util.serviceloader 动态加载服务实现。

2.2 spi 的使用步骤

定义服务接口：
创建一个公共接口，定义服务的规范。
创建服务实现类：
编写一个或多个服务接口的实现类。
创建 meta-inf/services 文件：
在资源目录下创建 meta-inf/services/{服务接口全限定名} 文件，并在其中列出服务实现类的全限定名。
加载服务实现：
使用 serviceloader 动态加载服务实现。

3、spi 实践样例

3.1 定义服务接口

package com.example.spi;

public interface greetingservice {
    void sayhello(string name);
}

3.2 创建服务实现类

实现类 1：

package com.example.spi.impl;

import com.example.spi.greetingservice;

public class englishgreetingservice implements greetingservice {
    @override
    public void sayhello(string name) {
        system.out.println("hello, " + name + "!");
    }
}

实现类 2：

package com.example.spi.impl;

import com.example.spi.greetingservice;

public class chinesegreetingservice implements greetingservice {
    @override
    public void sayhello(string name) {
        system.out.println("你好, " + name + "!");
    }
}

3.3 创建 meta-inf/services 文件

在 resources 目录下创建 meta-inf/services/com.example.spi.greetingservice 文件，内容如下：

com.example.spi.impl.englishgreetingservice
com.example.spi.impl.chinesegreetingservice

3.4 使用 serviceloader 动态加载服务

package com.example.spi;

import java.util.serviceloader;

public class spidemo {
    public static void main(string[] args) {
        serviceloader<greetingservice> services = serviceloader.load(greetingservice.class);
        for (greetingservice service : services) {
            service.sayhello("java developer");
        }
    }
}

运行结果：

hello, java developer!
你好, java developer!

4、扩展：手写一个简单的 spi 加载器

如果不想依赖 serviceloader，可以自己实现 spi 加载器：

package com.example.spi;

import java.util.arraylist;
import java.util.list;

public class customserviceloader<t> {

    private class<t> service;

    public customserviceloader(class<t> service) {
        this.service = service;
    }

    public list<t> loadservices() {
        list<t> services = new arraylist<>();
        string servicefile = "meta-inf/services/" + service.getname();
        try {
            // 从 classpath 加载配置文件
            var resources = thread.currentthread().getcontextclassloader().getresources(servicefile);
            while (resources.hasmoreelements()) {
                var url = resources.nextelement();
                try (var reader = new java.io.bufferedreader(new java.io.inputstreamreader(url.openstream()))) {
                    string line;
                    while ((line = reader.readline()) != null) {
                        line = line.trim();
                        if (!line.isempty()) {
                            // 动态加载类
                            class<?> clazz = class.forname(line);
                            services.add(service.cast(clazz.getdeclaredconstructor().newinstance()));
                        }
                    }
                }
            }
        } catch (exception e) {
            e.printstacktrace();
        }
        return services;
    }
}

使用自定义加载器：

package com.example.spi;

public class customspidemo {
    public static void main(string[] args) {
        customserviceloader<greetingservice> loader = new customserviceloader<>(greetingservice.class);
        var services = loader.loadservices();
        for (greetingservice service : services) {
            service.sayhello("custom spi");
        }
    }
}