Java 接口 - 普通接口中的常量和静态类

Question

考虑以下界面。

public interface ThirdPartyApiHandler {

    public OperationResult doOperation(OperationInput input);

    public static class OperationResult {
         //members of OpeationResult. metrics after file processing
         private int successfulRecords;
         private int failedRecords;
    }  

    public static class OperationInput {
         //implementations call third party API to process this file.
         private String inputBatchFile; 
    }  

    //Constant which would be same across all implementations.
    public static final int GLOBAL_CONSTANT = 1;
}

上面的界面是不是设计不好？

1. OperationResult 和 OperationInput 被定义为静态类。它们只会被实现使用，而不是其他任何地方。我在这里看到的优势是 - 我不必为这两个类创建单独的文件。他们还获得父类的命名空间。

2. 我已阅读有关常量接口的信息。但在这种情况下，我在普通接口中定义常量，这些常量在所有实现中都是相同的，并且将在这些实现中使用。

我是第一次使用这种模式，所以想得到建议。

Answer 1

Is above interface a bad design?

很简单，是的。

将 any 逻辑放在 interface 中在语义上是不正确的。接口向消费者公开功能 - 这是它的单一目的，不应被淡化。

考虑在基实现类中实现任何通用功能并使用继承，或者在一个或多个服务中并使用组合，在您的不同接口实现中。

编辑 - 引用 Joshua Bloch 的 Effective Java

当一个类实现一个接口时，该接口充当一种可用于引用该类实例的类型。因此，一个类实现了一个接口应该说明客户端可以对类的实例做什么。为任何其他目的定义接口是不合适的。

Answer 2

Is above interface a bad design?

这取决于您的实现设计及其在项目中的可用性。逻辑在我看来都是合法的。这种设计的可能用例如下

public interface A {
    static class B {
        public static boolean verifyState( A a ) {
            return (true if object implementing class A looks to be in a valid state)
        }
    }
}

还有

public static class OperationResult {
     //members of OpeationResult. metrics after file processing
     private int successfulRecords;
     private int failedRecords;
} 

在上面的类中，你有实例变量successedRecords 和 failedRecords 。为什么不将这些静态类的实例变量设为静态，以便您可以使用 ThirdPartyApiHandler.OperationResult.successfulRecords 访问它们。您甚至可以为变量设置静态 getter 和 setter。

---

OperationResult and OperationInput are defined as static inner class.

与流行的看法相反，没有“静态内部类”这样的东西：这根本没有意义，当嵌套类是静态的时，没有“内部”和“外部”类，所以它不能是“静态内部” ”。

从this SO 问题中摘录。阅读第一个答案。我想这会回答你所有的问题。

Answer 3

在接口中拥有嵌套类只是额外命名空间的问题。当创建小接口以支持简单的数据结构时，这种方法有助于组织代码。

我推荐你这个讲座：Java Tip 75: Use nested classes for better organization。

请注意，public 和 static 在这种情况下是多余的，因此您不需要它们。您需要记住的是，拥有这样的类不会限制其他开发人员在代码的其他部分使用它们。

从我的角度来看，这是一个很好的设计，但是我会用接口扩展和替换类。

public interface ThirdPartyApiHandler {

    OperationResult doOperation(OperationInput input);

    interface OperationResult {
         int getSuccessfulRecords();
         int getFailedRecords();
    }  

    interface OperationInput {
         String getInputBatchFile(); 
    }  

    final int GLOBAL_CONSTANT = 1; //This could be replaced by enum but no need 
}

Answer 4

OperationResult 和 OperationInput 被定义为静态内部类。 它们不会在其他任何地方使用。

没关系，因为它们不会在其他任何地方使用。如果它们比我更愿意将它们放在单独的类中。

我已经阅读了关于常量接口的内容。但在这种情况下，我在普通接口中定义常量，这些常量绑定在所有实现中都相同，并且将在这些实现中使用。

这是声明这样一个字段的好地方。