基于自定义注解的绑定

Question

我对 stackoverflow 和 guice 都很陌生。我不确定我想做的事情是否可以通过技巧实现，但我确实希望如此。

我的问题领域是我正在尝试编写一个文档阅读系统。我已经为 DocumentReader 定义了一个接口。

public interface DocumentReader {
    MetaData readDocument() throws Exception
}

我还定义了一个定义支持的文件类型（即扩展名）的枚举。

public enum FileType {
    doc,
    png,
    txt,
}

我对每个文件类型都有一个实现，提供了如何解析该文件类型的详细信息。

public class MSWordReaderImpl implements DocumentReader {
    // ....
}

public class PlainTextReaderImpl implements DocumentReader {
    // ....
}

至此，我已经成功编写&测试了一个使用 MapBinder 的模块FactoryModuleProvider 用于注入这些对象中的每一个。存在的每个 DocumentReader 实现都单独添加到 MapBinder。我希望的是，随着 DocumentReader 的其他实现的编写，我可以简单地用它们支持的 FileType 来注释它们，并且 GUICE 将能够读取注释并将它们适当地添加到 MapBinder （无需我每次添加更新模块）。我的设想是这样的：

@SupportedFileTypes( filetypes={ doc, docx } )
public class MSWordReaderImpl implements DocumentReader {
    // ....
}

@SupportedFileTypes( filetypes={txt} )
public class PlainTextReaderImpl implements DocumentReader {
    // ....
}

我已经多次阅读 GUICE 文档，但我只是没有找到实现此目标的方法（如果可能的话！）。任何帮助将不胜感激。

谢谢！

Answer 1

您可以让模块使用反射扫描类将进入的包，查找实现 DocumentReader 并用 @SupportedFileTypes 注释的类。当它找到一个时，将其添加到每种文件类型的 MapBinder 中。

如果您不想扫描类路径，您仍然可以通过编写如下方法来自行简化：

private void bindDocumentReaders(Class<? extends DocumentReader>... types) {
  for (Class<? extends DocumentReader> type : types) {
    FileType[] supportedFileTypes = type.getAnnotation(SupportedFileTypes.class)
        .filetypes();
    // add to MapBinder for each file type
  }
}

Answer 2

了解其工作原理的最简单方法是查看 命名 和 名称 类，以及它的使用方式。

首先创建一个RequiredFileType注释，

@Retention(RUNTIME)
@Target({ ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD })
@BindingAnnotation
public @interface RequiredFileType {
  FileType value();
}

然后注释依赖于文档阅读器的类，

@Inject
ServiceRequiringWordReader(@RequiredFileType(doc) DocumentReader reader)

然后创建一个相当于Names的RequiredFileTypes实用程序（代码省略），并在模块中编写如下代码，

bind(DocumentReader.class)
    .annotatedWith(RequiredFileTypes.for(doc))
    .to(MSWordReaderImpl.class);
bind(DocumentReader.class)
    .annotatedWith(RequiredFileTypes.for(docx))
    .to(MSWordReaderImpl.class);
bind(DocumentReader.class)
    .annotatedWith(RequiredFileTypes.for(txt))
    .to(PlainTextReaderImpl.class);