Spring校验器单元测试问题：测试依赖Service的UniqueEmailValidator

嘿，我来帮你搞定这个自定义校验器的单元测试问题！你的UniqueEmailValidator依赖AccountService来校验邮箱唯一性，咱们完全不用启动整个Spring容器，用Mockito模拟依赖就能轻松完成单元测试，步骤很清晰，咱们一步步来：

1. 准备必要的测试依赖 #

首先确保你的测试依赖里包含这些：

• JUnit 5（推荐版本，也可以用JUnit 4）
• Mockito：用来模拟AccountService
• Jakarta Validation相关依赖：校验器的API和实现（比如Hibernate Validator）

如果用Maven的话，pom.xml里可以加这些依赖：

<dependencies>
    <!-- JUnit 5 -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.9.2</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-engine</artifactId>
        <version>5.9.2</version>
        <scope>test</scope>
    </dependency>
    <!-- Mockito -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <version>4.11.0</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-junit-jupiter</artifactId>
        <version>4.11.0</version>
        <scope>test</scope>
    </dependency>
    <!-- Jakarta Validation -->
    <dependency>
        <groupId>jakarta.validation</groupId>
        <artifactId>validation-api</artifactId>
        <version>3.0.2</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>8.0.1.Final</version>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 编写单元测试类 #

咱们用Mockito的扩展来管理模拟对象，自动注入到校验器里，然后覆盖所有关键场景：

import jakarta.validation.ConstraintValidatorContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

@ExtendWith(MockitoExtension.class)
class UniqueEmailValidatorTest {

    // 模拟依赖的AccountService
    @Mock
    private AccountService accountService;

    // 模拟校验上下文（简单测试里不需要修改它，所以用mock就行）
    @Mock
    private ConstraintValidatorContext constraintValidatorContext;

    // 让Mockito自动把模拟的AccountService注入到校验器里
    @InjectMocks
    private UniqueEmailValidator validator;

    @BeforeEach
    void setUp() {
        // 初始化校验器：模拟UniqueEmail注解并传入initialize方法
        UniqueEmail mockAnnotation = mock(UniqueEmail.class);
        validator.initialize(mockAnnotation);
    }

    @Test
    void isValid_WhenEmailIsUnique_ReturnsTrue() {
        String uniqueEmail = "test@example.com";
        // 设定当调用accountService.checkEmailExists时返回false（邮箱不存在）
        when(accountService.checkEmailExists(uniqueEmail)).thenReturn(false);

        boolean result = validator.isValid(uniqueEmail, constraintValidatorContext);

        // 断言校验通过
        assertTrue(result);
        // 验证AccountService的方法确实被调用了一次
        verify(accountService, times(1)).checkEmailExists(uniqueEmail);
    }

    @Test
    void isValid_WhenEmailAlreadyExists_ReturnsFalse() {
        String existingEmail = "existing@example.com";
        // 设定当调用accountService.checkEmailExists时返回true（邮箱已存在）
        when(accountService.checkEmailExists(existingEmail)).thenReturn(true);

        boolean result = validator.isValid(existingEmail, constraintValidatorContext);

        // 断言校验不通过
        assertFalse(result);
        // 验证AccountService的方法确实被调用了一次
        verify(accountService, times(1)).checkEmailExists(existingEmail);
    }

    @Test
    void isValid_WhenEmailIsNull_ReturnsTrue() {
        // 这里根据你的业务逻辑调整：如果允许null邮箱，返回true；否则返回false
        boolean result = validator.isValid(null, constraintValidatorContext);

        assertTrue(result);
        // 验证AccountService的方法完全没被调用
        verify(accountService, never()).checkEmailExists(any());
    }
}

3. 关键细节说明 #

• 构造注入的适配：因为你的校验器用了@AllArgsConstructor，Mockito的@InjectMocks会自动把模拟的AccountService通过构造函数注入进去，完全不用手动new校验器。
• 校验上下文的模拟：ConstraintValidatorContext主要用来自定义错误信息，在简单的单元测试里我们不需要修改它，所以直接用mock就行。如果你的校验器里有修改上下文的逻辑，再针对性地模拟它的方法。
• 覆盖边界场景：除了正常的“唯一”和“已存在”场景，别忘了测试null、空字符串这些边界情况，确保校验器的逻辑覆盖全面。

内容的提问来源于stack exchange，提问作者user1778855