mokito 编写springboot测试 mock springboot

转载

mob6454cc70863a 2024-06-05 15:00:20

文章标签 junit spring boot 前端 User json 文章分类 架构后端开发

掌握使用JUnit、Spring Boot和Mockito进行Web接口测试的方法。下面是一个简单的步骤，以及如何使用这些框架来模拟测试一个Web接口。

首先，创建一个Spring Boot项目，并在其中添加JUnit、Mockito和Spring Boot Test依赖。在pom.xml文件中添加以下依赖：

<dependencies>
    <!-- Spring Boot Test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- JUnit -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-engine</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- Mockito -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

创建一个REST控制器，例如UserController，包含一个获取用户的Web接口。

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);
        return ResponseEntity.ok(user);
    }
}

创建一个UserService接口及其实现类。在这个示例中，我们将在测试中模拟这个服务。

public interface UserService {
    User getUserById(Long id);
}

@Service
public class UserServiceImpl implements UserService {

    @Override
    public User getUserById(Long id) {
        // 实现获取用户的逻辑
    }
}

创建一个测试类UserControllerTest，并使用@WebMvcTest注解来专门测试UserController。同时使用@MockBean 注解模拟UserService。

@WebMvcTest(UserController.class)
class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    // 测试用例
}

编写测试用例。使用Mockito.when()方法模拟UserService的返回值。通过mockMvc.perform() 方法模拟发送HTTP请求，并使用andExpect()方法验证响应。

@Test
void testGetUserById()throws Exception{
        // 创建一个模拟User对象
        User user=new User(1L,"John Doe",30);

        // 配置UserService的模拟行为
        Mockito.when(userService.getUserById(1L)).thenReturn(user);

        // 发送请求并验证响应
        mockMvc.perform(MockMvcRequestBuilders.get("/users/1"))
        .andExpect(MockMvcResultMatchers.status().isOk())
        .andExpect(MockMvcResultMatchers.jsonPath("$.id").value(1L))
        .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("John Doe"))
        .andExpect(MockMvcResultMatchers.jsonPath("$.age").value(30));
        }

以上示例展示了如何使用JUnit、Spring Boot和Mockito模拟测试一个Web接口。在实际项目中，你可能需要根据自己的需求对这个流程进行调整。以下是一些可能有用的技巧和建议：

为了增强测试覆盖率，可以针对不同的输入和预期输出创建多个测试用例。例如，你可以为正常情况、边界条件和异常情况创建测试用例。

@Test
void testGetUserByIdNotFound()throws Exception{
        // 配置UserService的模拟行为
        Mockito.when(userService.getUserById(2L)).thenReturn(null);

        // 发送请求并验证响应
        mockMvc.perform(MockMvcRequestBuilders.get("/users/2"))
        .andExpect(MockMvcResultMatchers.status().isNotFound());
        }

使用@BeforeEach和@AfterEach注解，可以在每个测试用例执行前后执行一些操作。例如，在测试用例执行前，可以重置模拟对象的状态。

@BeforeEach
void setUp(){
        Mockito.reset(userService);
        }

对于测试带有认证和授权功能的Web接口，可以使用@WithMockUser注解模拟一个已登录的用户。

@Test
@WithMockUser(username = "user", roles = {"USER"})
void testGetUserByIdWithAuthentication()throws Exception{
        // 创建一个模拟User对象
        User user=new User(1L,"John Doe",30);

        // 配置UserService的模拟行为
        Mockito.when(userService.getUserById(1L)).thenReturn(user);

        // 发送请求并验证响应
        mockMvc.perform(MockMvcRequestBuilders.get("/users/1"))
        .andExpect(MockMvcResultMatchers.status().isOk())
        .andExpect(MockMvcResultMatchers.jsonPath("$.id").value(1L))
        .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("John Doe"))
        .andExpect(MockMvcResultMatchers.jsonPath("$.age").value(30));
        }

若要测试异步Web接口，可以使用MvcResult的getAsyncResult()方法等待异步结果。

@Test
void testGetUserByIdAsync()throws Exception{
        // 创建一个模拟User对象
        User user=new User(1L,"John Doe",30);

        // 配置UserService的模拟行为
        Mockito.when(userService.getUserByIdAsync(1L)).thenReturn(CompletableFuture.completedFuture(user));

        // 发送请求并等待异步结果
        MvcResult mvcResult=mockMvc.perform(MockMvcRequestBuilders.get("/users/async/1"))
        .andReturn();
        mvcResult.getAsyncResult();

        // 验证响应
        mockMvc.perform(asyncDispatch(mvcResult))
        .andExpect(MockMvcResultMatchers.status().isOk())
        .andExpect(MockMvcResultMatchers.jsonPath("$.id").value(1L))
        .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("John Doe"))
        .andExpect(MockMvcResultMatchers.jsonPath("$.age").value(30));
        }