我已经将我的解决方案从蚂蚁转移到了maven。早些时候我在构建后有两个 jar 文件 - API 和 IMPL jar,这个 jar 是相互依赖的,因为 ant 不禁止它。 Maven 禁止交叉依赖,但我在 API jar 中有一些带有 IMPL 类的 Guice 模块。我无法将此类移动到 API,也无法更改此模块。我想找到这样的解决方案:
bind(BitTrackUtils.class).
to(BitTrackUtilsBase.class).
in(Scopes.SINGLETON);
但是使用实现路径而不是"BitTrackUtilsBase.class"。除了反射之外,是否存在解决方案?也许,Guice注释什么的.. 谢谢。
这就是API 和实现通常在您实际上想要从一开始就将两者分离时的设计方式。我认为你应该尝试走这条路,而不是试图修复你笨拙的循环依赖。类要么是 API 的一部分,要么不是。以下架构清楚地说明了这一点。并且可以首先构建 API,而无需实现中的任何内容。因此,Maven将非常乐意满足您的构建要求。
魔术 API.jar
此 JAR 包含您的 API,仅此而已。请注意,这里有一些类,你会发现通常不属于API(例如,提供程序接口),它们确实属于API。
magic-api.jar/
└─ magic/
├─ spi/
| └─ MagicProvider.class
├─ Magician.class
└─ Trick.class
诀窍.java
您的核心 API。
public interface Trick {
void prepare();
void execute();
}
魔术提供者.java
这是您的提供程序,即SPI(服务提供商接口),它允许注册您的实现。是的,这个类是公开的(公共的),但在另一个包中,并记录了一些关于"这仅适用于 SPI"的内容。您正在使用Guice,好吧,知道Guice有一个SPI(好吧,在提供实现的方式方面有些不同,但核心思想是相同的)。
public interface MagicProvider {
Trick getTrick();
}
魔术师.java
此类将允许您通过 SPI 访问Trick
。这有一个基本示例,在整个运行过程中只使用一个MagicProvider
,好吧,您可以发挥创造力并寻找实现,直到找到适合您的实现。例如,如果您有getTrick(String trickName)
,则可以遍历所有MagicProvider
,直到可以提供名为trickName
的技巧。
public class Magician {
private static final ServiceLoader<MagicProvider> providers = ServiceLoader.load(MagicProvider.class);
public static Magician getInstance() {
for(MagicProvider provider: providers) {
if (provider != null) {
return new Magician(provider);
}
}
throw new RuntimeException("No implementation found for MagicProvider");
}
private final MagicProvider provider;
private Magician (MagicProvider provider) {
this.provider = provider;
}
public Trick getTrick() {
return provider.getTrick();
}
}
魔术.jar
这个 JAR 有点不同:在导入之外没有提到 API。所以在这里,责任只是从 API 实现接口。完成后,只需在与提供程序类名完全相同的文件中记下提供程序名称(在本例中为magic.spi.MagicProvider
)。该文件必须位于 JAR 文件的文件夹/META-INF/services/
中。这基本上是注册提供程序的唯一约束。
magic-api.jar/
├─ copperfield/
| ├─ spi/
| | ├─ Copperfield.class
| | └─ CopperfieldModule.class
| └─ HideTheStatueOfLiberty.class
└─ META-INF/
└─ services/
└─ magic.spi.MagicProvider
科波菲尔.java
这是您的 SPI 实现。通常,它是公共的,带有公共构造函数,以便ServiceLoader
可以正确加载它。这是您将使用 Guice 的地方,而不是在 API 中。
public class Copperfield implements MagicProvider {
private final Injector injector;
public Copperfield() {
injector = Guice.createInjector(new CopperfieldModule());
}
public Trick getTrick() {
return injector.getInstance(Trick.class);
}
}
科波菲尔模块.java
您的标准基本 Guice 模块。
class CopperfieldModule extends AbstractModule {
@Override public void configure() {
bind(Trick.class).to(HideTheStatueOfLiberty.class).in(Scopes.SINGLETON);
}
}
隐藏自由女神像.java
这是 API 的真正实现。
public class HideTheStatueOfLiberty implements Trick {
@Override public void prepare() {
System.out.println("Now you see the Statue of Liberty.");
}
public void execute() {
System.out.println("Now you don't!");
}
}
magic.spi.MagicProvider
是的,这是全名,没有其他扩展名(没有.txt
,.java
,.class
,...该名称也是提供程序接口的完全限定的 Java 名称(意思是"带包")。这只是一个包含以下内容的文本文件。仅此而已,仅此而已。确保将其放在/META-INF/services/
.您可以选择添加带有#
符号的注释
# Register Copperfield as a provider
copperfield.spi.Copperfield
用法
这将存在于您的 API 客户端中的某个位置。请注意,您在这里只看到来自 API 的类!
Magician magician = Magician.getInstance();
Trick trick = magician.getTrick();
trick.prepare();
trick.execute();
结果
Now you see the Statue of Liberty.
Now you don't!
笔记
- 如果你不喜欢自己在
/META-INF/services/
中声明一个文件,你可以看看优秀的AutoService(谷歌也)。在这种情况下,您需要做的就是将@AutoService(MagicProvider)
添加到Copperfield
类中,而忘记"无扩展名"文件。