使用 Mockito 进行 Service 层单元测试：详细教程

本文旨在帮助开发者掌握使用 Mockito 框架对 Sprin

g Boot 应用中的 Service 层进行单元测试的方法。通过详细的代码示例和步骤，我们将演示如何有效地 Mock 依赖的 DAO 和 Service，从而隔离被测 Service，保证测试的准确性和可靠性。

在编写单元测试时，特别是针对 Service 层，经常需要模拟（Mock）其依赖的其他 Service 或 DAO（Data Access Object）的行为。这允许你专注于测试特定 Service 的逻辑，而无需担心依赖项的真实实现是否正确或可用。Mockito 是一个流行的 Java Mocking 框架，可以方便地创建和配置 Mock 对象。

以下是一个使用 Mockito 进行 Service 层单元测试的示例，并解释了常见的错误和解决方法。

1. 准备工作

首先，确保你的项目中引入了必要的依赖：

    org.springframework.boot
    spring-boot-starter-test
    test


    org.mockito
    mockito-core
    test

2. 示例 Service 和 DAO

假设我们有以下 Service 和 DAO：

// ScoreDAO.java
public interface ScoreDAO {
    int insert(ScoreModel score);
}

// SubjectService.java
public interface SubjectService {
    SubjectModel getNameSubject(RequestModel request, String nameStudent);
}

// ExamServiceImpl.java
@Service
public class ExamServiceImpl implements ExamService {

    @Autowired
    private SubjectService subjectService;

    @Autowired
    private ScoreDAO scoreDAO;

    @Autowired
    private TeacherDAO teacherDAO;

    @Autowired
    private StudentDAO studentDAO;


    @Override
    public ResponseModel insertScore(RequestModel request) throws IOException {
        List teacher = teacherDAO.getNameList(request);
        List student = studentDAO.findStudentList(teacher.get(0).getName(), request.getStudentScore);

        String nameStudent = student.get(0).getFirstName() + student.get(0).getLastName();
        SubjectModel subject = subjectService.getNameSubject(request, nameStudent);

        ScoreModel score = new ScoreModel();
        score.setStudentName(request.getStudentName);
        score.setScore(request.getStudentScore);
        score.setSubject(subject.getName);

        int result = scoreDAO.insert(score);

        return new ResponseModel(result); // Changed to return ResponseModel
    }
}

3. 编写单元测试

import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.when;

@SpringBootTest
public class ExamServiceImplTest {

    @Mock
    private ScoreDAO scoreDAO;

    @Mock
    private SubjectService subjectService;

    @Mock
    private TeacherDAO teacherDAO;

    @Mock
    private StudentDAO studentDAO;

    @InjectMocks
    private ExamServiceImpl examService;

    @Test
    void insertScoreTest() throws IOException {
        // 1. 定义 Mock 对象的行为
        SubjectModel resFromSubject = new SubjectModel();
        resFromSubject.setName("Math");

        TeacherModel resTeacher = new TeacherModel();
        resTeacher.setName("test Teacher");
        List teacherList = new ArrayList<>();
        teacherList.add(resTeacher);

        StudentModel studentData = new StudentModel();
        studentData.setFirstName("firstname");
        studentData.setLastName("lastname");
        List studentList = new ArrayList<>();
        studentList.add(studentData);

        when(teacherDAO.getNameList(any(RequestModel.class))).thenReturn(teacherList);
        when(studentDAO.findStudentList(anyString(), anyString())).thenReturn(studentList);
        when(subjectService.getNameSubject(any(RequestModel.class), anyString())).thenReturn(resFromSubject);
        when(scoreDAO.insert(any(ScoreModel.class))).thenReturn(1);

        // 2. 执行被测方法
        ResponseModel resultTest = examService.insertScore(new RequestModel());

        // 3. 验证结果
        assertEquals(1, resultTest.getResult());
    }
}

关键点解释:

• @SpringBootTest: 启动完整的 Spring 上下文，允许注入 Mock 对象和真实的 Service。
• @Mock: 用于创建 Mock 对象。 @MockBean 在 Spring 上下文中替换现有的 Bean，而 @Mock 只是创建一个 Mock 对象，需要手动注入到被测类中。推荐使用 @Mock 和 @InjectMocks，可以更清晰地控制依赖关系。
• @InjectMocks: 自动将带有 @Mock 注解的 Mock 对象注入到被测 Service 中。
• Mockito.when(...).thenReturn(...): 定义 Mock 对象的行为。 当调用 teacherDAO.getNameList(any(RequestModel.class)) 时，返回预定义的 teacherList。 any() 和 anyString() 是 Mockito 提供的参数匹配器，用于匹配任何类型的参数。
• examService.insertScore(new RequestModel()): 执行被测方法。
• assertEquals(1, resultTest.getResult()): 断言结果是否符合预期。

常见问题和解决方法:

1. Mock 对象未生效:

   • 原因: 可能忘记使用 @InjectMocks 将 Mock 对象注入到被测 Service 中。
   • 解决方法: 确保正确使用 @Mock 和 @InjectMocks 注解。

2. NullPointerException:

   • 原因: Mock 对象的方法没有定义行为，导致返回 null。
   • 解决方法: 使用 Mockito.when(...).thenReturn(...) 定义 Mock 对象的行为。 确保所有被调用的 Mock 对象的方法都有对应的定义。

3. 参数匹配错误:

   • 原因: 传递给 Mock 对象方法的参数与定义的参数不匹配。
   • 解决方法: 使用 Mockito 提供的参数匹配器，例如 any(), anyString(), eq() 等。

总结:

使用 Mockito 可以有效地隔离 Service 层的依赖，编写可重复、可靠的单元测试。 通过 @Mock 创建 Mock 对象，使用 @InjectMocks 注入依赖，并使用 Mockito.when(...).thenReturn(...) 定义 Mock 对象的行为，可以轻松地模拟各种场景，验证 Service 层的业务逻辑。 记住，良好的单元测试覆盖率是保证代码质量的重要手段。