Mockito 模拟对象时 ObjectMapper 报错原因及解决办法

第一段引用上面的摘要：本文深入探讨了在使用 Mockito 模拟对象时，尝试使用 ObjectMapper 将其序列化时可能出现的 InvalidDefinitionException 异常。文章解释了该异常的根本原因：Mockito 模拟对象并非普通数据结构，而是特殊类型的对象，ObjectMapper 无法直接处理。本文将阐述其内部机制，并提供避免此问题的正确方法。

Mockito 是一个流行的 Java 模拟框架，允许开发者在单元测试中创建模拟对象，以隔离被测试代码的依赖项。Jackson ObjectMapper 是一个强大的 Java JSON 处理库，用于在 Java 对象和 JSON 之间进行转换。当尝试使用 ObjectMapper 序列化 Mockito 模拟对象时，可能会遇到 com.fasterxml.jackson.databind.exc.InvalidDefinitionException 异常。 这种异常通常伴随着如下信息：

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class org.mockito.internal.creation.bytebuddy.ByteBuddyCrossClassLoaderSerializationSupport and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS) (through reference chain: org.mockito.codegen.Object$MockitoMock$nY0RyieU["mockitoInterceptor"]->org.mockito.internal.creation.bytebuddy.MockMethodInterceptor["serializationSupport"])

异常原因分析

该异常的根本原因是 Mockito 创建的模拟对象并非标准的数据结构，而是一种特殊类型的对象。Mockito 使用字节码增强技术（如 ByteBuddy）动态生成类，这些类实现了被模拟类的接口或继承了被模拟类。模拟对象内部包含 Mockito 框架所需的元数据和拦截器，用于记录方法调用、设置返回值等。

ObjectMapper 在序列化对象时，会检查对象的成员变量，并尝试找到对应的序列化器。对于基本类型、常见 Java 类型或已注册的自定义类型，ObjectMapper 可以直接处理。然而，Mockito 模拟对象包含 ByteBuddyCrossClassLoaderSerializationSupport 等 Mockito 内部使用的类型，ObjectMapper 默认情况下无法识别这些类型，也无法找到合适的序列化器。因此，抛出 InvalidDefinitionException 异常。

简单来说，Mockito 模拟对象是用于测试的工具，它内部包含了很多用于模拟和验证行为的复杂机制，这些机制对于 JSON 序列化来说是无意义的，并且ObjectMapper无法处理这些内部结构。

解决方案

理解了异常的原因，解决方案也就显而易见了：不要尝试直接序列化 Mockito 模拟对象。

在单元测试中，我们通常关注的是模拟对象的行为和状态，而不是其内部结构。如果需要验证模拟对象的行为，可以使用 Mockito 提供的 verify() 方法来检查方法调用次数、参数等。

如果需要验证被测试代码与模拟对象交互后的结果，应该关注被测试代码的输出，而不是直接序列化模拟对象。例如，如果被测试代码将模拟对象中的某些数据提取出来并进行处理，那么应该验证处理后的数据是否符合预期。

正确的使用方法：

假设我们有一个服务类 MyService，它依赖于一个数据访问对象 MyDAO：

public class MyService {
    private MyDAO myDAO;

    public MyService(MyDAO myDAO) {
        this.myDAO = myDAO;
    }

    public String processData(String input) {
        String data = myDAO.getData(input);
        return "Processed: " + data;
    }
}

interface MyDAO {
    String getData(String input);
}

我们想测试 MyService 的 processData() 方法。 我们应该模拟 MyDAO，并验证 processData() 方法是否正确地调用了 MyDAO 的 getData() 方法，并返回了正确的结果。

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

public class MyServiceTest {

    @Test
    public void testProcessData() {
        // 1. 创建模拟对象
        MyDAO myDAOMock = Mockito.mock(MyDAO.class);

        // 2. 设置模拟对象的行为
        when(myDAOMock.getData("test")).thenReturn("mocked data");

        // 3. 创建被测试对象，并将模拟对象注入
        MyService myService = new MyService(myDAOMock);

        // 4. 调用被测试方法
        String result = myService.processData("test");

        // 5. 验证结果
        assertEquals("Processed: mocked data", result);

        // 6. (可选) 验证模拟对象的方法是否被调用
        Mockito.verify(myDAOMock).getData("test");
    }
}

在这个例子中，我们没有尝试序列化 myDAOMock。我们仅仅是设置了它的行为，验证了它的方法是否被调用，以及验证了 MyService 的返回值是否正确。

总结：

在单元测试中，避免直接序列化 Mockito 模拟对象。关注模拟对象的行为和状态，使用 Mockito 提供的 verify() 方法进行验证。如果需要验证被测试代码与模拟对象交互后的结果，应该关注被测试代码的输出，而不是直接序列化模拟对象。 理解 Mockito 模拟对象的本质，可以避免此类问题的发生，编写更健壮的单元测试。