目录

• 前言
• 项目环境
• 项目配置
• 总结

  前言

  在实际开发中，所有的sql语句参数都是带占位符的，但在本地开发时，为了方便测试追踪问题，经常需要查看具体执行的SQL语句内容，因此每次只能靠自己进行二次处理，耗时耗力，尤其是访问量大的情况下，很容易混淆，所以需要一个方法能够直接输出可以直接使用的SQL语句（将占位符替换成实际的参数），而Druid就支持此功能（Druid的主要功能可不是这个），所以此文主要讲如何在项目中使用Druid输出可执行SQL。

  项目环境

  因为是自己写的测试项目所以用到的版本都比较高，低版本的可能略有不同。

  本项目使用的环境是：

  Spring Boot 3.1

  JDK17

  Druid 1.2.18

  Postgresql 42.6.0

  pom.xml文件如下：

  
      org.springframework.boot
      spring-boot-starter
  
  
  com.alibaba
      druid-spring-boot-starter
      1.2.18
  
  
      org.projectlombok
      lombok
      provided
  
  
      org.postgresql
      postgresql
  
  
     org.springframework.boot
      spring-boot-dependencies
      3.1.1
      pom
      import
  
  

  项目配置

  • 使用Spring Boot默认的日志logback,可以在classpath下新建application.yml、application.properties或自定义logback.xml文件告诉Spring Boot我们哪些地方需要打印日志；

    yml配置如下：

    logging:
     level:
       druid.sql.Statement: debug
    spring:
     datasource:
       type: com.alibaba.druid.pool.DruidDataSource
       druid:
         url: jdbc:postgresql://127.0.0.1:5432/数据库名称
         username: 用户名
         password: 密码
         driver-class-name: org.postgresql.Driver
         filter:
           slf4j:
             enabled: true
             # 只有当 isStatementExecutableSqlLogEnable() isStatementLogEnabled() 都为ture的情况才打印 可执行sql
             # 在{# LogFilter#logExecutableSql }使用
             statement-executable-sql-log-enable: true
             # 在{# LogFilter#logExecutableSql }使用
             statement-log-enabled: true
             statement-create-after-log-enabled: false
             statement-log-error-enabled: true
             result-set-log-enabled: false
             #statementPrepareAfterLogEnable
             # 准备好的sql语句打印（此时为执行前）未进行参数拼接
             statement-prepare-after-log-enabled: false
             #isStatementParameterSetLogEnabled
             #打印参数
             statement-parameter-set-log-enabled: false
             #statementExecuteAfterLogEnable
             #sql语句执行完成后打印（执行后）未进行参数拼接
             statement-execute-after-log-enabled: false
             #statementCloseAfterLogEnable
             statement-close-after-log-enabled: false
    

    properties配置如下：

    logging.level.druid.sql.Statement=debug
    spring.datasource.druid.filter.slf4j.enabled=true
    #配置可执行sql语句日志打印
    #只有当 isStatementExecutableSqlLogEnable() isStatementLogEnabled() 都为ture的情况才打印 可执行sql
    #在{# LogFilter#logExecutableSql }使用
    spring.datasource.druid.filter.slf4j.statement-executable-sql-log-enable=true
    spring.datasource.druid.filter.slf4j.statement-log-enabled=true
    spring.datasource.druid.filter.slf4j.statement-log-error-enabled=true
    spring.datasource.druid.filter.slf4j.statement-create-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.result-set-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-prepare-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-parameter-set-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-execute-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-close-after-log-enabled=false
    

    xml配置如下：

    其它配置需要配置在yml、properties文件中

    
    	<-换成自己的appender引用->
        
    
    

    以上配置则可以输出可执行SQL，因为Spring Boot默认使用的是Logback，druid中没有logback的过滤器，slf4j是所有日志的门面，所以使用slf4j输出日志，如果需要使用用log4j只需要吧slf4j替换成log4j即可，不过还是推荐使用slf4j，至于为什么使用slf4j，百度很多人都已经说的很好了，另外druid的其他配置说明也请移步专业的druid文章，他们写的更加详细,另外还需要指定druid的日志登记为debug才能显示

    • 默认情况下Druid是关闭输出可执行SQL的，需要将statement-executable-sql-log-enable设置为true，详细配置文件在：

      public abstract class LogFilter extends FilterEventAdapter implements LogFilterMBean {
         //druid准备了四种类型的日志输出
         //这些logger分别对应打印 datasource相关、connection相关、statement相关、resultSet相关的日志
         //这里我们只关注statementLoggerName是打印可执行sql的关键
         protected String dataSourceLoggerName = "druid.sql.DataSource";
         protected String connectionLoggerName = "druid.sql.Connection";
         protected String statementLoggerName = "druid.sql.Statement";
         protected String resultSetLoggerName = "druid.sql.ResultSet";
         //需设置为true
         private boolean statementExecutableSqlLogEnable;
      }
      

      总结

      踩坑点：

      • 一开始参考其它文章说是将statement-log-enabled设置为false导致半天没有看到打印的日志最后查看源码在LogFilter#logExecutableSql有如下代码片段：

        //此方法就是打印可执行SQL的方法
        private void logExecutableSql(StatementProxy statement, String sql) {
        		//这里判断 StatementExecutableSqlLogEnable 和 StatementLogEnabled字段必须为ture
                if ((!isStatementExecutableSqlLogEnable()) || !isStatementLogEnabled()) {
                    return;
                }
                int parametersSize = statement.getParametersSize();
                if (parametersSize == 0) {
                    statementLog("{conn-" + statement.getConnectionProxy().getId() + ", " + stmtId(statement) + "} executed. "
                            + sql);
                    return;
                }
                List