如何在JPA中获取带占位符实际值的SQL查询语句？

嘿，我懂你想要啥——在参数填充完之后拿到完整的SQL字符串，不管是调试排查问题还是验证SQL逻辑，这确实超实用！不过得先说清楚：JPA本身并没有提供标准的API来直接干这个事儿，毕竟不同的JPA实现（比如Hibernate、EclipseLink）处理参数绑定的逻辑不一样，得针对具体的提供商来操作。下面给你几种常见场景的解决方案：

如果你用的是Hibernate（最主流的JPA实现） #

Hibernate提供了一些内部API可以帮我们获取填充后的SQL，不过需要先把JPA的Query对象转成Hibernate的专属接口：

针对JPQL查询的情况 #

如果你的sqlQuery是JPQL语句，可以通过QueryTranslator来生成对应的原生SQL，再手动替换参数：

// 将JPA Query转换为Hibernate Query
org.hibernate.query.Query<?> hibernateQuery = query.unwrap(org.hibernate.query.Query.class);
// 获取Hibernate Session
Session session = entityManager.unwrap(Session.class);

// 初始化QueryTranslator来解析JPQL为原生SQL
QueryTranslatorFactory translatorFactory = session.getSessionFactory()
        .getServiceRegistry()
        .getService(QueryTranslatorFactory.class);
QueryTranslator translator = translatorFactory.createQueryTranslator(
        hibernateQuery.getQueryString(),
        hibernateQuery.getQueryString(),
        Collections.emptyMap(),
        session.getSessionFactory(),
        null
);
translator.compile(Collections.emptyMap(), false);

// 拿到原生SQL模板
String nativeSqlTemplate = translator.getSQLString();
// 获取已绑定的参数值列表
List<Object> paramValues = new ArrayList<>();
for (int i = 0; i < hibernateQuery.getParameterMetadata().getParameterCount(); i++) {
    paramValues.add(hibernateQuery.getParameterValue(i));
}

// 替换占位符为实际参数值（简单实现，复杂类型需要额外处理）
String filledSql = nativeSqlTemplate;
for (Object value : paramValues) {
    String strValue;
    if (value instanceof String) {
        strValue = "'" + value + "'";
    } else if (value instanceof Number) {
        strValue = value.toString();
    } else {
        // 日期、枚举等类型需要转换成数据库兼容的格式
        strValue = "'" + value.toString() + "'";
    }
    filledSql = filledSql.replaceFirst("\\?", strValue);
}

// 现在filledSql就是填充好参数的SQL字符串了
System.out.println(filledSql);

针对原生SQL查询的情况 #

如果是用createNativeQuery创建的原生SQL查询，逻辑更简单：直接拿到SQL模板后替换参数即可，步骤和上面的参数替换部分一致，只是不需要转JPQL为原生SQL。

如果你用的是EclipseLink #

EclipseLink也有自己的专属API来获取填充后的SQL：

// 将JPA Query转换为EclipseLink的DatabaseQuery
org.eclipse.persistence.jpa.JpaQuery<?> eclipseLinkJpaQuery = query.unwrap(org.eclipse.persistence.jpa.JpaQuery.class);
org.eclipse.persistence.queries.DatabaseQuery dbQuery = eclipseLinkJpaQuery.getDatabaseQuery();

// 准备查询以生成带参数的SQL
org.eclipse.persistence.jpa.JpaEntityManager em = entityManager.unwrap(org.eclipse.persistence.jpa.JpaEntityManager.class);
dbQuery.prepareCall(em.getActiveSession());

// 获取填充好参数的SQL字符串
String filledSql = dbQuery.getSQLString();
System.out.println(filledSql);

通用调试方案（无需修改代码） #

如果只是临时调试用，其实没必要写代码去获取——直接开启JPA提供商的SQL日志就行：

• 对于Hibernate，在配置文件里加这两行：

  logging.level.org.hibernate.SQL=DEBUG
  logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
  

  日志里会打印出执行的SQL模板，以及每个占位符对应的参数值，虽然不是完整的拼接字符串，但足够你排查问题了。

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