使用RestTemplate测试RESTful服务

Question

在我的应用程序中，我有很多REST服务。我已经编写了所有服务的测试：

org.springframework.web.client.RestTemplate

REST服务调用（例如）如下所示：

final String loginResponse = restTemplate.exchange("http://localhost:8080/api/v1/xy", HttpMethod.POST, httpEntity, String.class)
        .getBody();

然后我检查了响应体-一切正常。缺点是，必须启动应用程序才能调用REST服务。

我现在的问题是如何在我的JUnit-@Test方法中做到这一点？它是一个Spring Boot应用程序（带有嵌入式tomcat）。

谢谢帮忙！

Answer 1

由于您使用的是Spring MVC for REST，因此我建议您使用通过实例化MockMVC（）提供的测试工具—启用测试，例如：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {
 ... // any required Spring config
)
@WebAppConfiguration
public class RestControllerTest {

    @Autowired
    private WebApplicationContext context;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
    }


    @Test
    public void getUserList() throws Exception {
        mockMvc.perform(get("/user"))
            .andExpect(status().isOk())
            .andExpect(content().contentType("application/json;charset=UTF-8")) 
            .andExpect(content().encoding("UTF-8"))
            .andExpect(jsonPath("$", hasSize(8)))
            .andExpect(jsonPath("$[0].id").exists())
            .andExpect(jsonPath("$[0].alias").exists())
            .andExpect(jsonPath("$[0].name").exists())
        );
    }
}

此单元测试将在不部署的情况下测试REST接口。具体来说，是否只返回8个用户，并且第一个用户具有“id”、“alias”和“name”字段。

jsonPath断言需要两个依赖项：

'com.jayway.jsonpath:json-path:0.8.1'
'com.jayway.jsonpath:json-path-assert:0.8.1'

也许还有：

'org.springframework:spring-test:4.1.7.RELEASE'

Answer 2

如果您不是在寻找端到端（integration）测试，MockRestServiceServer可能会对您有所帮助。我发现将测试用例与实际服务分离非常有用。

Spring doc说：

用于涉及直接或间接使用RestTemplate的测试。提供了一种设置预期请求的方法，这些请求将通过RestTemplate执行，并提供模拟响应以发送回，从而消除了对实际服务器的需要。

这是官方文件

还有一个提示是，requestTo不能自动导入

server.expect(manyTimes(), requestTo("/hotels/42")) ....

这是org的静态方法。springframework。测验网状物客户火柴MockRestRequestMatchers

Answer 3

文档中有一个关于这方面的好章节，我建议您通读它以充分了解您可以做什么。

我喜欢使用带有自定义配置的@IntegrationTest，因为这样可以启动整个服务器，并让您测试整个系统。如果您想用mock替换系统的某些部分，可以通过排除某些配置或bean并用您自己的替换它们来实现。

这里有一个小例子。我忽略了MessageService接口，因为从IndexController中可以明显看出它的作用，并且它是默认实现-DefaultMessageService-因为它不相关。

它所做的是，它旋转整个应用程序减去DefaultMessageService，而是使用它自己的MessageService。然后，它使用RestTemboard向测试用例中正在运行的应用程序发出真正的HTTP请求。

应用程序类别：

emo.java：

@SpringBootApplication
public class IntegrationTestDemo {

    public static void main(String[] args) {
        SpringApplication.run(IntegrationTestDemo.class, args);
    }

}

IndexController.java：

@RestController
public class IndexController {

    @Autowired
    MessageService messageService;

    @RequestMapping("/")
    String getMessage() {
        return messageService.getMessage();
    }
}

测试类：

IntegrationTestDemost。爪哇：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfig.class)
@WebIntegrationTest // This will start the server on a random port
public class IntegrationTestDemoTest {

    // This will hold the port number the server was started on
    @Value("${local.server.port}")
    int port;

    final RestTemplate template = new RestTemplate();

    @Test
    public void testGetMessage() {
        String message = template.getForObject("http://localhost:" + port + "/", String.class);

        Assert.assertEquals("This is a test message", message);
    }
}

TestConfig.java：

@SpringBootApplication
@ComponentScan(
    excludeFilters = {
        // Exclude the default message service
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = DefaultMessageService.class),
        // Exclude the default boot application or it's
        // @ComponentScan will pull in the default message service
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = IntegrationTestDemo.class)
    }
)
public class TestConfig {

    @Bean
    // Define our own test message service
    MessageService mockMessageService() {
        return new MessageService() {
            @Override
            public String getMessage() {
                return "This is a test message";
            }
        };
    }
}