P6Spy 포맷 설정 공유합니다.

1. jpa 로그의 포맷처럼 줄바꿈을 넣으면서, 동시에 ? 자리에 바인딩 파라미터를 넣는 코드입니다.

    

2. P6Spy 1.8.1, Spring Boot 2.7.x, 마리아DB 10.1.x 사용했습니다.

3. application.properties 에서 JDBC 드라이버나 URL 에 P6Spy 를 추가하면 로그가 2번 출력될 수 있으니 주의하세요. 아래처럼 P6Spy 관련 드라이버? 코드? 가 포함되지 않도록 하시면 됩니다.

   # datasource
   spring.datasource.url=jdbc:mariadb://localhost:3306/YOUR_SCHEMA
   spring.datasource.username=YOUR_USERNAME
   spring.datasource.password=YOUR_PASSWORD
   
   # p6spy log
   logging.level.p6spy=info
   decorator.datasource.p6spy.enable-logging=true

    

4. 로그의 포맷을 실질적으로 꾸미는 구현 클래스입니다. 추가 정보는 실행시간 제외하고는 뺐는데, 필요하시면 추가하시면 됩니다.

    

   
   import com.p6spy.engine.logging.Category;
   import com.p6spy.engine.spy.appender.MessageFormattingStrategy;
   import org.hibernate.engine.jdbc.internal.FormatStyle;
   
   import java.util.Locale;
   
   public class P6SpyFormatter implements MessageFormattingStrategy {
   
       private static final String NEW_LINE = "\n";
       private static final String TAP = "\t";
       private static final String CREATE = "create";
       private static final String ALTER = "alter";
       private static final String DROP = "drop";
       private static final String COMMENT = "comment";
   
       @Override
       public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql, String url) {
           if (sql.trim().isEmpty()) {
               return formatByCommand(category);
           }
           return formatBySql(sql, category) + getAdditionalMessages(elapsed);
       }
   
       private static String formatByCommand(String category) {
           return NEW_LINE
                   + "Execute Command : "
                   + NEW_LINE
                   + NEW_LINE
                   + TAP
                   + category
                   + NEW_LINE
                   + NEW_LINE
                   + "----------------------------------------------------------------------------------------------------";
       }
   
       private String formatBySql(String sql, String category) {
           if (isStatementDDL(sql, category)) {
               return NEW_LINE
                       + "Execute DDL : "
                       + NEW_LINE
                       + FormatStyle.DDL
                       .getFormatter()
                       .format(sql);
           }
           return NEW_LINE
                   + "Execute DML : "
                   + NEW_LINE
                   + FormatStyle.BASIC
                   .getFormatter()
                   .format(sql);
       }
   
       private String getAdditionalMessages(long elapsed) {
           return NEW_LINE
                   + NEW_LINE
                   + String.format("Execution Time: %s ms", elapsed)
                   + NEW_LINE
                   + "----------------------------------------------------------------------------------------------------";
       }
   
       private boolean isStatementDDL(String sql, String category) {
           return isStatement(category) && isDDL(sql.trim().toLowerCase(Locale.ROOT));
       }
   
       private boolean isStatement(String category) {
           return Category.STATEMENT.getName().equals(category);
       }
   
       private boolean isDDL(String lowerSql) {
           return lowerSql.startsWith(CREATE)
                   || lowerSql.startsWith(ALTER)
                   || lowerSql.startsWith(DROP)
                   || lowerSql.startsWith(COMMENT);
       }
   }

    

   5. 아래 코드가 중요한데, 위 4에서 만든 포맷을 적용하는 시점을 알려주기 위해 만드는 JDBC 이벤트 리스너입니다. 어떤 블로그나 포럼에서는 포맷 적용 시점을 @PostConstruct 로 하던데, 그렇게 하면 테이블 create, drop 시점에 적용이 안 돼서 그렇게 하면 안 되고, 아래와 같이 Connection 이 생성되자마자 적용하면 됩니다.

    

import com.p6spy.engine.common.ConnectionInformation;
import com.p6spy.engine.event.JdbcEventListener;
import com.p6spy.engine.spy.P6SpyOptions;

import java.sql.SQLException;

public class P6SpyEventListener extends JdbcEventListener {

    @Override
    public void onAfterGetConnection(ConnectionInformation connectionInformation, SQLException e) {
        P6SpyOptions.getActiveInstance().setLogMessageFormat(P6SpyFormatter.class.getName());
    }
}

6. 이렇게 2개의 구현 클래스를 만들었으면, 아래와 같이 Bean 으로 등록해주기만 하면 설정 끝입니다.

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class P6SpyConfig {

    @Bean
    public P6SpyEventListener p6SpyCustomEventListener() {
        return new P6SpyEventListener();
    }

    @Bean
    public P6SpyFormatter p6SpyCustomFormatter() {
        return new P6SpyFormatter();
    }
}