refactor(SQL分层): 剩余 85 条注解 SQL 全量迁进 mapper XML,等价性改由 MyBatis 自己判

96 条语句现在全在 src/main/resources/mapper/<模块>/ 下,注解侧 SQL 归零;判据从"基线清单"
改成完成态(逐接口必须为 0 + XML 语句总数 96 + 反向钉:XML 有则注解必须无)。

搬法上踩实了一个坑:注解参数是 Java 表达式("…" + CLIENT_MODULE_TYPES + "…"),
用只认字面量的抽取器搬家会把常量整段吞掉——上一轮生成的 26 份 XML 里因此出现
IN ()、AS status 前面没有表达式(MySQL 语法错),<script> 形态还被多转义一次变成 &amp;lt;。
更糟的是当时"搬迁前快照"与 XML 由同一个抽取器产出,两边一起错所以逐字比对全绿,
抓到现场的是既有的语义用例(TaskCenter 15 条 + 店铺查重那条断 <> 的)。

所以 MigratedSqlEquivalenceTest 改成:账本存注解原文,Java 侧现场用
getDefaultScriptingLanguageInstance().createSqlSource 编译原文,与 XML 解析出的
MappedStatement 各渲染一遍 BoundSql 对撞(空参数 + foreach 喂满 2 元素各一次),
转义对不对由 MyBatis 判定而不是由生成器判定;账本自己再钉 <script>/<if> 成对、不许出现 IN ()。
resultType 那一支不变:期望值由接口签名反射反推,66 条分母钉住。

取数入口跟着换:6 支原本读 @Select 注解的守卫(TaskCenter/Dedupe/店铺查重/通知保留/
鉴权形状/后台扩权)改走 MapperXmlSupport,断言内容一字未动;后台扩权那条"不许有 wrapper
投影"从全文 doesNotContain(".select(") 改成只扫可执行行——接口里现在只剩签名,
而 javadoc 正写着"别用 selectList(.select(...))",全文判会被自己的注释喂饱。

隔离树全量 4059 例 0 红(基线 4054,+5 为新增等价性与 XML 用例)。这批要生效得随下一版 jar 发版。
This commit is contained in:
2026-10-08 12:00:43 +08:00
parent 4d2f3fc754
commit 419ab3be64
62 changed files with 1490 additions and 890 deletions
@@ -44,16 +44,23 @@ import static org.junit.jupiter.api.Assertions.fail;
*/
class SqlLayeringConventionTest {
/** 写 SQL(@Insert/@Update/@Delete)在注解里的现状清单:文件名 → 条数。只许减,不许加。 */
private static final Map<String, Integer> WRITE_SQL_BASELINE = writeSqlBaseline();
/**
* 注解里的写 SQL 清单。<b>2026-10-08 全量迁完后为空</b>:任何一条重新出现都直接红,
* 新 SQL 一律写进 {@code src/main/resources/mapper/<模块>/<Name>Mapper.xml}。
*/
private static final Map<String, Integer> WRITE_SQL_BASELINE = new LinkedHashMap<>();
/**
* 读侧注解 SQL 的逐接口清单(2026-10-08 实测 65 条 / 16 个接口,迁走 TaskImageCacheMapper 后 60 / 15)。
* 注解里的读 SQL 清单,同样在 2026-10-08 迁完归零。
*
* <p>为什么从"总数 + 文件数"两个标量改成逐接口:标量守恒的是**和**,A 接口减一条、
* B 接口加一条时两个标量都不动,闸门照样绿——档 B 口径下这等于没有闸门。
* <p>保留逐接口形态(而不是退回一个"总数 0")是有原因的:以前钉"总数 + 文件数"两个标量时,
* A 接口加一条配 B 接口减一条两个标量都不动,闸门形同虚设;逐接口清单在迁移期就是账本,
* 迁完后它继续保证"不许在某个接口里悄悄攒回来"。
*/
private static final Map<String, Integer> SELECT_SQL_BASELINE = selectSqlBaseline();
private static final Map<String, Integer> SELECT_SQL_BASELINE = new LinkedHashMap<>();
/** 迁移完成态的分母:XML 里应有的语句总数(85 本轮 + 9 TaskImageCache + 2 AsinResultCache)。 */
private static final int XML_STATEMENT_TOTAL = 96;
/**
* wrapper 里夹带函数级 SQL 的现状("这不是简单单表"的证据),文件名 → 条数:
@@ -62,65 +69,24 @@ class SqlLayeringConventionTest {
private static final Map<String, Integer> RAW_SQL_IN_WRAPPERS_BASELINE = rawSqlInWrappersBaseline();
/**
* 其中"复杂"的写 SQL(注解正文含动态标签)——Wrapper 表达不了(批量/INSERT…SELECT/upsert),
* 按约定应迁到 XML。这是待迁 backlog,不是许可名单:迁走一条要同时从这里划掉。
* 注解里带动态标签的写 SQL 待迁清单。<b>2026-10-08 已清空</b>——
* {@code <foreach>}/{@code <if>} 这类 Wrapper 表达不了的语句现在只在 XML 里。
* 再往注解里塞动态标签,{@link #noNewComplexWriteSqlInAnnotations} 直接红。
*/
private static final List<String> COMPLEX_WRITE_SQL_BACKLOG = List.of(
"CollectDataItemMapper", "DedupeTotalDataMapper", "InvalidAsinDataMapper",
"UserColumnPermissionMapper", "PublishItemMapper", "ShopDataCrawlItemMapper",
"QueryAsinMapper", "TaskResultItemMapper");
private static final List<String> COMPLEX_WRITE_SQL_BACKLOG = List.of();
/** 唯一没有实体可走的 mapper:连 wrapper 的入口都没有,所以只能写裸 SQL。 */
private static final List<String> MAPPERS_WITHOUT_ENTITY = List.of("UserColumnPermissionMapper");
/** 已经迁到 XML 的:反向钉住"不许再用注解把 SQL 写回来"(注解 + XML 同名会让启动期抛重复语句)。 */
private static final List<String> MIGRATED_TO_XML = List.of("AsinResultCacheMapper", "TaskImageCacheMapper");
/**
* "带写 SQL 又不继承 BaseMapper" 的豁免名单,同样已清空:SQL 进了 XML 之后,
* 接口继不继承实体都不影响语句落地,这条只用来拦"新 mapper 一上来就写裸注解 SQL"。
*/
private static final List<String> MAPPERS_WITHOUT_ENTITY = List.of();
private static final Pattern WRITE_ANNOTATION = Pattern.compile("@(Insert|Update|Delete)\\(");
private static final Pattern SELECT_ANNOTATION = Pattern.compile("@Select\\(");
private static final Pattern WRITE_ANNOTATION_BODY =
Pattern.compile("@(Insert|Update|Delete)\\(\\s*\"\"\"(.*?)\"\"\"", Pattern.DOTALL);
private static Map<String, Integer> writeSqlBaseline() {
Map<String, Integer> baseline = new LinkedHashMap<>();
baseline.put("CollectDataItemMapper", 1);
baseline.put("DedupeTotalDataMapper", 1);
baseline.put("DeviceLogFileMapper", 1);
baseline.put("ImageVideoAsyncTaskMapper", 3);
baseline.put("InvalidAsinDataMapper", 1);
baseline.put("UserNotificationMapper", 2);
baseline.put("UserColumnPermissionMapper", 4);
baseline.put("PriceTrackLoopRunMapper", 1);
baseline.put("PublishItemMapper", 1);
baseline.put("ShopDataCrawlItemMapper", 4);
baseline.put("ShopDataDuplicateScanMapper", 1);
baseline.put("QueryAsinMapper", 1);
baseline.put("SoftwareVersionMapper", 1);
baseline.put("TaskResultItemMapper", 1);
baseline.put("UserSecretUsageMapper", 2);
return baseline;
}
/** 读侧基线:TaskImageCacheMapper 的 5 条已在 mapper/task/TaskImageCacheMapper.xml 里。 */
private static Map<String, Integer> selectSqlBaseline() {
Map<String, Integer> baseline = new LinkedHashMap<>();
baseline.put("TaskCenterQueryMapper", 20);
baseline.put("ShopManageGroupMapper", 9);
baseline.put("ShopDuplicateCheckItemMapper", 5);
baseline.put("ShopDuplicateCheckSourceMapper", 5);
baseline.put("ImageVideoAdminTaskMapper", 4);
baseline.put("UserColumnPermissionMapper", 3);
baseline.put("ShopDataDuplicateScanMapper", 3);
baseline.put("AdminUserMapper", 2);
baseline.put("ShopDataCrawlAdminTasksMapper", 2);
baseline.put("QueryAsinMapper", 2);
baseline.put("BrandCrawlTaskMapper", 1);
baseline.put("DedupeTotalDataMapper", 1);
baseline.put("FileResultMapper", 1);
baseline.put("FileTaskMapper", 1);
baseline.put("TaskScopeStateMapper", 1);
return baseline;
}
private static final Pattern STATEMENT_ID =
Pattern.compile("<(?:select|insert|update|delete)\\s+id=\"[^\"]+\"");
private static Map<String, Integer> rawSqlInWrappersBaseline() {
Map<String, Integer> baseline = new LinkedHashMap<>();
@@ -147,17 +113,17 @@ class SqlLayeringConventionTest {
actualSelects.put(stem(file), read);
}
}
assertEquals(WRITE_SQL_BASELINE, actual, () -> "注解里的写 SQL 清单变了。" + System.lineSeparator()
+ " 新增 → 写进 src/main/resources/mapper/<模块>/<Name>Mapper.xml;"
+ "简单单表才用 BaseMapper/实体(wrapper)。" + System.lineSeparator()
+ " 迁走 → 把这一项从 WRITE_SQL_BASELINE 里减掉,让减法出现在 diff 上。");
assertFalse(actual.isEmpty(), "清单为空说明本用例没扫到任何 mapper,判据本身坏了");
assertEquals(SELECT_SQL_BASELINE, actualSelects, () -> "注解里的 @Select 逐接口清单变了(读侧同样 XML 优先)。"
assertEquals(WRITE_SQL_BASELINE, actual, () -> "注解里又出现了写 SQL(基线已归零)。" + System.lineSeparator()
+ " 新 SQL → 写进 src/main/resources/mapper/<模块>/<Name>Mapper.xml;"
+ "简单单表才用 BaseMapper/实体(wrapper)。当前实测:" + actual);
assertEquals(SELECT_SQL_BASELINE, actualSelects, () -> "注解里又出现了 @Select(基线已归零)。"
+ System.lineSeparator()
+ " 迁一条就从这里划掉一条;A 接口减一条配 B 接口加一条在这种钉法下会直接红。"
+ System.lineSeparator()
+ " 当前实测:" + actualSelects);
assertFalse(actualSelects.isEmpty(), "读侧清单为空说明正则或目录坏了——恒绿的闸门比没有闸门更糟");
+ " A 接口加一条配 B 接口减一条在这种逐接口钉法下会直接红。当前实测:" + actualSelects);
// 归零之后不能拿"清单为空"当自证,分母改由扫描面本身提供
int scanned = mappers().size();
assertTrue(scanned >= 60,
() -> "只扫到 " + scanned + " 个 *Mapper.java,多半是目录或工作目录坏了——"
+ "扫描面塌了的话上面两个 assertEquals(空表) 就成了恒绿");
}
/**
@@ -220,19 +186,26 @@ class SqlLayeringConventionTest {
"复杂写 SQL 的待迁清单变了:迁走一条就同时从 COMPLEX_WRITE_SQL_BACKLOG 划掉");
}
/**
* 反向钉:每扫到一份 mapper XML,它的同名接口就不许再留注解 SQL 或 {@code <script>} 残留。
* 名单由 {@code src/main/resources/mapper} 扫出来,不是手写的——多一份 XML 就自动进守卫,
* 少一份也不会让这条用例悄悄变绿。
*/
@Test
void everyMigratedMapperHasNoAnnotatedSqlLeft() {
for (String name : MIGRATED_TO_XML) {
void everyMigratedMapperHasNoAnnotatedSqlLeft() throws IOException {
List<Path> xmls = xmlFiles();
assertFalse(xmls.isEmpty(), "一份 XML 都没扫到,这条守卫就是恒绿的");
for (Path xml : xmls) {
String name = stem(xml);
Path file = findMapperInterface(name);
String text = stripComments(read(file));
assertFalse(count(WRITE_ANNOTATION, text) > 0,
() -> name + " 已迁到 XML,注解里却又出现写 SQL:同名会让 MyBatis 启动期抛重复语句");
assertFalse(count(SELECT_ANNOTATION, text) > 0,
() -> name + " 已迁到 XML,注解里却又出现 @Select:" + name);
int writes = count(WRITE_ANNOTATION, text);
int selects = count(SELECT_ANNOTATION, text);
assertTrue(writes == 0 && selects == 0,
() -> name + " 的语句已在 " + xml.getFileName() + " 里,注解却又出现 "
+ writes + " 条写 SQL / " + selects + " 条 @Select:同名会让 MyBatis 启动期抛重复语句");
assertFalse(text.contains("<script>"),
() -> name + " 的注解里还留着 <script>:迁移只做了一半,调用时会报 no statement");
assertTrue(xmlFiles().stream().anyMatch(x -> stem(x).equals(name)),
() -> name + " 声称已迁 XML,但 src/main/resources/mapper 下没有同名文件");
() -> name + " 的注解里还留着 <script>:迁移只做了一半,调用时才报 no statement");
}
}
@@ -272,25 +245,23 @@ class SqlLayeringConventionTest {
}
/**
* 这条是给"逐文件清单"这次改动自证的:以前钉的是总数 65 + 文件数 16 两个标量,
* 于是 A 接口加一条、B 接口减一条就能让两个标量双双不动而绕过闸门。
* 这里在内存里造出那次搬家——总和仍是基线总和,清单必须不等。
* 迁移完成态的分母。归零之后,"注解为空"本身证明不了任何东西(扫描面塌了也空),
* 所以把账本搬到 XML 一侧:语句总数必须是 96(本轮平移 85 + TaskImageCache 9 + AsinResultCache 2),
* 少一条就是搬运中丢了语句,多一条就是有人加了语句没记账。
*/
@Test
void thePerFileLedgerCatchesWhatTheScalarsCouldNot() {
int baselineTotal = SELECT_SQL_BASELINE.values().stream().mapToInt(Integer::intValue).sum();
assertTrue(baselineTotal > 0, "基线本身是空的,下面的断言就是恒真");
Map<String, Integer> moved = new LinkedHashMap<>(SELECT_SQL_BASELINE);
moved.merge("ShopManageGroupMapper", 1, Integer::sum);
moved.merge("ShopDuplicateCheckItemMapper", -1, Integer::sum);
assertEquals(baselineTotal, moved.values().stream().mapToInt(Integer::intValue).sum(),
"这次搬家必须让总数不变,否则它证明不了标量钉法的失明");
assertEquals(SELECT_SQL_BASELINE.size(), moved.size(),
"这次搬家必须让文件数也不变");
assertFalse(SELECT_SQL_BASELINE.equals(moved),
"逐文件清单没看见这次搬家——说明它退化成了标量比较");
void migratedStatementsLandInXmlWithoutLoss() throws IOException {
List<Path> xmls = xmlFiles();
int xmlCount = xmls.size();
assertTrue(xmlCount >= 28, () -> "只扫到 " + xmlCount + " 份 mapper XML,目录不对或文件被挪走");
int statements = 0;
for (Path xml : xmls) {
statements += count(STATEMENT_ID, read(xml));
}
int counted = statements;
assertEquals(XML_STATEMENT_TOTAL, counted,
() -> "mapper XML 里数到 " + counted + " 条语句,账本 " + XML_STATEMENT_TOTAL
+ "(分布在 " + xmlCount + " 份文件)—— 迁移漏了,或加了没记账");
}
@Test