spring boot 测试接口类-CFANZ编程社区

Spring Boot 测试接口类：完整指南

Spring Boot 是一个开源的 Java 框架，用于快速构建独立的、生产级的基于 Spring 的应用。在开发过程中，测试是确保代码质量和功能正确性的重要环节。本文将重点介绍如何使用 Spring Boot 测试接口类，包括代码示例和最佳实践。

1. 引言

在微服务架构和 RESTful API 的普及下，接口测试变得尤为重要。通过与其他系统或前端组件的集成，可以确保应用的各个部分正常运行。Spring Boot 提供了方便的测试工具，使我们能够轻松编写和运行测试。

2. 架构关系图

在我们的示例中，我们将建立一个简单的用户管理接口。以下是系统的实体关系图：

erDiagram
    USER {
        int id
        string name
        string email
    }

3. 创建 Spring Boot 项目

首先，我们需要一个 Spring Boot 项目。可以使用 [Spring Initializr]( 创建一个新的 Spring Boot 项目，选择如下依赖：

Spring Web
Spring Data JPA
H2 Database (用于测试)

4. 编写用户实体

在 src/main/java/com/example/demo/model 目录下，创建一个名为 User.java 的文件，代码如下：

package com.example.demo.model;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private int id;
    private String name;
    private String email;

    // Getters and Setters
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

5. 创建用户控制器

接下来，在 src/main/java/com/example/demo/controller 目录下，创建名为 UserController.java 的文件，代码如下：

package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserRepository userRepository;

    @GetMapping
    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userRepository.save(user);
    }
}

6. 创建用户仓库

在 src/main/java/com/example/demo/repository 目录下，创建名为 UserRepository.java 的文件，代码如下：

package com.example.demo.repository;

import com.example.demo.model.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Integer> {
}

7. 编写测试代码

Spring Boot 提供了丰富的测试支持。我们将以下代码添加至 src/test/java/com/example/demo 目录，创建一个名为 UserControllerTest.java 的文件。

package com.example.demo;

import com.example.demo.controller.UserController;
import com.example.demo.model.User;
import com.example.demo.repository.UserRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.MockMvc;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private UserRepository userRepository;

    private UserController userController;

    @BeforeEach
    public void setUp() {
        userController = new UserController();
        userController.setUserRepository(userRepository);
    }

    @Test
    public void testCreateUser() throws Exception {
        User user = new User();
        user.setName("John Doe");
        user.setEmail("john@example.com");

        when(userRepository.save(any(User.class))).thenReturn(user);

        MockHttpServletResponse response = mockMvc.perform(post("/users")
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\"name\":\"John Doe\",\"email\":\"john@example.com\"}"))
                .andExpect(status().isOk())
                .andReturn().getResponse();

        assert response.getContentAsString().contains("John Doe");
    }
}