spring boot) 특정 SQL 로그 감추기

Spring Boot + Log4jdbc + MyBatis에서 /* NOT_SQL_LOG */ 주석으로 SQL 로그 제외하기

---

✨ 개요

실제 개발에서는 로그에 SQL이 찍히는 게 유용할 때가 많지만,
✅ 민감한 쿼리나
✅ 너무 자주 호출되는 반복 쿼리의 경우, 로그를 깔끔하게 관리하고자 로그 출력을 제외하고 싶을 때가 있습니다.

Spring Boot + Log4jdbc 환경에서,
/* NOT_SQL_LOG */라는 주석을 MyBatis XML 파일에 삽입하면 해당 SQL만 로그에 출력되지 않도록 필터링하는 방법을 소개합니다.

---

🏗️ 프로젝트 환경

• Spring Boot: 3.3.4
• Java: 17
• MyBatis + XML 매퍼
• Log4jdbc: 1.16
• Log4j2: 3.3.1
• 로그 출력은 log4jdbc-log4j2-jdbc4.1 사용
• SQL 로그를 커스터마이징하기 위한 Log4j2 Filter 적용

---

🔍 사용 방법 요약

1. MyBatis SQL XML에 주석 추가
2. 커스텀 Log4j2 Filter 생성
3. log4j2.xml에 필터 등록

---

📌 Step 1. XML 매퍼에 주석 추가

mapper.xml 파일의 SQL에 아래 주석을 포함시킵니다: (/* NOT_SQL_LOG */)

<select id="getAB">
	/* NOT_SQL_LOG */
	SELECT * FROM user WHERE id = 5;
</select>

이 주석이 포함된 쿼리는 로그에 찍히지 않습니다.

---

🛠️ Step 2. 필터 클래스 생성

SqlLogFilter 클래스는 Log4j2의 커스텀 필터로, /* NOT_SQL_LOG */ 문자열을 감지하여 로그 출력을 막습니다.

package kr.co.sh.SmartWork.common.util;

import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.filter.AbstractFilter;

/**
 * SQL 로그에서 
 */
@Plugin(name = "SqlLogFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE)
public class SqlLogFilter extends AbstractFilter {

    private static final String NOT_SQL_LOG_COMMENT = "/* NOT_SQL_LOG */";

    protected SqlLogFilter(Result onMatch, Result onMismatch) {
        super(onMatch, onMismatch);
    }

    @Override
    public Result filter(LogEvent event) {
        if (event == null || event.getMessage() == null) {
            return Result.NEUTRAL;
        }

        String message = event.getMessage().getFormattedMessage();
        
        // /* NOT_SQL_LOG */ 주석이 포함된 SQL문인지 확인
        if (message.contains(NOT_SQL_LOG_COMMENT)) {
            return Result.DENY; // 로그 출력 차단
        }
        
        return Result.NEUTRAL; // 다른 로그는 정상 출력
    }

    @PluginFactory
    public static SqlLogFilter createFilter(
            @PluginAttribute("onMatch") Result onMatch,
            @PluginAttribute("onMismatch") Result onMismatch) {
        
        Result match = onMatch != null ? onMatch : Result.NEUTRAL;
        Result mismatch = onMismatch != null ? onMismatch : Result.NEUTRAL;
        
        return new SqlLogFilter(match, mismatch);
    }
}

📁 위치 예시:
kr.co.project.common.util.SqlLogFilter

---

⚙️ Step 3. log4j2.xml에 필터 등록

log4j2.xml의 JDBC 로거 설정에 필터를 추가합니다:

<Filters>
    <SqlLogFilter onMatch="DENY" onMismatch="NEUTRAL"/>
</Filters>

 

예시)

 

---

✅ 결과 확인

// 이 쿼리는 로그에 찍힘
<select id="getBC">
	SELECT * FROM attendance WHERE user_id = 1;
</select>


// 이 쿼리는 로그에 찍히지 않음
<select id="getAB">
	/* NOT_SQL_LOG */
	SELECT * FROM user WHERE id = 5;
</select>

---

🎯 정리

항목설명

목적	특정 SQL 로그 감추기 (보안 or 로그 가독성)
방법	/* NOT_SQL_LOG */ 주석을 활용한 필터링
적용 대상	MyBatis XML 매퍼 + log4jdbc 환경
커스터마이징	log4j2 필터 플러그인으로 유연하게 확장 가능

 

---

🧩 활용 팁

• 민감 정보 조회 쿼리 (ex. 비밀번호, 주민번호 등)
• 대용량 배치 반복 쿼리
• 단위 테스트 중 로그가 너무 많을 때

---

궁금한 점이 있다면 댓글로 남겨주세요!
도움이 되셨다면 ⭐️ 공감 + 스크랩 부탁드려요!