스프링부트 YML 파일 설정 시 format_sql 오류 해결 방법

스프링부트를 사용하다 보면 YML 파일을 통해 다양한 설정을 하게 됩니다. 특히 JPA(Java Persistence API)를 사용할 때는 데이터베이스 연결, SQL 로깅, SQL 포맷팅 등 다양한 설정을 YML 파일에 추가하게 되죠. 그런데 이 과정에서 특정 키를 설정할 때 [format_sql]과 같이 대괄호([])로 감싸주지 않으면 오류가 발생하는 경우가 있습니다. 이번 글에서는 이러한 오류가 발생하는 이유와 해결 방법에 대해 알아보겠습니다.

문제 상황

스프링부트에서 JPA를 설정할 때, application.yml 파일에 다음과 같은 설정을 추가하는 경우가 있습니다.

spring:
  application:
    name: demo

  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: postgres
    driver-class-name: org.postgresql.Driver

  jpa:
    hibernate:
      ddl-auto: create-drop
    show-sql: true
    properties:
      hibernate:
        format_sql: true
    database: postgresql
    database-platform: org.hibernate.dialect.PostgreSQLDialect

위 설정에서 hibernate.format_sql을 true로 설정하여 SQL 쿼리를 포맷팅하려고 합니다. 그런데 이렇게 작성하면 다음과 같은 오류 메시지가 나타납니다.

This key is used in a map and contains special characters. It is recommended to escape it by surrounding it with '[]'

이 오류는 YML 파일에서 특수 문자가 포함된 키를 사용할 때 발생하는 문제입니다. YML 파일은 키에 특수 문자가 포함되어 있으면 이를 올바르게 파싱하지 못할 수 있기 때문에, 대괄호([])로 감싸주어야 합니다.

해결 방법

이 문제를 해결하려면 format_sql과 같이 특수 문자가 포함된 키를 대괄호로 감싸주면 됩니다. 즉, 다음과 같이 설정을 변경하면 됩니다.

spring:
  application:
    name: demo

  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: postgres
    driver-class-name: org.postgresql.Driver

  jpa:
    hibernate:
      ddl-auto: create-drop
    show-sql: true
    properties:
      hibernate:
        "[format_sql]": true
    database: postgresql
    database-platform: org.hibernate.dialect.PostgreSQLDialect

여기서 "[format_sql]": true와 같이 대괄호로 감싸주면 YML 파일이 정상적으로 파싱되며, 오류가 발생하지 않습니다.

왜 이런 오류가 발생할까?

YML 파일은 키-값 쌍으로 구성된 설정 파일입니다. 이때 키에는 일반적으로 알파벳, 숫자, 하이픈(-), 언더스코어(_) 등이 사용됩니다. 하지만 키에 특수 문자가 포함되어 있으면 YML 파서가 이를 올바르게 해석하지 못할 수 있습니다. 특히 format_sql과 같이 언더스코어(_)가 포함된 키는 YML 파일에서 특수 문자로 간주될 수 있기 때문에, 대괄호로 감싸주어야 합니다.

결론

스프링부트에서 YML 파일을 설정할 때 [format_sql]과 같이 특수 문자가 포함된 키를 사용해야 하는 경우, 대괄호로 감싸주는 것을 잊지 마세요. 이렇게 하면 YML 파일이 정상적으로 파싱되며, 오류 없이 원하는 설정을 적용할 수 있습니다.

이번 글에서는 스프링부트 YML 파일 설정 시 발생할 수 있는 [format_sql] 오류와 그 해결 방법에 대해 알아보았습니다. 이 정보가 스프링부트를 사용하는 개발자들에게 도움이 되길 바랍니다. 추가로 궁금한 점이 있다면 댓글로 남겨주세요!

---

이 글은 스프링부트 초보자부터 중급자까지 모두에게 유용한 정보를 제공하기 위해 작성되었습니다. YML 파일 설정 시 발생할 수 있는 다양한 오류와 해결 방법에 대해 더 알고 싶다면, 스프링부트 공식 문서나 관련 커뮤니티를 참고해보세요.