SuperAPI AI 工具集

audit-sql

编程与开发

查看项目

更新于 10-30 05:34

技能介绍

用途

audit-sql 是一个 SQL 审计技能,用于对项目中的 MyBatis mapper XML 文件执行生产就绪性审查。当用户需要审查 SQL 查询是否满足生产要求、审计数据库性能与索引使用情况、分析锁风险或并发问题、检查大数据集下的 SQL 可扩展性时,可启用该技能。

主要能力

该技能的核心工作方式是发现项目结构,读取 DDL schema 文件与所有 MyBatis mapper XML,然后对每条 SQL 语句按以下五类标准逐项审计:

  • 索引完整性:标记 WHERE、JOIN、ORDER BY 中引用但缺少支持索引的列;检测复合索引最左前缀跳过问题;检测可能因参数类型与列类型不一致导致的隐式类型转换,从而失效索引。
  • 执行计划风险:识别全表扫描模式,包括前导通配符 LIKE '%abc'、对索引列使用函数(如 YEAR(date_col) = 2024)、阻止索引使用的 OR 条件、对索引列使用 NOT IN / <> / !=;标记缺失 LIMIT 的无界结果集查询。
  • 并发与锁:分析批量轮询查询是否缺少 FOR UPDATE SKIP LOCKED、WHERE 条件无索引导致的锁扫描、非索引列 ORDER BY 在 InnoDB 行锁下的风险;分析保留清理/批量删除中的大 LIMIT 长时间持锁、过滤列缺索引、并发删除死锁风险;标记无索引的 UPDATE ... WHERE status = X 及无附加过滤的批量状态重置 UPDATE。
  • 资源压力:标记对含 TEXT/MEDIUMTEXT/BLOB/LONGTEXT 列的表执行 SELECT *;识别循环内逐项调用的 N+1 查询;标记大数据集上的 OFFSET 分页并建议键集/游标分页;标记无大小限制的批量 INSERT。
  • 可扩展性(生产阻断检测):评估每条查询在 1M+ 行数据下是否可行,标记关联子查询、缺少 JOIN 条件的笛卡尔积、无覆盖索引的 COUNT(*)、大表间无 LIMIT 的无界 JOIN、DELETE ... WHERE id IN (SELECT ...) 反模式,以及未按分区键过滤导致的全分区扫描。

使用方式

技能激活后,首先搜索 DDL schema 文件(如 sqls/、db/、migration/、schema/ 或 src/main/resources/db/ 目录下的 *.sql)以理解表定义、索引、分区和列类型;随后搜索项目中所有 MyBatis mapper XML 文件(通常为 *Mapper.xml 或 **/resources/mapper/ 下的 *.xml)。若未找到 DDL 文件,则从 mapper XML 和实体类推断表结构。接着读取并分析 DDL 与每个 mapper XML,对每条 SQL 按上述标准审计,最终生成按 mapper 文件分组、带严重等级的结构化报告。

报告格式要求为每个发现列出:严重等级与标题、Mapper 文件及 queryId、大致行号、问题描述、生产风险、修复建议(含代码示例)。结尾需提供严重等级计数表、前三项最高优先级修复、建议添加的复合索引(含精确 DDL)以及 schema 层建议。

硬性规则

必须审计项目中所有 mapper XML 文件,不得跳过;每条 SQL 语句必须对照所有审查标准检查;发现问题必须带严重等级报告,不得静默放过可疑查询。

适用场景

适用于使用 MyBatis 的 Java 项目在发布前进行 SQL 生产就绪审查、数据库性能与索引优化审计、并发与锁风险排查,以及面向大数据量的 SQL 可扩展性评估。

限制

该技能面向 MyBatis mapper XML,不覆盖其他 ORM 或直接 SQL 调用场景;审计依赖 DDL 文件或实体类推断表结构,若两者均缺失则表结构信息不完整;报告中的严重等级和建议由技能规则生成,仍需人工复核确认。