怎样调试动态SQL语句

调试动态 SQL（Dynamic SQL）通常是开发中比较头疼的问题，因为 SQL 是在运行时拼出来的，不像静态 SQL 那样一眼就能看到。下面从思路、方法、工具、示例几个层面系统讲一下。

一、调试动态 SQL 的核心思路

第一步永远不是“执行”，而是“看到最终 SQL”

动态 SQL 的问题，90% 都出在：

• 拼接字符串错误
• 参数缺失或类型不匹配
• 条件分支拼错
• 引号 / 空格 / 逗号问题

所以调试的核心就是：

1. 把最终执行的 SQL 打印出来
2. 在数据库客户端里手工执行
3. 对比预期 SQL

二、常见动态 SQL 场景与调试方法

1️⃣ 字符串拼接型（如 Java / C# / Python）

示例（伪代码）

String sql = "SELECT * FROM user WHERE 1=1 ";
if (name != null) {
    sql += " AND name = '" + name + "'";
}
if (age != null) {
    sql += " AND age = " + age;
}

调试方法

✅ 打印最终 SQL

System.out.println(sql);

❌ 不要直接执行，先复制到：

• MySQL Workbench
• Navicat
• SQL Server Management Studio

✅ 观察：

• 是否有多余 AND
• 引号是否成对
• NULL 是否被拼成字符串 "null"

2️⃣ 使用参数化（推荐，但仍需调试）

String sql = "SELECT * FROM user WHERE name = ? AND age = ?";
PreparedStatement ps = conn.prepareStatement(sql);
ps.setString(1, name);
ps.setInt(2, age);

调试方法

• 打印 SQL + 参数值

log.info("SQL: {}, params: {}, {}", sql, name, age);

⚠️ 注意：

• ? 不能直接替换执行
• 可手动拼一个“等价 SQL”测试

3️⃣ MyBatis 动态 SQL

XML 示例

<select id="queryUser">
  SELECT * FROM user
  <where>
    <if test="name != null">
      AND name = #{name}
    </if>
    <if test="age != null">
      AND age = #{age}
    </if>
  </where>
</select>

调试方法（非常重要）

✅ 开启 MyBatis SQL 日志

logback / log4j

<logger name="com.xxx.mapper" level="DEBUG"/>

或（MyBatis 自带）

mybatis:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

你会看到：

==>  Preparing: SELECT * FROM user WHERE name = ?
==>  Parameters: Tom(String)

✅ 还能用：

• MyBatis PageHelper
• MyBatis Log Plugin（IDEA 插件，直接还原可执行 SQL）

4️⃣ 存储过程 / 函数中的动态 SQL

示例（MySQL）

SET @sql = CONCAT('SELECT * FROM ', table_name);
PREPARE stmt FROM @sql;
EXECUTE stmt;

调试方法

SELECT @sql;

或

SIGNAL SQLSTATE '45000' SET MESSAGE_TEXT = @sql;

三、通用调试技巧（强烈推荐）

✅ 1. 使用“日志型 SQL”

把动态 SQL 先写成：

SELECT 'DEBUG' AS flag, 'SELECT * FROM user WHERE name=...' AS sql_text;

✅ 2. 拆分条件

不要一次拼完，逐步打印：

sql += " AND age = " + age;
System.out.println(sql);

✅ 3. 用工具还原 SQL

• p6spy（拦截 JDBC，输出真实 SQL）
• log4jdbc
• IDEA 的 Database Console

四、常见坑位清单（自查）

五、最佳实践（避免调试）

✅ 能用参数化就用参数化
✅ 能用 ORM 就用 ORM
✅ 动态 SQL 用 <where> / <trim>
✅ 所有 SQL 都有日志开关
✅ 写单测验证 SQL 生成

如果你愿意，可以：

• 贴一段你的动态 SQL 代码
• 告诉我你用的是 Java / MyBatis / Python / SQL Server / MySQL
• 我可以直接帮你现场改 + 调试

这样最快。