利用JDBC的PrepareStatement打印真实SQL的方法详解

利用JDBC的PrepareStatement打印真实SQL的方法详解：

JDBC中的PrepareStatement对象是常用的执行SQL语句的方式，通过prepareStatement构建出的SQL语句是带有参数占位符的。然而，有时候我们需要查看这个SQL语句的完整内容，包括占位符的具体值。我们可以通过以下步骤达到目的：

1. 将占位符的具体值设置进PrepareStatement对象中

此步骤需要在构建PrepareStatement对象之后，但在执行SQL语句之前进行操作。例如，在以下的代码片段中：

String sql = “SELECT * FROM tb_user WHERE name = ? and age = ?”;

PreparedStatement ps = conn.prepareStaement(sql);

ps.setString(1, “test”);
ps.setInt(2, 20);

在构建PrepareStatement之后，我们需要使用ps.setXXX()方法设置占位符的具体值，这里我们用setString()和setInt()作为示例。其中，1代表占位符的位置是第1个，2代表占位符的位置是第2个。

1. 手动拼接完整的SQL语句并输出日志

此步骤是利用JDBC驱动程序提供的钩子实现，JDBC驱动程序可以在执行SQL语句之前，将PreparedStatement中带有参数占位符的SQL语句拼接成完整的SQL语句，并输出日志。这里我们需要实现JDBC钩子，具体的代码示例如下：

Connection conn = DriverManager.getConnection(url, username, password);
conn.setAutoCommit(true);
String sql = “SELECT * FROM tb_user WHERE name = ? and age = ?”;

PreparedStatement ps = conn.prepareStatement(sql);

ps.setString(1, “test”);
ps.setInt(2, 20);

LogProxyStatement logProxy = new LogProxyStatement(ps);

ResultSet rs = logProxy.executeQuery();

这里我们的ExecuteQuery方法使用了一个LogProxyStatement类，这个类是实现JDBC钩子功能的核心代码：

public class LogProxyStatement implements Statement {
    private Statement statement;

    public LogProxyStatement(Statement statement) {
        this.statement = statement;
    }

    ...

    @Override
    public ResultSet executeQuery(String sql) throws SQLException {
        printSQL(sql); // 输出分析后的sql语句
        return statement.executeQuery(sql);
    }

    private void printSQL(String sql) {
        // 钩子实现
        // 具体实现需根据使用的日志框架来决定
        // 以下示例使用的是Log4j2框架

        ThreadContext.put("sql", sql);
        LOGGER.info("Executing SQL: {}", sql);
        ThreadContext.clearAll();
    }

    ...
}

在这个示例中，我们使用了一个Log4j2框架，并利用ThreadContext实现了上下文的管理，将完整的SQL语句保存在ThreadContext中，并输出到日志中。我们也可以根据不同的需求，使用不同的日志框架或实现方式。

示例2：

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

String stmt = pstmt.toString().split(":")[1].replaceFirst("^\\s+", "");
System.out.println(stmt);

这个示例中，我们使用了PrepareStatement的toString()方法来获取完整的SQL语句，最后通过字符串操作的方式截取所需的部分并输出。虽然这个方法十分简便，但在生产环境中并不推荐使用，因为JDBC驱动程序可以在执行SQL语句之前，对SQL进行最佳化处理，使其更加高效，而toString()方法返回的SQL并不是最终的SQL，可能无法反映SQL的最终执行方式。