问题 抽象类中的可选方法实现


我正在研究一些框架,我得到了一个抽象类,应该实现它。

现在我得到了用户应该能够配置的其他东西,但它是可选的。

而不是抽象方法:

public abstract class AbstractModule {
    public void doSomething() {
        if (logMessage() != null)
            System.out.println(logMessage());
        doStuff();
    }

    protected abstract String logMessage(); // I'm optional
    protected abstract void doStuff();
}

我想到只是检查一个接口实现:

public interface Log {
    String logMessage();
}

public abstract class AbstractModule {
    public void doSomething() {
        if (this instanceof Log) {
            if (((Log) this).logMessage() != null)
                System.out.println(((Log) this).logMessage());
        }
        doStuff();
    }

    protected abstract void doStuff();
}

因此,如果有人使用接口Log实现AbstractModule,它也会显示消息。我看到的实现者的好处是:她不需要关心实现logMessage(),就像在第一个例子中那样。这是一种有效的方法还是应该以不同的方式完成?

提前致谢!

最好的祝福


3935
2018-01-26 21:58


起源



答案:


我会将Logger作为模块的一个组件,并在抽象类中定义一个默认的无操作记录器。这样你摆脱了 instanceof 并保持灵活性。

interface Log {
    void logMessage();
}

public abstract class AbstractModule {
    protected Log log;

    public AbstractModule(){
        this.log = () -> {};
    }

    public AbstractModule(Log log){
        this.log = log;
    }

    public void doSomething() {        
        log.logMessage();        
        doStuff();
    }

    protected abstract void doStuff();
}

这是一个示例类扩展 AbstractModule

public class Module extends AbstractModule{

    public Module(){
        super(() -> System.out.println("message"));         
    }

    @Override
    protected void doStuff() {
        // do stuff     
    }   

}

如果要公开记录器,可以在抽象类中为记录器定义getter方法:

public Log getLogger(){
    return log;
}

4
2018-01-26 22:21





由于此问题已被标记为 java-8,另一种解决方案是使用 interface 和 default 方法 :

public interface Module {
    public default void doSomething() {
        if (logMessage() != null)
            System.out.println(logMessage());
        doStuff();
    }

    public default String logMessage() { return null; } // I'm optional
    public void doStuff();
}

用法:

class NoLogModule implements Module {
    @Override
    public void doStuff() { }
}

class LogModule implements Module {

    @Override
    public void doStuff() { }

    @Override
    public String logMessage() { return "Message "; }

}

使用这种方法而不是使用此方法的一个优点 抽象 class是你的类现在可以从另一个类扩展。这种方法的一个缺点是你无法阻止某人 覆盖 该 doSomething 方法(基于你的代码,看起来你不关心这个)


5
2018-01-27 10:41





伸手去拿 instanceof 有点代码味道;通常有更好的方法。

我的第一直觉是在基类中使用no-op方法:

class AbstractModule {
  final void doSomething() {
    maybeLogMessage();
  }

  void maybeLogMessage() {}
}

这显然什么也没做;但是你可以在子类中重写:

class Subclass extends AbstractModule {
  @Override void maybeLogMessage() {
    System.out.println("The message");
  }
}

这将打印消息。

如果你不想重复 System.out.println 在所有子类中,您可以从方法返回一个特殊值,以指示不应记录它。例如,您可以要求字符串为非空:

class AbstractModule {
  final void doSomething() {
    String message = logMessage();
    if (!message.isEmpty()) { System.out.println(message); }
  }

  String logMessage() { return ""; }
}

class Subclass extends AbstractModule {
  @Override String logMessage() {
    return "The message";
  }
}

2
2018-01-26 22:09