在Spring Boot中测试endpoints,通常使用Spring Boot Test模块和相关的测试工具
- 添加依赖项
确保你的项目中包含了以下依赖:
org.springframework.boot spring-boot-starter-test test
- 创建测试类
在src/test/java
目录下,为你的控制器创建一个测试类。例如,如果你的控制器名为UserController
,则创建一个名为UserControllerTest
的测试类。
- 注解测试类
使用@RunWith(SpringRunner.class)
和@SpringBootTest
注解你的测试类,这将启动一个Spring Boot应用程序实例,并提供自动配置的测试环境。
import org.junit.runner.RunWith; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; @RunWith(SpringRunner.class) @SpringBootTest public class UserControllerTest { // ... }
- 注入所需的组件
使用@Autowired
注解注入你需要测试的控制器、服务或其他组件。
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; import org.springframework.test.web.servlet.MockMvc; @RunWith(SpringRunner.class) @SpringBootTest @WebMvcTest(UserController.class) public class UserControllerTest { @Autowired private MockMvc mockMvc; @Autowired private UserController userController; // ... }
- 编写测试方法
使用mockMvc
对象发送HTTP请求,并使用断言验证返回的结果是否符合预期。
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; // ... public class UserControllerTest { // ... @Test public void testGetUser() throws Exception { mockMvc.perform(get("/users/{id}", 1)) .andExpect(status().isOk()) .andExpect(jsonPath("$.id").value(1)) .andExpect(jsonPath("$.name").value("John Doe")); } @Test public void testCreateUser() throws Exception { String json = "{\"name\":\"Jane Doe\", \"email\":\"jane.doe@example.com\"}"; mockMvc.perform(post("/users") .contentType(MediaType.APPLICATION_JSON) .content(json)) .andExpect(status().isCreated()) .andExpect(header().string("Location", containsString("/users/"))); } // ... }
- 运行测试
使用IDE或Maven命令行工具运行测试。例如,在命令行中输入以下命令:
mvn test
这将运行你的测试并报告结果。如果所有测试都通过,那么你的endpoints应该按预期工作。如果有任何失败的测试,请检查代码以找到问题所在,并进行修复。