主题
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),不启 Spring | test/core/ut/BaseMockitoUnitTest.java |
BaseDbUnitTest | 内存库测试基类:@SpringBootTest(webEnvironment=NONE) + @ActiveProfiles("unit-test") + 每个方法后执行 /sql/clean.sql | test/core/ut/BaseDbUnitTest.java |
BaseRedisUnitTest | 假 Redis 测试基类:RedisTestConfiguration + RedisAutoConfiguration + PmforgeRedisAutoConfiguration + RedissonAutoConfigurationV2 | test/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 |
AssertUtils | assertPojoEquals(可忽略字段)、isPojoEquals、assertServiceException(比对 code 与格式化后的 message) | test/core/util/AssertUtils.java |
RandomUtils | Podam 封装: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 显式 @Import | RedisServer(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 | — | 6379 | RedisTestConfiguration 用它启动 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. 常见坑
- 它不是自动配置:没有
AutoConfiguration.imports,Spring Boot 不会自动加载;业务模块必须把pmforge-spring-boot-starter-test作为testscope 依赖,并继承基类或@Import。 BaseDbUnitTest不会加载模块里手写的@Configuration:@Import列表是写死的(数据源、MyBatis、SpringUtil等),业务自己的 Bean 要靠@Import再加,否则注入不到。BaseDbAndRedisUnitTest少了MybatisPlusJoinAutoConfiguration:在「DB + Redis」组合基类里写 MPJ 联表查询会报selectJoinList不存在,切到BaseDbUnitTest才正常。- jedis-mock 的
start()吞异常:注释说明「多次执行单元测试时容器不 stop 导致端口占用」,所以端口冲突不会失败——但如果本机真有一个 Redis 在监听,测试会连到真 Redis 并把数据写进去。 @Sql("/sql/clean.sql")需要每个测试模块自备:路径在本模块 resources 里不存在,缺文件时是每个测试方法结束后报错,而不是启动时报错。RandomUtils的字段定制会误导断言:deleted恒为false、BigDecimal强制DECIMAL(10,2)、LocalDateTime去掉纳秒、status/type/category/scope/result落在0~127——测逻辑删除或时间精度时要自己塞值。
7. 关联页面
- starter-mybatis:基类
@Import的对象 - starter-redis:
PmforgeRedisAutoConfiguration被直接引入 - pmforge-common:
ServiceException与错误码 - 横切机制、开发规范