BACKEND / SPRING

Spring SQL 로깅 완벽 가이드: Log4j2와 Log4jdbc로 가독성 극대화하기

Spring 개발 중 '?'로 표시되는 쿼리 파라미터 때문에 답답하셨나요? Log4jdbc를 연동하여 SQL 실행 로그를 깔끔하게 정복하는 방법을 소개합니다.

📑 목차

• 1. 왜 Log4jdbc를 도입해야 할까?
• 2. Maven 의존성 추가 (pom.xml)
• 3. Log4j2 로거 설정 (log4j2.xml)
• 4. DataSource 프록시 및 포맷터 설정
• 5. 실전 운영 및 성능 최적화 팁

1. 왜 Log4jdbc를 도입해야 할까?

Spring의 기본 JDBC 로깅을 사용하면 SQL 파라미터가 ?(물음표)로 마스킹되어 출력됩니다. 이로 인해 실제 어떤 값이 쿼리에 바인딩되었는지 확인하기 어렵고, 긴 쿼리가 한 줄로 출력되어 가독성이 현저히 떨어집니다.

log4jdbc-log4j2를 프로젝트에 적용하면 다음과 같은 강력한 디버깅 환경을 구축할 수 있습니다.

• 파라미터 바인딩 확인: '?' 대신 실제 입력 값이 치환된 '실행 가능한 SQL'을 로그로 확인할 수 있습니다.
• 가독성 향상 (Multi-line): 복잡한 쿼리를 여러 줄로 정렬하여 출력하므로 구조 파악이 용이합니다.
• Result Set 시각화: SELECT 쿼리의 조회 결과를 콘솔에서 테이블 형태로 즉시 확인할 수 있습니다.

2. Maven 의존성 추가 (pom.xml)

가장 먼저 필요한 라이브러리를 프로젝트에 추가해야 합니다. 핵심 로깅을 담당하는 라이브러리와 커스텀 포맷팅을 지원하는 라이브러리 두 가지가 필요합니다.

<!-- log4jdbc-log4j2 (Log4j2 기반 SQL 로깅) -->
<dependency>
    <groupId>org.bgee.log4jdbc-log4j2</groupId>
    <artifactId>log4jdbc-log4j2-jdbc4</artifactId>
    <version>1.16</version>
</dependency>

<!-- log4jdbc-remix (Custom Formatter 지원) -->
<dependency>
    <groupId>org.lazyluke</groupId>
    <artifactId>log4jdbc-remix</artifactId>
    <version>0.2.7</version>
</dependency>

프로젝트에 이미 log4j2 관련 의존성이 설정되어 있는지 확인 후 진행하시기 바랍니다.

3. Log4j2 로거 설정 (log4j2.xml)

라이브러리 추가 후에는 Log4j2 설정 파일에서 어떤 SQL 정보를 출력할지 지정해야 합니다. 주요 로거 이름은 jdbc.sqlonly와 jdbc.resultsettable입니다.

<Loggers>
    <!-- 1. 실행된 SQL 쿼리 로그 (바인딩 변수 포함) -->
    <Logger name="jdbc.sqlonly" additivity="false">
        <Level value="info" /> 
        <AppenderRef ref="console" />
    </Logger>

    <!-- 2. SQL 실행 결과(ResultSet)를 테이블로 출력 -->
    <Logger name="jdbc.resultsettable" additivity="false">
        <Level value="info" /> 
        <AppenderRef ref="console" />
    </Logger>

    <Root level="info">
        <AppenderRef ref="console" />
    </Root>
</Loggers>

단순히 쿼리 문장만 확인하고 싶다면 jdbc.sqlonly만 info 레벨로 설정하고, 조회 데이터까지 검증이 필요하다면 jdbc.resultsettable도 활성화합니다.

4. DataSource 프록시 및 포맷터 설정

설정의 핵심은 기존 DataSource를 Log4jdbc 프록시 객체로 감싸는 것입니다. 이를 통해 JDBC 호출을 가로채어 로그를 남기게 됩니다. 또한 Log4JdbcCustomFormatter를 통해 출력 형식을 다듬을 수 있습니다.

<!-- 1. 원본 DataSource (예: DBCP, HikariCP 등) -->
<bean id="dataSourceSpied" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
    <property name="username" value="user"/>
    <property name="password" value="pass"/>
</bean>

<!-- 2. 프록시 DataSource (실제 빈으로 등록) -->
<bean id="dataSource" class="net.sf.log4jdbc.Log4jdbcProxyDataSource">
    <constructor-arg ref="dataSourceSpied"/>
    <property name="logFormatter">
        <!-- 3. SQL 포맷팅 설정 -->
        <bean class="net.sf.log4jdbc.tools.Log4JdbcCustomFormatter">
            <property name="loggingType" value="MULTI_LINE"/> <!-- 여러 줄 출력 -->
            <property name="sqlPrefix" value="SQL::: "/>       <!-- 로그 접두사 -->
        </bean>
    </property>
</bean>

loggingType="MULTI_LINE" 옵션은 특히 중요합니다. 이 옵션을 사용하면 SQL이 키워드 단위로 줄바꿈되어 출력되므로, 복잡한 비즈니스 로직의 쿼리를 분석할 때 시각적 피로도를 크게 줄여줍니다.

5. 실전 운영 및 성능 최적화 팁

모든 설정을 마쳤다면, 운영 환경(Production) 배포 시 다음 사항을 반드시 고려해야 합니다.

• 개발 환경(Dev): jdbc.sqlonly와 jdbc.resultsettable을 INFO로 설정하여 디버깅 효율을 극대화합니다.
• 운영 환경(Prod): SQL 로깅은 I/O 성능 저하를 유발할 수 있으며, 민감한 데이터가 로그 파일에 남을 보안 위험이 있습니다. 따라서 로깅 레벨을 WARN 또는 ERROR로 상향 조정하여 불필요한 로그 적재를 방지해야 합니다.
• Spring Boot 사용자: XML 설정 대신 Java Config(@Configuration)를 사용하거나, 편리한 설정을 돕는 log4jdbc-spring-boot-starter 라이브러리 활용을 권장합니다.

💡 이제 지저분한 로그 대신, 구조화되고 읽기 쉬운 SQL 로그를 통해 쾌적한 개발 환경을 경험해 보시기 바랍니다.