为鼓励单元测试,特分门别类示例各种组件的测试代码并进行解说,供开发人员参考。
本文中的测试均基于JUnit5。
单元测试实战(一)Controller 的测试
单元测试实战(二)Service 的测试
单元测试实战(三)JPA 的测试
单元测试实战(四)MyBatis-Plus 的测试
单元测试实战(五)普通类的测试
单元测试实战(六)其它
概述
MyBatis Plus组件表现为Mapper对象(我们将不涉及IService的测试)。使用MyBatis/MyBatis-Plus的项目,往往有很多自写的SQL需要测试。
MyBatis Plus有专门的@MyBatisPlusTest注解,是苞米豆提供的功能,它是有Spring上下文的,使用JUnit的SpringExtension扩展类。与@DataJpaTest一样,它会在测试时自动将数据源替换为内存数据库的。
在本章的示例中,我们将展示一种使用SQL脚本来准备测试数据的方法。
断言应主要检查数据存取行为是否符合预期。
依赖
除依赖Spring自带测试框架外,还需要苞米豆的测试包以及内存数据库:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope>
</dependency>
<dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter-api</artifactId><scope>test</scope>
</dependency>
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter-test</artifactId><version>3.5.3.2</version><scope>test</scope>
</dependency>
<dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><scope>test</scope>
</dependency>
注意:mybatis-plus-boot-starter-test的3.5.2版本支持Spring Boot 2,3.5.3及以上支持Spring Boot 3。
示例
由于篇幅的关系,本章中我们将拿出一个Mapper方法作为示例。
以下为xml实现的一个查询方法:
<select id="selectPermissionCodesByUser" resultType="java.lang.String">SELECT p.codeFROM sys_auth_user_role urJOIN sys_auth_role_permission rp ON rp.role_id=ur.role_idJOIN sys_auth_permission p ON p.id=rp.permission_idWHERE p.type=2 AND ur.user_code=#{userCode} AND ur.asset_type=#{assetType} AND ur.asset_id=#{assetId}<if test="pkOrg != null">UNION DISTINCTSELECT p.codeFROM sys_auth_user_org uoJOIN sys_auth_role_permission rp ON rp.role_id=uo.role_idJOIN sys_auth_permission p ON p.id=rp.permission_idWHERE p.type=2 AND uo.user_code=#{userCode} AND uo.pk_org=#{pkOrg}</if>
</select>
以下为该查询的代理接口:
public interface SysAuthPermissionMapper extends BaseMapper<SysAuthPermission> {...Set<String> selectPermissionCodesByUser(@Param("userCode") String userCode,@Param("assetType") int assetType,@Param("assetId") long assetId,@Param("pkOrg") String pkOrg);...
}
以下是该查询方法的测试类:
package com.aaa.sdk.rbac.mybatis.database.mapper;import com.baomidou.mybatisplus.test.autoconfigure.MybatisPlusTest;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.core.io.ClassPathResource;
import org.springframework.jdbc.datasource.init.ScriptUtils;
import org.springframework.test.context.TestPropertySource;import javax.sql.DataSource;
import java.sql.Connection;
import java.util.Set;import static org.assertj.core.api.Assertions.assertThat;@MybatisPlusTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@TestPropertySource(properties = {"spring.datasource.driver-class-name=org.h2.Driver","spring.datasource.url=jdbc:h2:mem:aaa_rbac_test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE;MODE=MySQL;DATABASE_TO_LOWER=TRUE","spring.datasource.username=sa"
})
class SysAuthPermissionMapperTest {@Autowiredprivate SysAuthPermissionMapper mapper;@BeforeAllstatic void setupClass(@Autowired DataSource dataSource) throws Exception {try (Connection conn = dataSource.getConnection()) {ScriptUtils.executeSqlScript(conn, new ClassPathResource("/sql/test_schema.sql"));ScriptUtils.executeSqlScript(conn, new ClassPathResource("/sql/test_data.sql"));}}@Testvoid testSelectPermissionCodesByUser() {Set<String> permissions = mapper.selectPermissionCodesByUser("wangfei012", 1, 1, "0001A410000000A3I0V2");assertThat(permissions).hasSize(4);}@Testvoid testSelectPermissionCodesByUser_emptyPkOrg() {Set<String> permissions = mapper.selectPermissionCodesByUser("wangfei012", 1, 1, "");assertThat(permissions).hasSize(3);}@Testvoid testSelectPermissionCodesByUser_invalidUser() {Set<String> permissions = mapper.selectPermissionCodesByUser("nobody", 1, 1, "0001A410000000A3I0V2");assertThat(permissions).hasSize(0);}
}
测试类说明:
第18行,我们使用了@MyBatisPlusTest类注解。
第19行,为了H2数据库兼容MySQL语法,我们关闭了数据源的自动替换,选择用20-24行的代码来覆盖默认的数据源。
第28行,我们将代理接口注入测试类。
31行的setupClass方法会在所有测试方法执行之前执行一次,准备数据。这里我们用了Spring自带的ScriptUtils实用程序;其中sql脚本是在test目录下的resources文件夹;测试目录结构如下图:
上图中,MockApplication与测试在同一个包内,用来控制Spring上下文范围,以免启动真实的SpringBootApplication;它的代码如下(注意里面有个@MapperScan,用来发现当前包里的MyBatis mapper):
package com.aaa.sdk.rbac.mybatis.database.mapper;import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
@MapperScan(basePackages = {"com.aaa.sdk.rbac.mybatis.database.mapper"})
public class MockApplication {
}
以下继续测试类的说明:
从第38行开始,是selectPermissionCodesByUser方法的三个测试用例。
testSelectPermissionCodesByUser测试正常流程,包括全部4个正常参数。按照设计和测试数据,它应该取出4个结果。
testSelectPermissionCodesByUser_emptyPkOrg测试传入的pkOrg参数为空时的场景,覆盖的是xml文件中<if test="pkOrg != null">不满足的分支。按照设计和测试数据,它应该取出3个结果。
testSelectPermissionCodesByUser_invalidUser则是一个负面测试,测试当传入的userCode非法时的场景;它应该不返回任何结果。
与JPA的测试一样,测试类中没有Mock对象,因此也就不存在given - when - then三段式结构。(DAO对象没有更底层的依赖,因此不需注入Mock,这也使得它们看上去更像是一种与数据库的集成测试。)
总结
使用@MybatisPlusTest。
为了兼容MySQL语法而使用@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE),并用@TestPropertySource订制数据源属性。注意:兼容只是部分兼容,并非完全兼容。
使用@BeforeAll方法结合Spring自带的ScriptUtils准备测试数据。
MockApplication里加@MapperScan。
示例中,我们没有在每个方法之前重置测试数据,这是因为我们只测了查询方法吗?不。在DAO的测试中,不管是@MyBatisPlusTest还是@DataJpaTest,都带有@Transactional元注解,它们会在测试方法执行结束后自动回滚。
MyBatis-Plus 有所谓的 Lambda Query,可链式组合查询。我们不建议在Service的实现类里直接使用它;应该将其封装到DAO/Repository层的方法里,这样就方便mock这个封装好的方法的行为,避免直接mock链式组合查询行为。如果实在要mock链式组合查询行为,可以参考这篇和这篇。