Spring Boot服务层测试中模型Mocking的最佳实践-java教程-PHP中文网

spring boot服务层测试中模型mocking的最佳实践

本文深入探讨了在Spring Boot服务层测试中，当服务内部创建新的模型对象时，如何正确地对依赖的DAO层操作进行Mock。核心问题在于`Mockito.when()`中使用`new Object()`进行参数匹配会导致Mock失效，因为其与服务内部创建的对象并非同一实例。解决方案是利用`Mockito.any()`方法，实现对任意类型参数的匹配，从而确保Mock行为能够被正确触发，有效提升测试的覆盖率和可靠性。

正文

引言：服务层测试中的Mocking挑战

在Spring Boot应用开发中，服务层（Service Layer）承载着核心业务逻辑，对其进行充分测试是保证应用质量的关键。为了隔离服务层与外部依赖（如数据库、第三方服务等），我们通常会使用Mocking技术。通过模拟这些依赖的行为，我们可以专注于测试服务层自身的逻辑，而无需启动完整的外部系统。然而，在实践中，尤其当服务层方法内部创建并操作新的数据模型对象时，对这些操作进行Mocking常常会遇到挑战，导致Mock行为未能如预期触发。

考虑以下一个典型的服务层实现，它负责插入学生成绩：

@Service
public class ExamServiceImpl implements ExamService {

    @Autowired
    private SubjectService subjectService; // 假设通过字段注入

    private final ScoreDAO scoreDAO; // 假设通过构造器注入

    @Autowired
    public ExamServiceImpl(ScoreDAO scoreDAO) {
        this.scoreDAO = scoreDAO;
    }

    @Override
    public ResponseModel insertScore(RequestModel request) throws IOException {
        // 1. 调用SubjectService获取科目信息
        SubjectModel subject = subjectService.getNameSubject(request);

        // 2. 在服务内部创建新的ScoreModel对象
        ScoreModel score = new ScoreModel();
        score.setStudentName(request.getStudentName());
        score.setScore(request.getStudentScore());
        score.setSubject(subject.getName());

        // 3. 调用ScoreDAO插入成绩
        int result = scoreDAO.insert(score);

        // 假设ResponseModel是根据result生成的，这里简化返回result
        return new ResponseModel(result);
    }
}

登录后复制

为了测试insertScore方法，我们需要Mock SubjectService和ScoreDAO。

问题剖析：为什么new Object()导致Mock失效？

当尝试编写测试时，一个常见的错误模式是使用new Object()在Mockito.when()中指定参数，期望它能匹配服务内部创建的对象。例如：

@SpringBootTest
public class ExamServiceImplTest {

    @MockBean // Spring Boot测试中用于Mock Bean
    private ScoreDAO scoreDAO;

    @MockBean // Mock SubjectService
    private SubjectService subjectService;

    @Autowired
    private ExamService examService; // 注入待测试的服务

    @Test
    void insertScoreTest_IncorrectMocking() {
        // 模拟SubjectService的行为
        SubjectModel resFromSubject = new SubjectModel();
        resFromSubject.setSubject("Math");
        // 这里也存在潜在问题，如果RequestModel内部有字段被使用，new RequestModel()可能不匹配
        Mockito.when(subjectService.getNameSubject(new RequestModel())).thenReturn(resFromSubject);

        // 尝试模拟ScoreDAO的插入操作
        // 问题所在：这里的 new ScoreModel() 与 ExamServiceImpl 中创建的 new ScoreModel() 是不同的对象
        Mockito.when(scoreDAO.insert(new ScoreModel())).thenReturn(1);

        // 执行待测试的方法
        ResponseModel response = examService.insertScore(new RequestModel());
        int resultTest = response.getCode(); // 假设ResponseModel有一个getCode方法返回结果

        // 验证结果
        // assertSame(ex, 1); // 原始代码中的ex是错别字，应为resultTest
        assertEquals(1, resultTest); // 正确的断言方式
    }
}

登录后复制

运行上述测试时，resultTest很可能为0，而非期望的1。通过调试会发现，scoreDAO.insert(score)实际上并没有触发Mock的返回值1，而是返回了int类型的默认值0。

原因分析：Mockito.when(scoreDAO.insert(new ScoreModel())).thenReturn(1); 这行代码的本意是：当scoreDAO的insert方法被调用，并且传入的参数是new ScoreModel()时，返回1。然而，Java中的new ScoreModel()每次都会在内存中创建一个全新的ScoreModel对象。这意味着：

Mockito.when()中使用的new ScoreModel()是一个对象实例A。
ExamServiceImpl内部创建的ScoreModel score = new ScoreModel(); 是另一个完全不同的对象实例B。 Mockito在进行参数匹配时，默认使用equals()方法（对于对象参数，如果未重写equals()，则默认比较的是对象引用）。由于实例A和实例B是不同的对象引用，即使它们是同一个类，Mockito也无法将它们匹配起来，因此Mock行为不会被触发。

解决方案：利用Mockito.any()进行通用匹配

解决这个问题的关键在于告诉Mockito：“无论insert方法接收到的是哪个ScoreModel实例，只要它是一个ScoreModel类型的对象，就执行Mock的返回值。” 这正是Mockito.any()方法的作用。

Mockito.any(Class<T> type)是一个参数匹配器，它允许Mockito匹配任何给定类型的对象。

修正后的测试代码如下：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.any; // 导入any方法

// 假设RequestModel, ResponseModel, SubjectModel, ScoreModel, ScoreDAO, SubjectService, ExamService已定义

@SpringBootTest
public class ExamServiceImplTest {

    @MockBean
    private ScoreDAO scoreDAO;

    @MockBean
    private SubjectService subjectService;

    @Autowired
    private ExamService examService;

    @Test
    void insertScoreTest_CorrectMocking() throws IOException {
        // 模拟SubjectService的行为
        SubjectModel resFromSubject = new SubjectModel();
        resFromSubject.setName("Math"); // 假设SubjectModel有setName方法

        // 使用any()匹配任何RequestModel实例
        when(subjectService.getNameSubject(any(RequestModel.class))).thenReturn(resFromSubject);

        // 修正：使用 Mockito.any(ScoreModel.class) 匹配任何 ScoreModel 实例
        when(scoreDAO.insert(any(ScoreModel.class))).thenReturn(1);

        // 准备请求模型，尽管我们在这里使用了any()，但实际传入一个有效的请求模型是良好的实践
        RequestModel request = new RequestModel();
        request.setStudentName("John Doe");
        request.setStudentScore(90);

        // 执行待测试的方法
        ResponseModel response = examService.insertScore(request);
        int resultTest = response.getCode(); // 假设ResponseModel有一个getCode方法返回结果

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

登录后复制

通过将Mockito.when(scoreDAO.insert(new ScoreModel())).thenReturn(1); 修改为 Mockito.when(scoreDAO.insert(any(ScoreModel.class))).thenReturn(1);，我们告诉Mockito：当scoreDAO.insert方法被调用时，只要其参数是ScoreModel类型的任意实例，就返回1。这样，无论服务内部创建的ScoreModel对象是什么，都能成功匹配到Mock的定义，从而使测试按预期执行。

深入理解Mockito.any()与其他参数匹配器

Mockito.any()是Mockito提供的一系列参数匹配器之一，用于在when()或verify()方法中指定参数的匹配规则。

千帆大模型平台

面向企业开发者的一站式大模型开发及服务运行平台

查看详情

Mockito.any(Class<T> type): 匹配任何指定类型的对象。当你只关心参数的类型而不关心其实际值或引用时使用。
Mockito.eq(T value): 匹配与给定值相等的参数。如果需要匹配具体的原始类型值或重写了equals()方法的对象实例，可以使用eq()。例如：when(service.method(eq("someString"))).thenReturn(...)。
Mockito.argThat(ArgumentMatcher<T> matcher): 允许你定义更复杂的自定义匹配逻辑。你可以实现ArgumentMatcher接口来编写自己的匹配器。
Mockito.isNull() / Mockito.notNull(): 匹配null或非null参数。
Mockito.anyString() / Mockito.anyInt() / Mockito.anyList() 等: 针对特定常用类型的快捷匹配器。

何时使用any()？ 当被测试的方法在内部创建依赖对象，并且你对这些对象的具体属性值不感兴趣，只关心它们是否是特定类型时，any()是最佳选择。这通常发生在DAO层的insert或save操作中，因为你可能只关心insert操作是否被调用以及它是否成功，而不必精确地验证被插入对象的每一个字段。

何时使用eq()或更具体的匹配器？ 当你需要根据参数的特定值来触发不同的Mock行为，或者需要验证方法是否以特定参数被调用时，应使用eq()或其他更具体的匹配器。例如，dao.findById(id)方法，你可能需要根据不同的id返回不同的结果。

测试环境选择：@MockBean vs. @Mock/@InjectMocks

原始问题中提到了两种不同的测试设置方式：

@SpringBootTest 结合 @MockBean:
- 优点: 这种方式会启动一个完整的Spring应用上下文（或部分上下文），并用Mock对象替换Spring容器中的真实Bean。这使得测试更接近真实的运行环境，可以测试Spring组件的集成。
- 适用场景: 适用于集成测试或需要Spring上下文特性的服务层测试。
- 本教程示例: 采用了这种方式，因为它在Spring Boot项目中非常常见。
@RunWith(MockitoJUnitRunner.class) 结合 @Mock 和 @InjectMocks:
- 优点: 这种方式不启动Spring上下文，而是纯粹地使用Mockito来创建Mock对象并注入到被测试的服务中。测试运行速度快，更符合单元测试的定义。
- 适用场景: 适用于纯粹的单元测试，不依赖Spring容器特性，只测试单个类的业务逻辑。
- 注意: 如果你的服务依赖于Spring的AOP、事务管理等特性，这种方式可能无法完全模拟真实行为。

无论采用哪种测试设置，Mockito.any()的原理和使用方式都是相同的，它解决的是Mockito参数匹配的核心问题。

测试最佳实践与注意事项

保持测试的独立性与原子性: 每个测试方法应只测试一个特定的功能点，并且测试结果不应依赖于其他测试的执行顺序。

使用Mockito.verify()验证交互: 除了验证返回值，还应使用Mockito.verify()来确保Mock对象的方法被正确调用了指定次数和指定参数。这有助于确认业务逻辑的执行路径。

import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.times;

// ... 在 insertScoreTest_CorrectMocking 方法中 ...
assertEquals(1, resultTest);
// 验证 scoreDAO.insert 方法被调用了一次，且参数是任意 ScoreModel 实例
verify(scoreDAO, times(1)).insert(any(ScoreModel.class));
// 验证 subjectService.getNameSubject 方法被调用了一次，且参数是任意 RequestModel 实例
verify(subjectService, times(1)).getNameSubject(any(RequestModel.class));

登录后复制

避免过度Mocking: 只Mock你直接依赖且需要控制其行为的对象。过度Mocking会导致测试代码复杂、难以维护，并且可能掩盖真实的问题。
清晰的测试命名: 使用描述性的测试方法名称，清晰地表达测试的目的和预期结果。

总结

在Spring Boot服务层测试中，当服务内部创建新的模型对象并将其传递给Mocked依赖时，直接使用new Object()作为Mockito.when()的参数会导致Mock失效。根本原因是Java中new关键字每次都创建新对象，导致引用不匹配。通过利用Mockito.any(Class<T> type)参数匹配器，我们可以告诉Mockito匹配任何指定类型的对象，从而有效解决这一问题。掌握Mockito.any()以及其他参数匹配器的正确使用，是编写健壮、可靠的Mocking测试的关键，能够确保测试能够准确地验证业务逻辑，并提升代码质量。

以上就是Spring Boot服务层测试中模型Mocking的最佳实践的详细内容，更多请关注php中文网其它相关文章！