基于Spring-Jdbc获取SQL执行计划的最优实现方案

我目前使用Spring-JDBC的NamedParameterJdbcTemplate执行数据库查询，代码示例如下：

NamedParameterJdbcTemplate jdbcTemplate;
// ...
List<DataDomain> events = jdbcTemplate.query(
    selectByStartAndEnd, // SQL语句
    parameters, // SQL参数
    dataMapper // 结果映射器
);

我希望能在日志中自动输出这些查询的执行计划，以此分析查询性能。虽然可以通过数据库UI客户端手动获取单条查询的执行计划，但我需要批量捕获代码中各类查询的执行计划，方便从日志里检测低效查询。请问在Spring-JDBC层面实现这个需求的最优方式是什么？

要实现批量输出查询执行计划的需求，我推荐以下几种Spring-JDBC层面的方案，按实用性和灵活性排序：

1. 使用Spring AOP拦截查询方法（最优解） #

Spring AOP可以无侵入地拦截NamedParameterJdbcTemplate的查询方法，在执行实际查询前自动生成并执行EXPLAIN语句，将执行计划打印到日志中。这种方式不需要修改业务代码，只需添加切面逻辑即可。

示例代码： #

@Aspect
@Component
@Slf4j
public class QueryPlanLoggerAspect {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    // 拦截NamedParameterJdbcTemplate的所有query方法
    @Around("execution(* org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate.query(..))")
    public Object logQueryPlan(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取方法参数：SQL语句、参数映射、结果映射器
        Object[] args = joinPoint.getArgs();
        String originalSql = (String) args[0];
        Map<String, ?> parameters = (Map<String, ?>) args[1];

        // 根据数据库类型生成EXPLAIN语句（这里以MySQL为例，其他数据库需调整）
        String explainSql = "EXPLAIN " + originalSql;

        // 将命名参数转换为占位符参数，适配JdbcTemplate的execute方法
        ParsedSql parsedSql = NamedParameterUtils.parseSqlStatement(originalSql);
        Object[] params = NamedParameterUtils.buildValueArray(parsedSql, parameters, null);
        String sqlWithPlaceholders = NamedParameterUtils.substituteNamedParameters(parsedSql, parameters);

        // 执行EXPLAIN并打印执行计划
        List<Map<String, Object>> explainResult = jdbcTemplate.queryForList(explainSql, params);
        log.info("查询执行计划：SQL = {}, 参数 = {}, 执行计划 = {}", sqlWithPlaceholders, parameters, explainResult);

        // 执行原查询方法
        return joinPoint.proceed();
    }
}

注意事项： #

• 不同数据库的EXPLAIN语法有差异：比如PostgreSQL可以用EXPLAIN ANALYZE（会实际执行查询，适合测试环境），Oracle用EXPLAIN PLAN FOR（需要后续查询PLAN_TABLE获取结果），需要根据你的数据库调整。
• 建议通过配置开关控制这个切面的启用，比如用@ConditionalOnProperty，只在测试/预发环境开启，避免生产环境额外的性能开销。

2. 自定义封装NamedParameterJdbcTemplate #

如果不想用AOP，也可以自己封装一个NamedParameterJdbcTemplate的子类，重写查询方法，在内部添加执行计划日志逻辑。这种方式侵入性稍强，但更直观。

示例代码： #

@Component
@Slf4j
public class LoggableNamedParameterJdbcTemplate extends NamedParameterJdbcTemplate {

    public LoggableNamedParameterJdbcTemplate(DataSource dataSource) {
        super(dataSource);
    }

    @Override
    public <T> List<T> query(String sql, Map<String, ?> paramMap, RowMapper<T> rowMapper) throws DataAccessException {
        // 生成并执行EXPLAIN语句，打印执行计划
        String explainSql = "EXPLAIN " + sql;
        ParsedSql parsedSql = NamedParameterUtils.parseSqlStatement(sql);
        Object[] params = NamedParameterUtils.buildValueArray(parsedSql, paramMap, null);
        List<Map<String, Object>> explainResult = getJdbcTemplate().queryForList(explainSql, params);
        log.info("查询执行计划：SQL = {}, 参数 = {}, 执行计划 = {}", sql, paramMap, explainResult);

        // 执行原查询
        return super.query(sql, paramMap, rowMapper);
    }

    // 按需重写其他query重载方法
}

然后业务代码中注入LoggableNamedParameterJdbcTemplate替代原有的NamedParameterJdbcTemplate即可。

3. 利用数据库驱动/连接池日志（备选方案） #

部分数据库驱动或连接池支持输出查询执行计划，但灵活性较差，可能会输出大量无关日志。比如：

• MySQL驱动可以通过配置logger=com.mysql.cj.log.Slf4JLogger并开启profileSQL=true，但不会直接输出执行计划，需要结合其他工具解析。
• PostgreSQL的pg_stat_statements插件可以记录查询的执行统计，但需要数据库层面配置，无法直接在Spring日志中输出执行计划。

这种方式适合快速排查，但不如前两种方案精准可控。

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