Mockito匹配Spring RestTemplate getForObject的byte[].class问题求助

为使用Spring RestTemplate发起HTTP请求的API客户端编写单元测试时，需要Mock RestTemplate返回已知byte[]来验证客户端逻辑，但调用getForObject方法时，用Mockito的any()匹配器无法匹配，Mock返回null。需要解决：

1. 让Mockito匹配该调用的方法；
2. 其他可行的实现方案。

问题示例代码：

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

import org.junit.jupiter.api.Test;
import org.springframework.web.client.RestTemplate;

class ByteArrayTest {

  @Test
  void test() {
    byte[] expectedBytes = "expected byte array".getBytes();

    RestTemplate restTemplate = mock(RestTemplate.class);
    when(restTemplate.getForObject(any(), any())).thenReturn(expectedBytes);

    byte[] actualBytes = restTemplate.getForObject("http://localhost", byte[].class);
    assertEquals(expectedBytes, actualBytes);
  }
}

1. 让Mockito正确匹配调用的方法 #

问题根源是RestTemplate有多个getForObject重载方法，无类型限制的any()匹配器无法精准匹配到你调用的getForObject(String, Class<T>)重载，导致Mock失效返回null。可通过以下方式修复：

精准匹配参数类型 #

使用anyString()匹配第一个String类型的URL参数，用eq(byte[].class)精准匹配第二个Class参数，明确指定要Mock的重载方法：

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import org.junit.jupiter.api.Test;
import org.springframework.web.client.RestTemplate;

class ByteArrayTest {

  @Test
  void test() {
    byte[] expectedBytes = "expected byte array".getBytes();

    RestTemplate restTemplate = mock(RestTemplate.class);
    when(restTemplate.getForObject(anyString(), eq(byte[].class))).thenReturn(expectedBytes);

    byte[] actualBytes = restTemplate.getForObject("http://localhost", byte[].class);
    // 用assertArrayEquals逐字节对比数组内容，而非对比引用
    assertArrayEquals(expectedBytes, actualBytes);
  }
}

指定第二个参数的类型为Class #

如果不需要精准匹配具体的Class类型，也可以用any(Class.class)匹配第二个参数，确保Mockito识别到对应的重载方法：

when(restTemplate.getForObject(any(), any(Class.class))).thenReturn(expectedBytes);

2. 其他可行实现方案 #

使用Mockito的doReturn语法 #

doReturn在处理泛型、重载方法时比when...thenReturn更稳定，可避免匹配歧义：

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;

import org.junit.jupiter.api.Test;
import org.springframework.web.client.RestTemplate;

class ByteArrayTest {

  @Test
  void test() {
    byte[] expectedBytes = "expected byte array".getBytes();

    RestTemplate restTemplate = mock(RestTemplate.class);
    doReturn(expectedBytes).when(restTemplate).getForObject(anyString(), eq(byte[].class));

    byte[] actualBytes = restTemplate.getForObject("http://localhost", byte[].class);
    assertArrayEquals(expectedBytes, actualBytes);
  }
}

使用Spring官方的MockRestServiceServer #

Spring提供了专门用于测试RestTemplate的工具类MockRestServiceServer，它模拟真实的HTTP请求响应，比直接Mock RestTemplate方法更贴合实际场景：

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

import org.junit.jupiter.api.Test;
import org.springframework.http.MediaType;
import org.springframework.web.client.RestTemplate;
import org.springframework.test.web.client.MockRestServiceServer;

class ByteArrayTest {

  @Test
  void test() {
    byte[] expectedBytes = "expected byte array".getBytes();

    RestTemplate restTemplate = new RestTemplate();
    MockRestServiceServer server = MockRestServiceServer.createServer(restTemplate);
    
    // 配置预期的请求地址和响应内容
    server.expect(requestTo("http://localhost"))
          .andRespond(withSuccess(expectedBytes, MediaType.APPLICATION_OCTET_STREAM));

    byte[] actualBytes = restTemplate.getForObject("http://localhost", byte[].class);
    assertArrayEquals(expectedBytes, actualBytes);
    // 验证所有预期的请求都已被触发
    server.verify();
  }
}

内容的提问来源于stack exchange，提问作者ramses728