将私有方法设为公共以进行单元测试…好主意吗?

主持人注:这里已经有39个答案了(有些已经删除了)。在你发表你的答案之前，考虑一下你是否可以为讨论添加一些有意义的东西。你很可能只是在重复别人已经说过的话。

我偶尔发现自己需要将类中的私有方法设为public，只是为了为它编写一些单元测试。

通常这是因为该方法包含类中其他方法之间共享的逻辑，并且单独测试逻辑更整洁，或者另一个原因可能是我想测试同步线程中使用的逻辑，而不必担心线程问题。

其他人发现他们这样做是因为我不喜欢吗?我个人认为，公开一个方法的好处超过了它在类之外没有提供任何服务的问题……

更新

谢谢大家的回答，似乎引起了大家的兴趣。我认为普遍的共识是测试应该通过公共API进行，因为这是使用类的唯一方式，我非常同意这一点。在我上面提到的几个案例中，我会这样做，这是不常见的情况，我认为这样做的好处是值得的。

然而，我可以看到，每个人都指出它不应该真的发生。再仔细想想，我觉得改变你的代码来适应测试是一个坏主意——毕竟我认为测试在某种程度上是一个支持工具，而改变一个系统来“支持一个支持工具”是明显的坏做法。

当前回答

首先查看是否应该将该方法提取到另一个类中并将其设为public。如果不是这样的话，将其设置为包保护，并在Java中使用@VisibleForTesting进行注释。

2011-08-16 13:57:46

其他回答

正如其他人的评论所广泛指出的那样，单元测试应该关注公共API。然而，撇开利弊和论证不考虑，您可以通过使用反射在单元测试中调用私有方法。当然，您需要确保JRE安全性允许这样做。调用私有方法是Spring框架使用它的ReflectionUtils(参见makeAccessible(Method)方法)。

下面是一个带有私有实例方法的小示例类。

public class A {
    private void doSomething() {
        System.out.println("Doing something private.");
    }
}

以及执行私有实例方法的示例类。

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
public class B {
    public static final void main(final String[] args) {
        try {
            Method doSomething = A.class.getDeclaredMethod("doSomething");
            A o = new A();
            //o.doSomething(); // Compile-time error!
            doSomething.setAccessible(true); // If this is not done, you get an IllegalAccessException!
            doSomething.invoke(o);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (SecurityException e) {
            e.printStackTrace();
        }
    }
}

执行B，将打印正在进行私有操作。如果确实需要，可以在单元测试中使用反射来访问私有实例方法。

2011-08-16 16:34:11

首先查看是否应该将该方法提取到另一个类中并将其设为public。如果不是这样的话，将其设置为包保护，并在Java中使用@VisibleForTesting进行注释。

2011-08-16 13:57:46

如果需要，使用反射来访问私有变量。

但实际上，您并不关心类的内部状态，您只想测试公共方法是否在您可以预期的情况下返回您所期望的内容。

2015-07-27 06:28:49

在. net中，有一个叫做PrivateObject的特殊类，专门用于允许您访问类的私有方法。

在MSDN或Stack Overflow上查看更多信息

(我很奇怪，到目前为止还没有人提到它。)

但在某些情况下，这是不够的，在这种情况下，你必须使用反射。

尽管如此，我还是会坚持不测试私有方法的一般建议，然而，像往常一样，总会有例外。