Mockito 使用 Spring Boot 模拟 Java @Value

Question

您好，我的 Spring Boot 项目有这个简单的代码：

@Component
public class UserRowMapper implements RowMapper<User> {
    @Value("${bug.value}")
    private String id;
    @Value("${wrong.value}")
    private String userName;

    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
        return User.builder()
                .id(rs.getInt(id))
                .userName(rs.getString(userName)).build();
    }
}

我想要创建一个简单的 Mockito 测试来检查 @Value 字符串，如下所示：

@ExtendWith(MockitoExtension.class)
class UserRowMapperTest {
    @Mock
    Environment environment;
    @Mock
    ResultSet resultSet;
    @InjectMocks
    UserRowMapper userRowMapper;

    @Test
    void testMapRow() {
        when(environment.getProperty("user.id")).thenReturn("id");
        when(environment.getProperty("user.userName")).thenReturn("userName");
        try {
            final User user = userRowMapper.mapRow(resultSet, anyInt());
            
            // check if its ok
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }
}

但我找不到简单的方法来检查我注入的值是否符合我的预期。

有什么想法吗？

Answer 1

不幸的是，Spring 的@Value 没有模拟机制。但是，您可以使用ReflectionUtils 的简单解决方法，根据 JavaDoc 用于此目的：

ReflectionTestUtils 是一组基于反射的实用方法，用于单元和集成测试场景。

在测试涉及的代码时，通常能够设置非公共字段、调用非公共 setter 方法或调用非公共配置或生命周期回调方法是有益的

ReflectionTestUtils.setField(userRowMapper, "id", "my-id-value");
ReflectionTestUtils.setField(userRowMapper, "userName", "my-userName-value");

ReflectionTestUtils#setField(Object, String, Object) 的 JavaDoc。

Answer 2

为id 和userName 字段添加getter 方法，而不是模拟Environment 类。

@Component
public class UserRowMapper implements RowMapper<User> {
    @Value("${bug.value}")
    private String id;

    @Value("${wrong.value}")
    private String userName;

    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
        return User.builder()
                .id(rs.getInt(getId()))
                .userName(rs.getString(getUserName())).build();
    }

    public String getId() {
        return id;
    }

    public String getUserName() {
        return userName;
    }
}

在嘲笑时：

Mockito.when(userRowMapper.getId()).thenReturn("id");
Mockito.when(userRowMapper.getUserName()).thenReturn("userName");

---

另外，您可以使用TestPropertySource 注解来提供完全不同的属性文件：

@SpringBootTest
@TestPropertySource(locations = "/application2.properties")
public class TestClassTest {

    @Autowired
    TestClass testClass;

    @Test
    public void test() {
        assertEquals("id", testClass.getId());
    }
}

Answer 3

我宁愿建议你不要在消费者类上使用内联 @Value 注释。如您所见，类的可测试性降低了。

您只需创建一个@Configuration bean 并将其注入UserRowMapper 类即可解决您的问题。通过这种方式，您可以使用 DI 轻松模拟测试中的配置。

请看下面一个简单的实现。

@Configuration
public class UserRowMapperConfiguration {
    @Value("${bug.value}")
    private String id;

    @Value("${wrong.value}")
    private String userName;

    public String getId() {
        return id;
    }

    public String getUserName() {
        return userName;
    }
}

@Component
public class UserRowMapper implements RowMapper<User> {
    
    private UserRowMapperConfiguration configuration;
    
    public UserRowMapper (UserRowMapperConfiguration configuration) {
        this.configuration = configuration;
    }

    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
        return User.builder()
                .id(rs.getInt(this.configuration.getId()))
                .userName(rs.getString(this.configuration.getUserName())).build();
    }
}

@ExtendWith(MockitoExtension.class)
class UserRowMapperTest {
    @Mock
    UserRowMapperConfiguration configuration;
    @Mock
    ResultSet resultSet;
    @InjectMocks
    UserRowMapper userRowMapper;

    @Test
    void testMapRow() {
        when(configuration.getId()).thenReturn("id");
        when(configuration.getUserName()).thenReturn("userName");
        try {
            final User user = userRowMapper.mapRow(resultSet, anyInt());
            
            // check if its ok
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }
}