如何高效测试Mybatis？（xxxMapper）

一、背景

• 虽然我们可以借助插件来高效生成xxxDO、xxxMapper.java、xxxMapper.xml，但我们还需要对其进行修改。而在修改的过程中，我们可能会漏了逗号，或者类的字段类型与表的列类型不匹配，这都会导致增删改查失败。
• 每次失败重新启动应用的话，会增加测试的时间开销。（JRebel热部署插件虽然能热部署xml文件，但有时候会失效。）
• 因此，在进行controller-service-dao功能测试之前，我们要先对dao层进行单元测试。

二、对Dao层进行单元测试

1 低效的方式

1.1 使用@SpringBootTest：

@SpringBootTest
class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    void insert() {
        UserDO user = new UserDO();
        user.setName("John");
        user.setAge(30);
        userMapper.insert(user);

        assertNotNull(user.getId(), "Insert should generate ID");

        UserDO retrievedUser = userMapper.selectById(user.getId());
        assertNotNull(retrievedUser, "User should be retrieved after insertion");
        assertEquals("John", retrievedUser.getName(), "Name should match");
        assertEquals(30, retrievedUser.getAge(), "Age should match");
    }
	
	...
}

• 低效的原因：使用@SpringBootTest会加载整个应用的上下文。

1.2 其他低效的方式

• 把整个SpringBoot应用跑起来，通过Postman进行测试。
  • 企业级应用，要么本地起不来，要不跑一次要若干分钟。这么测试，又要加班了…

2 高效的方式

• SpringBoot整合Mybatis引入了这个依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.3.2</version>
</dependency>

• 同理，也有对应的测试依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter-test</artifactId>
    <version>2.3.2</version>
</dependency>

官方文档

2.1 示例（报错：Failed to replace DataSource with an embedded database for tests）

@MybatisTest
class UserMapperSimpleTest {
    @Autowired
    private UserMapper userMapper;

    @Test
    void deleteById() {
        UserDO user = new UserDO();
        user.setName("Alice");
        user.setAge(25);
        userMapper.insert(user);

        Integer userId = user.getId();
        assertNotNull(userId, "Insert should generate ID");

        userMapper.deleteById(userId);

        UserDO deletedUser = userMapper.selectById(userId);
        assertNull(deletedUser, "User should be deleted");
    }
}

• 报错：Caused by: java.lang.IllegalStateException: Failed to replace DataSource with an embedded database for tests. If you want an embedded database please put a supported one on the classpath or tune the replace attribute of @AutoConfigureTestDatabase.
• 原因：在测试中 Spring Boot 尝试替换数据源为一个内嵌的数据库，但是它找不到一个支持的内嵌数据库。

2.2 解决办法

• 配置支持的内嵌数据库（很麻烦，又要建表，又要构造数据）
• 禁用自动配置的数据源替换（很方便，一方面本地环境操作的是日常数据库，另一方面MyBatis 测试是事务性的，默认在每次测试结束时回滚）

2.2.1 禁用自动配置的数据源替换

@MybatisTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class UserMapperSimpleTest {
    @Autowired
    private UserMapper userMapper;

    @Test
    void insert() {
        UserDO user = new UserDO();
        user.setName("John");
        user.setAge(30);
        userMapper.insert(user);

        assertNotNull(user.getId(), "Insert should generate ID");

        UserDO retrievedUser = userMapper.selectById(user.getId());
        assertNotNull(retrievedUser, "User should be retrieved after insertion");
        assertEquals("John", retrievedUser.getName(), "Name should match");
        assertEquals(30, retrievedUser.getAge(), "Age should match");
    }

    @Test
    void deleteById() {
        UserDO user = new UserDO();
        user.setName("Alice");
        user.setAge(25);
        userMapper.insert(user);

        Integer userId = user.getId();
        assertNotNull(userId, "Insert should generate ID");

        userMapper.deleteById(userId);

        UserDO deletedUser = userMapper.selectById(userId);
        assertNull(deletedUser, "User should be deleted");
    }

}

• 我测试了下，@Service标注的类确实没法注入了。

@MybatisTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class UserMapperSimpleTest {
    @Autowired
    private UserMapper userMapper;

    @Autowired(required = false)
    private IUserService userService;

    @Test
    void testUserServiceNotInjected() {
        assertNull(userService, "User service should not be injected");
    }

    @Test
    void testUserMapperInjected() {
        assertNotNull(userMapper, "User mapper should be injected");
    }
}

• 而如果是@SpringBootTest，就会把@Service标注的类也注入到容器中。