如何使用mockito模拟字符串？

Question

我需要模拟一个测试场景，在该场景中调用 String 对象的 getBytes() 方法，并收到 UnsupportedEncodingException。

我尝试使用以下代码来实现这一点：

String nonEncodedString = mock(String.class);
when(nonEncodedString.getBytes(anyString())).thenThrow(new UnsupportedEncodingException("Parsing error."));

问题是，当我运行测试用例时，我得到一个 MockitoException ，它表示我无法模拟 java.lang.String 类。

有没有办法使用mockito来模拟String对象，或者让我的String对象在调用getBytes方法时抛出UnsupportedEncodingException？

---

以下是说明问题的更多详细信息：

这是我要测试的类：

public final class A {
    public static String f(String str){
        try {
            return new String(str.getBytes("UTF-8"));
        } catch (UnsupportedEncodingException e) {
            // This is the catch block that I want to exercise.
            ...
        }
    }
}

这是我的测试类（我正在使用 JUnit 4 和mockito）：

public class TestA {

    @Test(expected=UnsupportedEncodingException.class)
    public void test(){
        String aString = mock(String.class);
        when(nonEncodedString.getBytes(anyString())).thenThrow(new UnsupportedEncodingException("Parsing error."));
        A.f(aString);
    }
}

Answer 1

您无法使用 Mockito 模拟 String。 这与它是 final 无关，因为 Mockito 从 2.0 开始就能够模拟 Final 类，并且从 5.0 开始就能够原生模拟 Final 类。

如果您尝试使用最新版本，您会收到此 MockitoException：

无法模拟/监视类 java.lang.String
Mockito 无法模拟/间谍，因为：
- 无法模拟包装类型、String.class 或 Class.class

这是设计的。

这正在按预期工作。 你不能模拟字符串。 请改用真实的字符串。

Answer 2

如果您可以使用 JMockit，请查看 Rogério 答案。

当且仅当您的目标是获得代码覆盖率而不是实际模拟运行时缺少 UTF-8 的情况时，您可以执行以下操作（并且您不能或不想使用 JMockit）：

public static String f(String str){
    return f(str, "UTF-8");
}

// package private for example
static String f(String str, String charsetName){
    try {
        return new String(str.getBytes(charsetName));
    } catch (UnsupportedEncodingException e) {
        throw new IllegalArgumentException("Unsupported encoding: " + charsetName, e);
    }
}

public class TestA {

    @Test(expected=IllegalArgumentException.class)
    public void testInvalid(){
        A.f(str, "This is not the encoding you are looking for!");
    }

    @Test
    public void testNormal(){
        // TODO do the normal tests with the method taking only 1 parameter
    }
}

Answer 3

您可以更改方法以采用接口 CharSequence：

public final class A {
    public static String f(CharSequence str){
        try {
            return new String(str.getBytes("UTF-8"));
        } catch (UnsupportedEncodingException e) {
            // This is the catch block that I want to exercise.
            ...
        }
    }
}

这样，您仍然可以传入 String，但您可以以任何您喜欢的方式进行模拟。

Answer 4

而不是在设置方法中模拟字符串注入字符串值，如下所示

public void setup() throws IllegalAccessException {
    FieldUtils.writeField(yourTestClass, "stringVariableName", "value", true);
}

Answer 5

如果您有一段永远无法实际运行的代码块，并且管理要求具有 100% 的测试覆盖率，那么就必须进行某些更改。

您可以做的是将字符编码设置为成员变量，然后向您的类添加一个包私有构造函数以允许您将其传入。在单元测试中，您可以调用新的构造函数，并使用字符编码的无意义值。

Answer 6

问题是 Java 中的 String 类被标记为 Final，因此您无法使用传统的模拟框架进行模拟。 根据 Mockito FAQ，这也是该框架的限制。

Answer 7

只创建一个带有错误编码名称的 String 怎么样？ 请参阅

public String(byte bytes[], int offset, int length, String charsetName)

模拟 String 几乎肯定是一个坏主意。

Answer 8

如果您在 catch 块中要做的只是抛出运行时异常，那么您只需使用 Charset 对象来指定字符集名称即可节省一些打字时间。

public final class A{
    public static String f(String str){
        return new String(str.getBytes(Charset.forName("UTF-8")));
    }
}

这样，您就不会仅仅因为编译器告诉您而捕获永远不会发生的异常。

Answer 9

正如其他人所指出的，您不能使用 Mockito 来模拟最终类。 然而，更重要的一点是，该测试并不是特别有用，因为它只是证明 String.getBytes() 可以抛出异常，而它显然可以这样做。 如果您强烈想要测试此功能，我想您可以向 f() 添加一个编码参数，并向测试发送一个错误值。

此外，您还会给 Af() 的调用者带来同样的问题，因为 A 是最终的，而 f() 是静态的。

本文可能有助于说服您的同事不要那么教条地对待 100% 代码覆盖率：如何在 100% 测试覆盖率下失败。

Answer 10

从其文档来看，JDave 无法从引导类加载器加载的类中删除“final”修饰符。 这包括所有 JRE 类（来自 java.lang、java.util 等）。

JMockit 是一个可以模拟任何东西的工具。

使用 JMockit，您的测试可以写成：

import java.io.*;
import org.junit.*;
import mockit.*;

public final class ATest
{
   @Test(expected = UnsupportedOperationException.class)
   public void test() throws Exception
   {
      new Expectations()
      {
         @Mocked("getBytes")
         String aString;

         {
            aString.getBytes(anyString);
            result = new UnsupportedEncodingException("Parsing error.");
         }
      };

      A.f("test");
   }
}

假设完整的“A”类是：

import java.io.*;

public final class A
{
   public static String f(String str)
   {
      try {
         return new String(str.getBytes("UTF-8"));
      }
      catch (UnsupportedEncodingException e) {
         throw new UnsupportedOperationException(e);
      }
   }
}

我实际上在我的机器中执行了这个测试。 （请注意，我将原始检查异常包装在运行时异常中。）

我通过 @Mocked("getBytes") 进行部分模拟，以防止 JMockit 模拟 java.lang.String< 中的所有内容。 /code> class （想象一下这会导致什么）。

现在，这个测试确实没有必要，因为“UTF-8”是一个标准字符集，需要所有JRE都支持。 因此，在生产环境中，catch 块永远不会被执行。

不过，覆盖 catch 块的“需要”或愿望仍然有效。 那么，如何在不降低覆盖率的情况下摆脱测试呢？ 我的想法是：插入一行 assert false; 作为 catch 块内的第一个语句，并让代码覆盖率工具在报告覆盖率测量时忽略整个 catch 块。 这是我的 JMockit Coverage 的“TODO 项目”之一。 8^)

Answer 11

Mockito 无法模拟期末课程。 JMock 可以与 JDave 的库结合起来。 这里是说明。

除了依赖 JDave 库来取消 JVM 中的所有内容之外，JMock 不会对最终类执行任何特殊操作，因此您可以尝试使用 JDave 的取消终结器，看看 Mockito 是否会模拟它。

Answer 12

您还可以使用 PowerMock 的 Mockito 扩展来模拟最终类/方法，甚至在系统类（例如 String）中也是如此。 不过，我也建议不要在这种情况下模拟 getBytes，而是尝试设置您的期望，以便使用填充有预期数据的真实字符串。

Answer 13

您将测试永远无法执行的代码。 每个 Java VM 都需要 UTF-8 支持，请参阅 http://java.sun.com/javase/6/docs/api/java/nio/charset/Charset.html

Answer 14

项目要求单元测试覆盖率必须但高于给定值。 为了达到这样的覆盖百分比，测试必须覆盖相对于 UnsupportedEncodingException 的 catch 块。

给定的覆盖目标是什么？ 有些人会说拍摄 100% 的覆盖率并不总是好主意。

此外，这也无法测试 catch 块是否被执行。 正确的方法是编写一个导致抛出异常的方法，并将观察抛出的异常作为成功标准。 您可以使用 JUnit 的 @Test 注释通过添加“预期”值来执行此操作：

@Test(expected=IndexOutOfBoundsException.class) public void outOfBounds() {
   new ArrayList<Object>().get(1);
}

Answer 15

您是否尝试过将无效的 charsetName 传递给 getBytes(String) ？

您可以实现一个辅助方法来获取 charsetName，并在测试中将该方法重写为无意义的值。

Answer 16

也许 Af(String) 应该改为 Af(CharSequence) 。 您可以模拟 CharSequence。