如何为 Spring Boot 控制器终结点编写单元测试

unit-testing java junit spring-boot spring-test-mvc

2022-08-31 12:38:41

我有一个示例Spring Boot应用程序，其中包含以下内容

引导主类

@SpringBootApplication
public class DemoApplication {

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

控制器

@RestController
@EnableAutoConfiguration
public class HelloWorld {
    @RequestMapping("/")
    String gethelloWorld() {
        return "Hello World!";
    }

}

为控制器编写单元测试的最简单方法是什么？我尝试了以下方法，但它抱怨无法自动连接WebApplicationContext

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = DemoApplication.class)
public class DemoApplicationTests {

    final String BASE_URL = "http://localhost:8080/";

    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

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

    @Test
    public void testSayHelloWorld() throws Exception{

         this.mockMvc.perform(get("/")
                 .accept(MediaType.parseMediaType("application/json;charset=UTF-8")))
                 .andExpect(status().isOk())
                 .andExpect(content().contentType("application/json"));
    }

    @Test
    public void contextLoads() {
    }

}

答案 1

Spring MVC提供了一个独立的设置，支持测试相对简单的控制器，而无需上下文。

通过注册一个或多个@Controller实例并以编程方式配置 Spring MVC 基础结构来构建 MockMvc。这允许完全控制控制器的实例化和初始化及其依赖项，类似于普通的单元测试，同时还可以一次测试一个控制器。

控制器的示例测试可以很简单，例如

public class DemoApplicationTests {

    private MockMvc mockMvc;

    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.standaloneSetup(new HelloWorld()).build();
    }

    @Test
    public void testSayHelloWorld() throws Exception {
        this.mockMvc.perform(get("/")
           .accept(MediaType.parseMediaType("application/json;charset=UTF-8")))
           .andExpect(status().isOk())
           .andExpect(content().contentType("application/json"));

    }
}

答案 2

在Spring Boot中首次亮相的新测试改进可以帮助减少编写此类情况所需的代码量。1.4.M2

测试如下所示：

import static org.springframework.test.web.servlet.request.MockMvcRequestB‌uilders.get; 
import static org.springframework.test.web.servlet.result.MockMvcResultMat‌chers.content; 
import static org.springframework.test.web.servlet.result.MockMvcResultMat‌chers.status;

@RunWith(SpringRunner.class)
@WebMvcTest(HelloWorld.class)
public class UserVehicleControllerTests {
    
    @Autowired
    private MockMvc mockMvc;
    
    @Test
    public void testSayHelloWorld() throws Exception {
        this.mockMvc.perform(get("/").accept(MediaType.parseMediaType("application/json;charset=UTF-8")))
                .andExpect(status().isOk())
                .andExpect(content().contentType("application/json"));
    }
    
}

有关更多详细信息以及文档，请参阅此博客文章