java - 如何设计内部方法的访问范围？

Question

我们有一个小型轻量级框架，包含大约 20 个类，由 50 多名开发人员和半大型代码库使用。为了保持框架较小，我们避免创建太多的接口(interface)、抽象类等。这是加快新开发人员适应速度并保持较低代码复杂性的权衡。

因此我们不使用内部/外部接口(interface)或大量使用工厂类。我们依靠一些具有公共(public)/私有(private)方法的类来定义范围。然而，有时方法必须是公共(public)的，但只能由框架访问，而不能由开发人员访问。

示例:

public class Logger
    public boolean isDebugEnabled() {...}
    public void enableDebug() {...}

enableDebug 是一种“内部”框架方法，并以“请勿使用 - 内部类”进行记录。由于框架结构的原因，该方法不能是私有(private)的，也不能在包范围内。

开发人员有时会错过 javadoc 并调用可能在运行时产生意外结果的内部方法。

示例:

if (!Logger.isDebugEnabled) {
    Logger.enableDebug(); // screw the javadoc - i'm enabling debug logging
}

框架团队认为最好的方法是按照一定的约定来命名它们。这不会引入编译时安全性，但会降低错误概率。

示例:

public void enableDebugInternal() or _enableDebug() or $enableDebug() 

比

更精确

/**
* Internal method - do not use
*/
public void enableDebug() 

他们正在考虑的另一个选择是将所有内部方法包装到一个内部类中:

public class Logger
    public boolean isDebugEnabled() {...}
    public class Internal {
        public void enableDebug() {...}
    }

您能推荐更好的方法吗？最好是提供编译时安全性的东西

编辑:原来我正在寻找的是java中C#的关键字“internal”的设计模式: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/accessibility-levels

Answer 1

嗯，你几乎回答了你自己的问题。您无法更改访问级别，因此您几乎必须更改其名称。有点 hacky，但您也可以弃用该方法。 Hamcrest 做了一些事情...呃...有趣...与 the Matcher interface达到这个效果。

如果您想强制它不在包之外使用，那么您需要在构建过程中进行某种静态分析。如果我没有其他选择，我会编写一个 Maven 插件来查找用法。

最终，如果您有一个需要表现得像包私有(private)的公共(public)方法，那么听起来您的设计是错误的。

无论如何，您都不应该编写自己的日志外观，尤其是在编写框架时。您应该使用SLF4J .