Spring Boot SQL 설정(hibernate, logging)

📎 Spring Boot SQL 설정(hibernate, logging)

안녕하세요, Spring Boot의 hibernate SQL 설정에 대해 살펴보겠습니다.

 

실제 운영을 하다보면 수행된 쿼리문에 대해 파악하고, DB에서 결과값을 확인하고 싶을때가 있습니다.

이때, 로그 파일에 쿼리문이 저장이 되어있다면, 해당 쿼리문을 복붙하여 간단히 결과값을 확인할 수 있는 장점이 존재합니다. 물론 모든 쿼리문에 대해 로그 파일에 저장한다면 용량 등의 이슈가 있을수도 있겠죠? 

 

특히 복잡하게 수행되는 쿼리문이 애플리케이션 코드에 존재할 때, 이를 하나씩 분석하여 DB에서 쿼리를 수행하여 결과값을 확인하기에는 꽤나 번거로운 작업이 될 수 있는데요 이럴때 굉장히 편하게 확인할 수 있습니다.

StringBuilder sb = new StringBuilder(some_appropriate_size);
sb.append("select id1, id2, id3, id4, ... ");
sb.append(id2);
...

sb.append(" from ");
...

sb.append(" where ");
...

sb.append(" order by ");
...
return sb.toString();

특히 레거시 프로그램의 경우, 위와 같이 StringBuilder를 통해 쿼리문을 문자열로 만들어서 실행하는 코드도 있는데, 이와 같을때 실제 수행되는 쿼리를 파악하려면.. 막막합니다잉

요즈음, 로그 파일이 정말 중요함을 다시 한번 느끼고 있고, 파일에 정확한 로그를 남기는 것 또한 중요한걸 체험하고 있습니다.

 

 

📌  SQL 설정

hibernate.show_sql

spring.jpa.properties.hibernate.show_sql=true

spring.jpa.properties.hibernate.show-sql=true

https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html

 

• Hibernate가 DB에 수행하는 모든 쿼리문을 콘솔에 출력합니다.
• 디폴트 값은 false 입니다.
•  위 설정은 org.hibernate.SQL를 debug로 설정하는 것과 동일하지만, show_sql의 경우 System.out에 출력하는 반면 org.hibernate.sql의 경우 logger에 출력을 하는 차이점이 존재합니다.
• 공식문서에는 show_sql 으로 나와있으나 실제 properties(yml) 파일에는 자동완성이 show-sql로 되어있는데요, show-sql과 show_sql 둘 중 어느것을 사용해도 상관이 없습니다.

logging.level.org.hibernate.SQL=debug

 

실제 출력결과를 보면 System.out과 logger에 출력을 하므로 차이점이 존재합니다.

• show_sql=true

 

• org.hibernate.SQL=debug

 

logger의 경우 실제 수행되는 시각도 확인할 수 있기때문에 개인적으로는 org.hibernate.SQL=debug 사용을 권장합니다.

 

hibernate.format_sql

spring.jpa.properties.hibernate.format_sql=true

https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html

• 로그, 콘솔의 SQL을 좀 더 이쁘게 출력합니다.
• 만약 위 설정인 show_sql이 false라면 출력되는 쿼리문이 없으므로, 필요없는 설정입니다.
• 디폴트 값은 false 입니다.

format_sql = true

format_sql = false

위 두 결과를 확인해보면 format_sql 설정을 true로 한 결과가 딱봐도 한눈에 매우 보기가 좋은데요, 이처럼 반드시 설정을 true로 해야되지 않을까?라고 생각을 했었으나 제가 주로 참조하는 Baeldung에서는 다음과 같은 이야기를 하고 있습니다.

"While this is extremely simple, it's not recommended, as it directly unloads everything to standard output without any optimizations of a logging framework."

위 문장을 번역해보자면, "이 방법은 매우 간단하나 로깅 프레임워크의 어떠한 최적화도 없이 모든 것을 표준 출력(standard output)으로 직접 unload하므로 권장되지 않습니다." 라고 합니다.

가독성 좋게 개행을 하여 출력하기 때문에, 당연히 로그에 기록되는 파일의 용량이나 라인은 더 길어질 것입니다. 따라서 언제나 그렇듯(?) 상황에 맞게 적절히 사용하는것이 좋을 것 같습니다. 😂

 

hibernate.highlight_sql

spring.jpa.properties.hibernate.highlight_sql=true

• SQL 출력을 ANSI escape codes를 사용하여 색을 부여합니다.

 

hibernate.use_sql_comments

spring.jpa.properties.hibernate.use_sql_comments=true

• 보다 쉬운 디버깅을 위해 SQL 내부에 /* */의 주석을 추가합니다.

 

hibernate.type.descriptor.sql=trace

logging.level.org.hibernate.type.descriptor.sql=trace

• 쿼리문 로그에 출력되어 있는 파라미터(?)에 바인딩 되는 값을 확인할 수 있습니다.
• trace로 설정해야 바인딩 파라미터를 확인할 수 있습니다.

 

• binding parameter

 

 

📌  정리

위에서 설정한 옵션들을 정리하면 다음과 같습니다.

// properties
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.properties.hibernate.highlight_sql=true
spring.jpa.properties.hibernate.use_sql_comments=true
logging.level.org.hibernate.SQL=debug
logging.level.org.hibernate.type.descriptor.sql=trace

// yml
spring:
  jpa:
    properties:
      hibernate:
        format_sql: true
        highlight_sql: true
        use_sql_comments: true
logging:
  level:
    org:
      hibernate:
        SQL: debug
        type:
          descriptor:
            sql: trace

참고로 properties 확장자의 파일과 yml 확장자의 파일간 변환은 다음 사이트를 통해 손쉽게 할 수 있습니다.

• https://env.simplestep.ca/

 

위에는 SQL과 관련된 hibernate 설정 옵션들에 대해서만 살펴보았는데요, 공식문서에는 굉장히 많은 설정들이 존재합니다.

그동안 show_sql과 format_sql의 값만 설정해서 대략적으로 사용을 했었는데요, 정리를 통해 설정값들을 보다 자세히 파악할 수 있었습니다. 비슷한듯 비슷하지않은 설정들이 있어서 꽤 헷갈렸었는데요, 특히 쿼리문을 로깅하거나 바인딩 파라미터에 대해서도 로깅하는 방법에 대해 찾아보다가 헷갈려서 작성하게 되었습니다.

 

참고

• https://goodgid.github.io/Spring-Boot-SQL-Option/
• https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html