17370845950

使用 Mockito 模拟对象时出现 ObjectMapper 错误

Mockito 模拟对象是用于单元测试的特殊对象,与普通的数据结构有很大区别。它们主要用于模拟真实对象的行为,以便在隔离的环境中测试代码。而 Jackson ObjectMapper 的主要功能是将 Java 对象序列化为 JSON 字符串,或将 JSON 字符串反序列化为 Java 对象。当尝试使用 ObjectMapper 序列化 Mockito 模拟对象时,可能会遇到 InvalidDefinitionException 错误。

错误分析

InvalidDefinitionException 错误通常发生在 ObjectMapper 无法找到合适的序列化器来处理对象中的某个成员变量时。Mockito 模拟对象内部包含一些特殊的成员变量,例如 ByteBuddyCrossClassLoaderSerializationSupport,ObjectMapper 默认情况下无法处理这些变量,因此会抛出异常。 异常信息通常如下所示:

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"])

错误重现

以下代码片段可以重现该错误:

import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.io.IOException;

import static org.mockito.Mockito.mock;

public class MockitoObjectMapperErrorTest {

    @Test
    public void testObjectMapperWithMock() throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        try {
            objectMapper.writeValueAsString(mock(Object.class));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

这段代码尝试将一个简单的 Object 类的模拟对象序列化为 JSON 字符串。由于 ObjectMapper 无法处理模拟对象内部的特殊成员,因此会抛出 InvalidDefinitionException 错误。

解决方案

Mockito 模拟对象本身不是为了序列化而设计的。它们的主要目的是模拟对象的行为,以便进行单元测试。因此,最佳实践是避免直接序列化 Mockito 模拟对象

如果确实需要序列化与模拟对象相关的数据,应该:

  1. 提取相关数据: 从模拟对象中提取需要序列化的数据,并将其存储到普通 Java 对象中。
  2. 序列化普通对象: 使用 ObjectMapper 序列化包含相关数据的普通 Java 对象。

示例

假设有一个名为 MyService 的类,它依赖于一个名为 MyRepository 的接口。在单元测试中,可以使用 Mockito 模拟 MyRepository 对象,并验证 MyService 的行为。如果需要序列化 MyService 返回的结果,应该将结果数据提取到普通 Java 对象中,然后进行序列化。

import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class MockitoObjectMapperSolutionTest {

    interface MyRepository {
        String getData();
    }

    static class MyService {
        private MyRepository repository;

        public MyService(MyRepository repository) {
            this.repository = repository;
        }

        public Map processData() {
            String data = repository.getData();
            Map result = new HashMap<>();
            result.put("processedData", "Processed: " + data);
            return result;
        }
    }

    @Test
    public void testObjectMapperWithMockedService() throws IOException {
        MyRepository mockRepository = mock(MyRepository.class);
        when(mockRepository.getData()).thenReturn("Original Data");

        MyService myService = new MyService(mockRepository);
        Map result = myService.processData();

        ObjectMapper objectMapper = new ObjectMapper();
        String jsonResult = objectMapper.writeValueAsString(result);

        System.out.println(jsonResult); // Output: {"processedData":"Processed: Original Data"}
    }
}

在这个例子中,MyRepository 被模拟,MyService 的 processData 方法返回一个 Map 对象。这个 Map 对象是一个普通的数据结构,可以安全地使用 ObjectMapper 进行序列化。

总结

当使用 Mockito 模拟对象时,应避免直接使用 ObjectMapper 序列化模拟对象。应该从模拟对象中提取相关数据,并将其存储到普通 Java 对象中,然后使用 ObjectMapper 序列化普通对象。这样可以避免 InvalidDefinitionException 错误,并确保单元测试的正确性。

注意事项

  • 如果确实需要在某种特殊情况下序列化 Mockito 模拟对象,可以尝试配置 ObjectMapper,使其能够处理模拟对象内部的特殊成员变量。但这通常比较复杂,并且可能会引入其他问题,因此不建议这样做。
  • Mockito 的版本可能会影响序列化行为。建议使用最新版本的 Mockito 和 Jackson,以获得最佳的兼容性和稳定性。