refactor(SQL分层): TaskImageCacheMapper 9 条注解 SQL 迁进 mapper XML,读侧判据改逐接口钉

档 B 口径:自定义语句一律进 XML,"特别简单"只剩 BaseMapper 自带 CRUD 与单表主键/唯一键点查。

判据这次不只是改数字。读侧原来钉的是「总数 65 + 文件数 16」两个标量,那么 A 接口加一条、
B 接口减一条就能让两个标量双双不动而绕过闸门,等于档 B 下没有闸门。改成逐接口清单
SELECT_SQL_BASELINE,并加 thePerFileLedgerCatchesWhatTheScalarsCouldNot 自证:在内存里造出
那次搬家,先断言总数与文件数确实都不变(证明旧钉法失明),再断言逐接口清单必须不等。

复用片段抽在真重复处:WHERE url_hash IN <foreach> 被三条语句共用,抽成 byUrlHashIn。
没抽列清单是刻意的——这个表每条语句只取必要列,image_bytes 是 BLOB,整行回读会把省内存
的缓存变成内存负担。所以新守卫 TaskImageCacheMapperXmlTest 钉的第一条就是"只有两条直读
字节的语句能碰 image_bytes"(迁 SQL 最顺手写成 SELECT *,而它在没有库的单测里不会自然变红),
其余钉 &lt; 是否还原成 <、LIMIT ? 是否仍是绑定参数、NOW(3) 毫秒精度、byte[] 的 resultType
必须写 "[B"(别名表里没有它)。

基线同步递减:写侧 29→25、读侧 65→60,MIGRATED_TO_XML 加 TaskImageCacheMapper。
定向 47 例绿(判据 9 + 新守卫 7 + asincache 样板 6 + 两个消费方 service 25)。
既有接口是 CRLF,改动走二进制删行,没把整份文件翻成 LF。
This commit is contained in:
2026-10-08 10:29:36 +08:00
parent 207225eb86
commit 3ed8a4265d
4 changed files with 308 additions and 33 deletions
@@ -21,8 +21,11 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
/**
* SQL 分层约定的守卫。口径(2026-10-08 定):<b>SQL 尽量写进 mapper XML</b>,
* wrapper 只留给"简单单表"(无 join、无函数级谓词、无动态标签),注解里不再新增 SQL。
* SQL 分层约定的守卫。口径(2026-10-08 定,同日收紧到"档 B"):<b>自定义语句一律写进 mapper XML</b>,
* "特别简单"才允许留在 Java 侧,而它只有两种形状——{@code BaseMapper} 自带 CRUD,以及单表按主键/唯一键的点查。
* 带自定义 WHERE 列组合、带投影列清单、带 join/子查询/函数级谓词/动态标签的都算自定义。
* 两份逐接口清单({@code WRITE_SQL_BASELINE} + {@code SELECT_SQL_BASELINE})就是这条口径的账本:
* 迁移进度按它减,新增按它红。
*
* <p>为什么要钉住而不是写在文档里:这个仓原来 0 个 XML、写 SQL 全在注解里,复杂语句
* ({@code <foreach>} + {@code ON DUPLICATE KEY} + 逐列 COALESCE)以 Java 文本块存在,
@@ -45,12 +48,12 @@ class SqlLayeringConventionTest {
private static final Map<String, Integer> WRITE_SQL_BASELINE = writeSqlBaseline();
/**
* 读侧注解 SQL 的总量与文件数(2026-10-08 实测 65 条 / 16 个接口)。
* 读侧按"尽量 XML"是主要待迁面,最重的是 TaskCenterQueryMapper;
* 钉总数而不是逐条清单,是因为逐条会把这份守卫变成迁移进度表——它该只做"别再加"的闸门。
* 读侧注解 SQL 的逐接口清单(2026-10-08 实测 65 条 / 16 个接口,迁走 TaskImageCacheMapper 后 60 / 15)。
*
* <p>为什么从"总数 + 文件数"两个标量改成逐接口:标量守恒的是**和**,A 接口减一条、
* B 接口加一条时两个标量都不动,闸门照样绿——档 B 口径下这等于没有闸门。
*/
private static final int SELECT_ANNOTATION_TOTAL = 65;
private static final int SELECT_ANNOTATION_FILES = 16;
private static final Map<String, Integer> SELECT_SQL_BASELINE = selectSqlBaseline();
/**
* wrapper 里夹带函数级 SQL 的现状("这不是简单单表"的证据),文件名 → 条数:
@@ -71,7 +74,7 @@ class SqlLayeringConventionTest {
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");
private static final List<String> MIGRATED_TO_XML = List.of("AsinResultCacheMapper", "TaskImageCacheMapper");
private static final Pattern WRITE_ANNOTATION = Pattern.compile("@(Insert|Update|Delete)\\(");
private static final Pattern SELECT_ANNOTATION = Pattern.compile("@Select\\(");
@@ -93,12 +96,32 @@ class SqlLayeringConventionTest {
baseline.put("ShopDataDuplicateScanMapper", 1);
baseline.put("QueryAsinMapper", 1);
baseline.put("SoftwareVersionMapper", 1);
baseline.put("TaskImageCacheMapper", 4);
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 Map<String, Integer> rawSqlInWrappersBaseline() {
Map<String, Integer> baseline = new LinkedHashMap<>();
baseline.put("PublishTaskService", 6); // ownerInstanceId 的 JSON_EXTRACT 谓词
@@ -112,8 +135,7 @@ class SqlLayeringConventionTest {
@Test
void annotationSqlInventoryDoesNotGrow() throws IOException {
Map<String, Integer> actual = new LinkedHashMap<>();
int selects = 0;
List<String> selectFiles = new ArrayList<>();
Map<String, Integer> actualSelects = new LinkedHashMap<>();
for (Path file : mappers()) {
String text = stripComments(read(file));
int writes = count(WRITE_ANNOTATION, text);
@@ -122,8 +144,7 @@ class SqlLayeringConventionTest {
}
int read = count(SELECT_ANNOTATION, text);
if (read > 0) {
selects += read;
selectFiles.add(stem(file));
actualSelects.put(stem(file), read);
}
}
assertEquals(WRITE_SQL_BASELINE, actual, () -> "注解里的写 SQL 清单变了。" + System.lineSeparator()
@@ -131,10 +152,12 @@ class SqlLayeringConventionTest {
+ "简单单表才用 BaseMapper/实体(wrapper)。" + System.lineSeparator()
+ " 迁走 → 把这一项从 WRITE_SQL_BASELINE 里减掉,让减法出现在 diff 上。");
assertFalse(actual.isEmpty(), "清单为空说明本用例没扫到任何 mapper,判据本身坏了");
assertEquals(SELECT_ANNOTATION_TOTAL, selects,
() -> "注解里的 @Select 总数变了(读侧同样按 XML 优先)。迁一条就减一:" + selectFiles);
assertEquals(SELECT_ANNOTATION_FILES, selectFiles.size(),
"带注解 @Select 的接口个数变了:" + selectFiles);
assertEquals(SELECT_SQL_BASELINE, actualSelects, () -> "注解里的 @Select 逐接口清单变了(读侧同样 XML 优先)。"
+ System.lineSeparator()
+ " 迁一条就从这里划掉一条;A 接口减一条配 B 接口加一条在这种钉法下会直接红。"
+ System.lineSeparator()
+ " 当前实测:" + actualSelects);
assertFalse(actualSelects.isEmpty(), "读侧清单为空说明正则或目录坏了——恒绿的闸门比没有闸门更糟");
}
/**
@@ -248,6 +271,28 @@ class SqlLayeringConventionTest {
+ "新 mapper 请 extends BaseMapper<XxxEntity>");
}
/**
* 这条是给"逐文件清单"这次改动自证的:以前钉的是总数 65 + 文件数 16 两个标量,
* 于是 A 接口加一条、B 接口减一条就能让两个标量双双不动而绕过闸门。
* 这里在内存里造出那次搬家——总和仍是基线总和,清单必须不等。
*/
@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),
"逐文件清单没看见这次搬家——说明它退化成了标量比较");
}
@Test
void xmlDirectoryIsActuallyOnTheLoadPath() throws IOException {
Path resources = moduleRoot().resolve("src/main/resources/mapper");