如何在编译期查看jOOQ执行的SQL语句

jOOQ没有原生支持的编译阶段直接获取实际执行SQL的能力

为什么不支持编译期获取SQL #

核心原因是jOOQ的最终SQL生成依赖大量运行时才确定的信息，编译阶段无法获取：

• 动态查询条件：大部分业务查询都会根据用户传入的参数动态拼接筛选条件，编译阶段不可能知道最终会拼接哪些条件
• 运行时配置：SQL方言、参数内联规则、SQL美化、标识符转义规则等配置都是运行时注入到DSLContext中的，编译阶段无法获取
• 动态参数值：如果需要拿到参数内联的完整SQL，参数值本身也是运行时才会传入的，编译阶段不存在这些值

可落地的替代方案 #

以下方案可以满足你在构建阶段提前拿到执行SQL的需求，无需等待业务代码实际运行：

方案1：单元测试+CI构建自动导出SQL #

你可以编写专用的单元测试用例，覆盖所有业务中用到的jOOQ查询、插入、更新逻辑，在测试用例中调用jOOQ提供的getSQL()方法直接导出SQL，将单元测试配置到CI流水线中，每次代码构建时自动运行测试，将所有SQL输出到指定文件归档，相当于在构建阶段就能拿到所有场景下的执行SQL。

示例代码：

import org.jooq.ParamType;
import org.jooq.SQLDialect;
import org.jooq.impl.DSL;
import static com.example.domain.tables.UserTable.USER_TABLE;

// 示例导出查询SQL
var dsl = DSL.using(SQLDialect.MYSQL); // 配置和生产完全一致的方言、转义规则等
var query = dsl.selectFrom(USER_TABLE)
        .where(USER_TABLE.ID.eq(1))
        .where(USER_TABLE.NAME.like("%test%"));
// 导出带?占位符的SQL
String placeholderSql = query.getSQL();
// 导出参数完全内联的SQL，和生产实际执行的SQL完全一致
String realExecSql = query.getSQL(ParamType.INLINED);

上述getSQL()方法适用于所有jOOQ构造的查询、插入、更新、删除等语句，没有语句类型限制。

方案2：静态查询APT注解处理器 #

如果你的业务中所有jOOQ查询都是无动态条件、无运行时参数的静态查询，你可以自定义APT注解处理器，在编译阶段扫描所有jOOQ查询构造代码，模拟执行构造逻辑拿到静态SQL。这个方案适用范围非常窄，仅适合完全静态的查询场景。

内容的提问来源于stack exchange，提问作者mattsmith5