Springboot 动态调用特定接口在不同的jar包里的实现

在不少场景下，会有根据不同的标识（字符串）来调用不同的接口实现类的需求。笔者目前的场景类似，但是复杂一些。

1. 常规的实现

常规的实现非常简单，大概代码如下：

public interface iTest {
    String testfunction();
}
public class Test1 implements iTest{
    @Override
    public String testfunction() {
        return "tes1......................";
    }
}
public class Test2 implements iTest {
    @Override
    public String testfunction() {
        return "test2-------------------------";
    }
}
public class Main{
    Map<String,iTest> map = new HashMap<>();
    map.put("test1",new Test1());
    map.put("test2",new Test2());
    iTest test1 = map.get("test1");
    test1.testfunction();
}

2. 分不同的 jar 包

在我们的场景里，也就是上面的例子 iTest，Test1，Test2，Main 4个类都分别对应不同的项目，不同的 jar 包。另外 Springboot 不需要显式的添加到 map 里，通过 Service 注解可以自动注入实现类，这一点比较方便。

image.png

如上图，创建一个主项目和3个 Module ，其实也可以创建4个项目，但是用 Module 调试比较方便看代码：
第一个是接口项目，对应 itest-1.0.0.jar

public interface iTest {
    String testfunction();
}

接下来是接口的实现项目1和2，对应 test1-1.0.0.jar和test2-1.0.0.jar, 注意这里给这二个类注解里分别添加一个字符串名称 TEST1_SERVICE 和 TEST2_SERVICE

@Service("TEST1_SERVICE")
public class Test1 implements iTest{
    @Override
    public String testfunction() {
        return "tes1......................";
    }
}

@Service("TEST2_SERVICE")
public class Test2 implements iTest{
    @Override
    public String testfunction() {
        return "tes2......................";
    }
}

主项目对这几个项目的使用利用 Springboot 的机制在构造函数里传递一个 Map 参数，对应的 Value 类型是 iTest 接口，就可以实现自动的注入接口的实现类，对应的 Key 就是 TEST1_SERVICE 和 TEST2_SERVICE：

@Service
public class TestContext {

    private final Map<String, iTest> iTestMap;

    public TestContext(Map<String, iTest> iTestMap) {
        this.iTestMap = iTestMap;
    }

    public iTest getiTest(String name) {
        return iTestMap.get(name);
    }
}

对应的使用就很简单了，根据字符串标识从 map 里获取对象

iTest test1 = this.context.getiTest("TEST1_SERVICE");
System.out.println(test1.testfunction());
iTest test2 = this.context.getiTest("TEST2_SERVICE");
System.out.println(test2.testfunction());

3. 要注意的几点

为了确保主项目能扫码并注入这2个实现类，需要约定一下，所有的项目的 Package 名都是统一的，目前示例里约定为 d1 开头，这样加上扫描范围就能找到：

image.png
为了确保主项目能编译通过，在主项目的 build.gradle 里需要引用依赖的 module ，但是又希望最后主项目 build 的 jar 里不要包含其它三个项目的 jar ，则得用 compileOnly 依赖关键字

image.png

这里注意 test1 项目并不是必须依赖的，只不过 IDEA 比较智能，发现 iTest 对应的实现类一个都没找到，就会提示错误。

4. 多 jar 包的运行方式

最后4个 jar 运行的方式是先 build 出4个jar，然后把3个放在 libs 目录下：

image.png

主的 jar 在上级目录，执行命令如下：

java -Djava.ext.dirs=./libs -jar webapisample.jar

这样运行启动后，主 jar 会自动扫描 libs 目录，把所有 jar 都依赖引用上，执行也没有问题，最后 test1 和 test2 的 testfunction 函数都执行成功。

所有的源码参考 git

最后编辑于：2022.03.28 10:32:20