java - 依赖常量值的单元测试代码

Question

考虑以下(完全人为的)示例:

public class Length {
    private static final int MAX_LENGTH = 10;
    private final int length;
    public Length(int length) {
        if (length > MAX_LENGTH)
            throw new IllegalArgumentException("Length too long");
        this.length = length;
    }
}

我想测试当调用长度大于 MAX_LENGTH 时会抛出异常。有多种方法可以对此进行测试，但都有缺点:

@Test(expected = IllegalArgumentException.class)
public void testMaxLength() {
    new Length(11);
}

这复制了测试用例中的常量。如果 MAX_LENGTH 变小，这将不再是边缘情况(尽管显然它应该与单独的情况配对以测试边缘的另一侧)。如果它变大，这将失败并需要手动更改(这可能不是坏事)。

可以通过为 MAX_LENGTH 添加 getter 然后将测试更改为:

来避免这些缺点:

new Length(Length.getMaxLength());

这看起来好多了，因为如果常量发生变化，则不需要更改测试。另一方面，它公开了一个常量，否则该常量将是私有(private)的，并且它具有同时测试两种方法的重大缺陷 - 如果两种方法都被破坏，测试可能会给出误报。

另一种方法是根本不使用常量，而是注入(inject)依赖项:

interface MaxLength {
    int getMaxLength();
}

public class Length {
    public static void setMaxLength(MaxLength maxLength);
}

然后可以将“常量”模拟为测试的一部分(此处使用 Mockito 的示例):

MaxLength mockedLength = mock(MaxLength.class);
when(mokedLength.getMaxLength()).thenReturn(17);
Length.setMaxLength(mockedLength);
new Length(18);

这似乎增加了很多复杂性，但并没有带来多少值(value)(假设没有其他理由注入(inject)依赖项)。

在这个阶段，我更喜欢使用第二种方法来公开常量，而不是在测试中对值进行硬编码。但这对我来说似乎并不理想。有更好的选择吗？还是这些案例缺乏可测试性表明存在设计缺陷？

Answer 1

作为Tim在评论中提到，您的目标是确保您的软件按照规范运行。一个这样的规范可能是最大长度始终为 10，此时就没有必要测试长度为 5 或 15 的世界。

这是要问自己的问题:您希望使用具有不同“常量”值的类的可能性有多大？我在这里引用“常量”是因为如果你以编程方式改变值(value)，它根本不是一个常数，是吗？ :)

• 如果您的值永远不会改变，您根本不能使用符号常量，只需直接与 10 进行比较并基于(比方说)0、3、10 和11. 这可能会使您的代码和测试有点难以理解(“10 从哪里来？11 从哪里来？”)，并且如果您确实有理由改变数字。不推荐。

• 如果您的值可能永远不会改变，您可以像您一样使用私有(private)命名常量(即静态最终字段)。然后您的代码将很容易更改，尽管您的测试将无法自动调整代码的方式。

  • 您还可以放宽包私有(private)可见性，这将可用于同一包中的测试。 Javadoc(例如 /** Package-private for testing.*/)或文档注释(例如 @VisibleForTesting )可能有助于明确您的意图。如果您的常量值旨在不透明且在您的类之外不可用，例如 URL 模板或身份验证 token ，这是一个不错的选择。

  • 您甚至可以将其设为公共(public)常量，您的类的使用者也可以使用它。 对于您的常量长度示例，public static final 字段可能是最好的，假设您系统的其他部分可能想知道它(例如，用于 UI 验证提示或错误消息)。

• 如果您的值可能会改变，您可以按实例接受它，如 new Length(10) 或 new Length() .setMaxLength(10)。 (我认为前者是依赖注入(inject)的一种形式，将常量整数作为依赖。)如果您想在测试中使用不同的值，这也是一个好主意，例如在生产中使用最大长度 2048，但是为了实用起见，针对 10 进行测试。 为了制作一个灵活的长度 validator ，这个选项可能是对静态最终字段的一个很好的升级。

• 只有当您的值可能在实例的生命周期内发生变化时，我才会费心使用 DI 风格的值提供程序。那时，您可以交互式地查询该值，因此它的行为根本不像常量。对于“长度”，这显然是矫枉过正，但对于“最大允许内存”、“最大同时连接数”或其他一些类似的伪常量来说可能不是。

简而言之，您必须决定需要多少控制权，然后您可以从那里选择最直接的选择；作为“默认值”，您可能希望将其设为可见字段或构造函数参数，因为它们往往在简单性和灵 active 之间取得良好的平衡。