YAML

데이터 직렬화 포맷

데이터 직렬화는 구조화된 데이터를 저장하거나 전송할 수 있는 형식으로 변환한 뒤 나중에 복원할 수 있도록 하는 과정입니다. 포맷마다 사람이 읽기 쉬운 정도, 기계 파싱 용이성, 표현력, 파일 크기 사이에서 서로 다른 트레이드오프를 가집니다. 올바른 포맷을 선택하면 유지보수성이 높아지고 팀 간 협업이 원활해집니다. 대규모 시스템에서는 직렬화 포맷의 선택이 성능과 운영 효율성에 직접적인 영향을 미칩니다.

JSON, YAML, TOML, XML은 소프트웨어 개발에서 가장 널리 사용되는 네 가지 텍스트 기반 직렬화 포맷입니다. 각각 특정 상황에서 최선의 선택이 되는 강점이 있으며, 트레이드오프를 이해하면 각 작업에 맞는 포맷을 선택할 수 있습니다. 예를 들어 외부 API 통신에는 JSON이, 사람이 직접 편집하는 설정 파일에는 YAML이, 그리고 문서 중심의 데이터 교환에는 XML이 각각 강점을 발휘합니다. 포맷별 생태계와 도구 지원 현황도 선택에 중요한 요소입니다.

JSON과 YAML 나란히 비교

JSON과 YAML은 동일한 데이터 모델을 표현합니다. YAML은 JSON의 엄격한 상위 집합으로, 유효한 JSON 문서는 모두 유효한 YAML이기도 합니다. 아래는 동일한 설정을 두 포맷으로 표현한 예시입니다. 두 포맷을 직접 비교해 보면 각각의 문법적 특성을 직관적으로 이해할 수 있습니다.

{
  "server": {
    "host": "localhost",
    "port": 8080,
    "debug": true
  },
  "database": {
    "url": "postgres://localhost/mydb",
    "pool": 10
  }
}

server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgres://localhost/mydb
  pool: 10

YAML은 중괄호와 대괄호 대신 들여쓰기를 사용하며, 대부분의 문자열 값에서 따옴표를 생략합니다. 이로 인해 사람이 직접 편집하는 파일에서 더 간결하고 읽기 쉽지만, 들여쓰기에 민감해집니다. 반면 JSON은 구조가 명시적이어서 자동 생성 도구나 API 페이로드에 더 적합합니다. 팀에서 두 포맷을 모두 사용한다면, 용도에 따라 명확한 규칙을 정하는 것이 혼란을 줄이는 데 도움이 됩니다.

포맷 비교

YAML의 함정

YAML은 강력하지만 개발자들을 놀라게 하는 잘 알려진 엣지 케이스가 있습니다. 가장 흔한 사례들을 소개합니다. 이러한 함정들은 대부분 YAML의 암묵적 타입 변환과 공백 민감성에서 비롯되며, 사전에 알고 있으면 디버깅 시간을 크게 줄일 수 있습니다.

YAML 고유 기능

주석

YAML은 # 문자로 주석을 지원합니다. 이것은 설정 파일에서 JSON 대비 가장 큰 실용적 장점 중 하나로, 설정 내용을 인라인으로 문서화할 수 있습니다. 주석은 독립된 줄이나 값 뒤에 올 수 있습니다. 주석을 활용하면 복잡한 설정 값의 의도를 설명하거나, 임시로 비활성화한 옵션에 사유를 남길 수 있습니다. 잘 작성된 주석이 있는 YAML 파일은 별도의 문서 없이도 자기 설명적인 설정 파일이 됩니다.

앵커와 앨리어스

YAML에서는 &앵커이름으로 노드를 한 번 정의하고 *앵커이름으로 어디서든 재사용할 수 있습니다. 복잡한 설정에서 반복을 제거할 수 있으며, Kubernetes와 Docker Compose는 공유 서비스 정의에 앵커를 광범위하게 활용합니다. 앵커를 이용한 병합 키(<<: *앵커)를 사용하면 기본 설정을 상속하고 특정 값만 덮어쓰는 패턴을 깔끔하게 구현할 수 있습니다. 이는 환경별(개발/스테이징/프로덕션) 설정 파일을 관리할 때 특히 유용합니다.

여러 줄 문자열

YAML은 두 가지 모드의 블록 스칼라를 지원합니다. 리터럴 블록(|)은 줄바꿈을 그대로 유지하므로 스크립트나 템플릿에 유용하고, 폴딩 블록(>)은 긴 문자열을 한 줄로 합쳐 긴 산문 설명에 유용합니다. Kubernetes의 ConfigMap에서 여러 줄 설정 값을 삽입하거나, GitHub Actions에서 멀티라인 셸 스크립트를 인라인으로 정의할 때 리터럴 블록이 자주 쓰입니다. 최종 개행 처리 방식도 포맷 선택에 영향을 주므로, 정확한 출력이 필요한 경우 |-나 >- 지시자를 사용해 후행 개행을 제거하세요.

변환이 필요한 상황

자주 묻는 질문