Skip to content

starter-test ​

1. 职责 ​

给「Service / Mapper 层单元测试」提供最小可用的 Spring 上下文:内存数据库(H2)+ 假 Redis(jedis-mock),只装配 MyBatis、数据源、缓存这几样,不加载业务模块的全量 Bean。

它同时提供测试基建:AssertUtils(POJO 全字段比对、异常码比对)、RandomUtils(基于 Podam 造随机对象,并对项目里的枚举/金额/时间做了定制)。

它不解决:集成测试(真实 MySQL/Redis 的 @SpringBootTest)、Web 层测试(没有 webEnvironment、没有 MockMvc 之外的配置)、容器化测试环境。

本节路径均省略公共前缀 framework/pmforge-spring-boot-starter-test/src/main/java/com/pmforge/framework/。

2. 关键类 ​

类作用路径
BaseMockitoUnitTest纯 Mockito:@ExtendWith(MockitoExtension.class),不启 Springtest/core/ut/BaseMockitoUnitTest.java
BaseDbUnitTest内存库测试基类:@SpringBootTest(webEnvironment=NONE) + @ActiveProfiles("unit-test") + 每个方法后执行 /sql/clean.sqltest/core/ut/BaseDbUnitTest.java
BaseRedisUnitTest假 Redis 测试基类:RedisTestConfiguration + RedisAutoConfiguration + PmforgeRedisAutoConfiguration + RedissonAutoConfigurationV2test/core/ut/BaseRedisUnitTest.java
BaseDbAndRedisUnitTest两者合并(注意其 DB 部分不含 MybatisPlusJoinAutoConfiguration)test/core/ut/BaseDbAndRedisUnitTest.java
RedisTestConfiguration起一个 jedis-mock 的 RedisServer(端口取 spring.redis.port),start() 异常被忽略test/config/RedisTestConfiguration.java
SqlInitializationTestConfiguration复制 DataSourceInitializationConfiguration 的逻辑,因为单测开 lazy-initialization=true 时官方配置不执行test/config/SqlInitializationTestConfiguration.java
AssertUtilsassertPojoEquals(可忽略字段)、isPojoEquals、assertServiceException(比对 code 与格式化后的 message)test/core/util/AssertUtils.java
RandomUtilsPodam 封装:randomPojo/randomPojoList/randomLongId/randomEmail/randomMobile/randomURL 等test/core/util/RandomUtils.java

3. 自动配置 ​

配置类生效条件注册了什么
无—本模块没有 META-INF/spring/...AutoConfiguration.imports,不会随 Spring Boot 自动装配
使用方式测试类继承 Base*UnitTest,或在测试里 @Import 对应配置BaseDbUnitTest 通过 classes = BaseDbUnitTest.Application.class 指定空启动类,再用 @Import 拉进数据源、MyBatis、SQL 初始化、SpringUtil
RedisTestConfiguration由 BaseRedisUnitTest 显式 @ImportRedisServer(jedis-mock),@EnableConfigurationProperties(RedisProperties.class)
SqlInitializationTestConfiguration@ConditionalOnMissingBean(AbstractScriptDatabaseInitializer.class) + @ConditionalOnSingleCandidate(DataSource.class)AbstractScriptDatabaseInitializer,让 schema.sql/data.sql 在懒加载场景下也能执行

4. 配置项 ​

前缀键默认值说明
—无—本模块没有 @ConfigurationProperties
spring.profiles.active—unit-test(由基类固定)测试会加载各模块自己的 application-unit-test.yaml,H2 数据源要在这里配
spring.redis.port—6379RedisTestConfiguration 用它启动 jedis-mock
spring.main.lazy-initialization—项目测试配置里为 true正是它导致 SqlInitializationTestConfiguration 需要自己实现一遍

5. 扩展点 ​

  • 写 Mapper 测试:class UserMapperTest extends BaseDbUnitTest,@Import(UserMapper.class) 或注入 @Sql 准备数据。
  • 写 Service 测试(只测本模块):extends BaseDbUnitTest,依赖的其他模块 Service 用 @MockBean。
  • 写缓存测试:extends BaseRedisUnitTest;要同时用库里数据则 BaseDbAndRedisUnitTest。
  • 造数据:RandomUtils.randomPojo(UserDO.class, o -> o.setId(null));需要精确控制字段时用第二个 Consumer 参数。
  • 断言异常:AssertUtils.assertServiceException(() -> service.create(req), ErrorCodeConstants.XXX),它会比对错误码与格式化后的 msg。

6. 常见坑 ​

  1. 它不是自动配置:没有 AutoConfiguration.imports,Spring Boot 不会自动加载;业务模块必须把 pmforge-spring-boot-starter-test 作为 test scope 依赖,并继承基类或 @Import。
  2. BaseDbUnitTest 不会加载模块里手写的 @Configuration:@Import 列表是写死的(数据源、MyBatis、SpringUtil 等),业务自己的 Bean 要靠 @Import 再加,否则注入不到。
  3. BaseDbAndRedisUnitTest 少了 MybatisPlusJoinAutoConfiguration:在「DB + Redis」组合基类里写 MPJ 联表查询会报 selectJoinList 不存在,切到 BaseDbUnitTest 才正常。
  4. jedis-mock 的 start() 吞异常:注释说明「多次执行单元测试时容器不 stop 导致端口占用」,所以端口冲突不会失败——但如果本机真有一个 Redis 在监听,测试会连到真 Redis 并把数据写进去。
  5. @Sql("/sql/clean.sql") 需要每个测试模块自备:路径在本模块 resources 里不存在,缺文件时是每个测试方法结束后报错,而不是启动时报错。
  6. RandomUtils 的字段定制会误导断言:deleted 恒为 false、BigDecimal 强制 DECIMAL(10,2)、LocalDateTime 去掉纳秒、status/type/category/scope/result 落在 0~127——测逻辑删除或时间精度时要自己塞值。

7. 关联页面 ​