[java] Querydsl을 사용하여 로깅 및 디버깅 작업 수행하기

17 Nov 2023

java

Querydsl은 코드 기반의 타입 안전한 쿼리 작성을 도와주는 Java 라이브러리입니다. 이를 사용하면 쿼리를 문자열로 작성하는 것이 아니라 Java 코드로 작성하여 컴파일 시점에 오류를 검출할 수 있습니다.

Querydsl을 사용하여 개발을 진행하면서 로깅 및 디버깅 작업은 필수적인 부분입니다. 이번 글에서는 Querydsl을 사용할 때 로깅과 디버깅을 어떻게 수행할 수 있는지 알아보겠습니다.

1. Logging

Querydsl은 실행된 쿼리의 로그를 출력할 수 있는 다양한 방법을 제공합니다. 예를 들어, Spring Framework를 사용하고 있다면 org.springframework.jdbc.core 패키지의 JdbcTemplate 객체를 사용하여 로깅을 수행할 수 있습니다.

import com.querydsl.core.DefaultQueryMetadata;
import com.querydsl.core.QueryMetadata;
import com.querydsl.core.types.Expression;
import com.querydsl.sql.Configuration;
import com.querydsl.sql.SQLQuery;
import com.querydsl.sql.SQLTemplates;
import com.querydsl.sql.SpringConnectionProvider;
import com.querydsl.sql.SQLServer2012Templates;

import org.springframework.jdbc.core.*;

public class QuerydslLoggingExample {

    private final JdbcTemplate jdbcTemplate;

    public QuerydslLoggingExample(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    public void executeQuery() {
        // Querydsl 사용을 위한 설정
        SQLTemplates templates = new SQLServer2012Templates(); // 사용하는 DB에 맞게 설정
        Configuration configuration = new Configuration(templates);
        SpringConnectionProvider connectionProvider = new SpringConnectionProvider(jdbcTemplate.getDataSource());
        configuration.set(connectionProvider);

        // Querydsl 쿼리 작성
        QueryMetadata metadata = new DefaultQueryMetadata();
        metadata.setProjection(expression);
        SQLQuery<Void> query = new SQLQuery<>(connectionProvider, configuration)
                .select(expression)
                .from(table)
                .where(condition);

        // 쿼리 로그 출력
        query.addListener(new SQLLogger());

        // 쿼리 실행
        query.fetch();
    }

    private static class SQLLogger extends SQLLogListenerAdapter {
        @Override
        public void logQuery(String query, List<Object> bindings) {
            // 로그 출력
            System.out.println("Query: " + query);
            System.out.println("Bindings: " + bindings);
        }
    }
}

위의 예제 코드에서는 JdbcTemplate를 사용하여 Querydsl을 실행하는 데 필요한 SQLQuery 객체를 생성합니다. 그리고 SQLLogger 클래스를 사용하여 쿼리와 바인딩 값의 로그를 출력합니다.

2. Debugging

Querydsl을 디버깅하는 방법 중 하나는 생성된 쿼리를 출력하여 확인하는 것입니다. 위에서 언급한 로깅 방법을 사용하면 쿼리를 확인할 수 있습니다.

또 다른 방법은 쿼리의 실행 계획을 확인하는 것입니다. 쿼리 실행 계획은 쿼리가 데이터베이스에서 어떻게 실행되는지를 보여주는 정보를 제공합니다. Querydsl의 경우, 쿼리의 실행 계획을 확인하기 위해 explain() 메소드를 사용할 수 있습니다.

SQLQuery<?> query = // Querydsl 쿼리 작성

String executionPlan = query.explain();
System.out.println(executionPlan);

위의 예제 코드에서는 explain() 메소드를 호출하여 실행 계획을 문자열로 가져온 후, 이를 콘솔에 출력합니다.

마무리

Querydsl을 사용하여 개발할 때 로깅과 디버깅은 중요한 부분입니다. 쿼리의 실행 로그를 출력하고, 실행 계획을 확인하여 문제를 진단하고 해결하는 데 도움을 받을 수 있습니다. 이를 통해 개발 작업의 효율성을 높일 수 있습니다.

더 자세한 내용은 Querydsl 공식 문서를 참고하시기 바랍니다.