API设计：一个通用接口VS三个专用接口？

Question

我正在开发一个工具，用户可以使用自己的注释来描述数据处理工作流程（如验证、转换等）。

除了使用现成的注释之外，用户还可以使用自己的注释：为此，他们需要声明注释类本身，然后实现注释处理器（<--这实际上是这个问题的要点）。

配置的数据处理方法可能如下所示：

void foo(@Provide("dataId") @Validate(Validator.class) String str) {    
   doSmth(str); 
}

自然存在三组注释：产生初始值的注释；

1. 产生初始值的注释；产生初始值的注释。
2. 那些转换值的（转换器）；
3. 那些只是读取值并执行一些工作的人（验证者，不同的消费者）。

所以我需要做出选择：要么创建一个接口来处理所有这些类型的注释，它看起来像这样：

interface GenericAnnotationProcessor {    
    Object processAnnotation(Annotation annotation, Object processedValue);
}

或者我可以向 API 添加 3 个接口：

interface ProducerAnnotationProcessor {     
    Object produceInitValue(Annotation annotation);
}

interface TransformerAnnotationProcessor {         
    Object transformValue(Annotation annotation, Object currentValue);
}

interface ConsumerAnnotationProcessor { 
    void consumeValue(Annotation annotation, Object currentValue);
}

第一个选项在使用中不是很清楚，但第三个选项选项用 3 个几乎相似的接口污染了 API。

您会选择什么（首先作为 API 用户）？为什么？

谢谢！

Answer 1

我将创建第一个更通用的接口，然后定义三个不同的实现类。在不了解如何使用它的更多信息的情况下，我的第一直觉是定义接口和/或基类（取决于不同处理器之间共享的公共实现代码的数量），然后在派生中添加专用处理器实现类型，所有这些都共享公共接口。

在使用 API 时，我希望声明一个实现 GenericAnnotationProcessor 的变量，然后根据我的需要分配适当的实现类型。

在俄勒冈州波特兰，现在还很早，但此时此刻，我所需的咖啡因含量为 50%，在我看来，这将提供最大的灵活性，同时最大限度地提高 cade 的重复利用。

当然，您的实际需求可能会有所不同。 。 。

希望这有帮助！

Answer 2

只是深入研究你的问题。

由于他们正在执行类似的任务，但存在一些差异，策略模式#Example应该可以帮助您。

您的问题应该如下所示。

interface GenericAnnotationProcessor {    
    Object processAnnotation(Annotation annotation, Object processedValue);
}

interface ProducerAnnotationProcessor implements GenericAnnotationProcessor {
}

interface TransformerAnnotationProcessor implements GenericAnnotationProcessor {
}

interface ConsumerAnnotationProcessor implements GenericAnnotationProcessor {
}

现在你可以按照Wiki上的例子

class Context {

    // map of annotation processors

    // register(add/remove) annotation processors to the map

    public int executeAnnotationProcessor(Annotation annotation, Object processedValue) {
        return locateAnnotationProcessor(annotation).processAnnotation(annotation, processedValue);
    }

    private GenericAnnotationProcessor locateAnnotationProcessor(Annotation annotation) {
        // return expected annotation processor
    }
}

相信你能理解。

Answer 3

您可以使用扩展接口的接口 更多信息

类似对于类，可以使用extends关键字构建接口的继承层次结构，如下所示：

interface Washable {
    void wash();
}

interface Soakable extends Washable {
    void soak();
}

在本例中，interface Soakable扩展了interface Washable。因此，Soakable 继承了 Washable 的所有成员。实现 Soakable 的类必须为 Soakable 中声明或继承的所有方法（wash() 和 soak()）提供主体，或者声明为抽象方法。请注意，只有接口才能“扩展”其他接口。类不能扩展接口，只能实现接口。

希望有帮助。