JSON, YAML, XML 차이와 변환할 때 사라지는 것
JSON, YAML, XML은 데이터 모델이 서로 달라서, 형식 간 변환은 표기만 바꾸는 일이 아니라 규칙에 따른 대응입니다. 주석, 앵커, 속성, 배열 형태, 값의 타입이 변환에서 가장 자주 사라집니다.
ConvertBox게시
같은 데이터의 세 가지 표기가 아니라 세 가지 데이터 모델
JSON, YAML, XML은 같은 데이터를 적는 방법만 다른 형식처럼 소개되곤 합니다. 실제로는 각자 데이터 모델이 다르고, 모델이 어긋나는 지점마다 변환기가 규칙을 정해야 합니다. JSON의 값은 정확히 여섯 종류입니다. YAML 1.2는 JSON이 표현하는 것을 모두 표현할 수 있고, JSON 문서가 그대로 유효한 YAML이 되도록 설계되었으며, 여기에 주석과 참조, 여러 가지 문자열 표기를 더했습니다. XML은 문서 형식입니다. 이름이 붙은 요소가 속성과 텍스트를 가지는 트리이고, 숫자·불리언·배열이라는 개념이 문법에 없습니다.
| JSON | YAML | XML | |
|---|---|---|---|
| 값의 타입 | 문자열, 숫자, 불리언, null, 배열, 객체 | JSON과 같은 타입을 따옴표 없는 값의 표기로 추론 | 텍스트뿐이며, 타입은 스키마나 읽는 쪽이 정함 |
| 주석 | 없음 | #부터 줄 끝까지 | <!-- ... --> |
| 속성 | 없음 | 없음 | 있음: <user id="7"> |
| 블록 재사용 | 없음 | 앵커와 별칭: &base, *base | DTD 엔티티로만 가능 |
| 텍스트와 마크업 혼합 | 불가 | 불가 | 가능: <p>Hello <b>world</b></p> |
| 문법 규칙 | 큰따옴표만 허용, 마지막 쉼표 금지 | 들여쓰기가 곧 구조이며 탭으로 들여쓸 수 없음 | 모든 태그를 닫고 루트 요소는 하나 |
파서의 엄격함과 실수가 숨는 자리
JSON(RFC 8259)은 셋 중 작성 규칙이 가장 엄격합니다. 키와 문자열에는 큰따옴표가 필요하고, 마지막 항목 뒤의 쉼표는 오류이며, 주석은 없습니다. 대신 문서는 파싱되거나 분명하게 실패하거나 둘 중 하나입니다. 이 사이트의 JSON 포매터가 결과 대신 오류를 보여 준다면 실제 결함이 있다는 뜻이고, 대개 마지막 쉼표, 작은따옴표, 주석, 또는 자바스크립트 콘솔에서 복사한 NaN 같은 값이 원인입니다.
XML도 적격성(well-formedness)에 대해서는 똑같이 엄격합니다. 모든 태그를 닫아야 하고, 속성값에는 따옴표가 필요하며, 루트 요소는 정확히 하나여야 합니다. 여기에 XSD 같은 스키마 언어로 올바른 요소가 올바른 순서와 타입으로 나오는지까지 검사할 수 있는데, 이런 기능은 JSON과 YAML에는 기본으로 들어 있지 않습니다. YAML은 반대입니다. 쓰기는 쉽지만 구조가 들여쓰기에서 나오므로, 두 칸 더 들여쓴 줄도 여전히 유효한 YAML이면서 뜻만 달라지고 아무 경고도 나오지 않습니다. YAML 파일을 JSON으로 변환해 보면 파서가 실제로 이해한 구조를 확인할 수 있습니다. 중괄호와 대괄호가 중첩을 명시적으로 보여 주기 때문입니다.
형식별로 자연스러운 사용처
- JSON은 프로그램 간 교환에 씁니다. 웹 API, 브라우저 저장소, 로그 레코드, 패키지 매니페스트가 대표적입니다. 주요 언어가 모두 기본으로 파싱하고, 타입 구성이 프로그램이 쓰는 타입과 맞습니다.
- YAML은 사람이 직접 고치는 파일에 씁니다. 쿠버네티스 매니페스트, Docker Compose 파일, CI 파이프라인 정의, Ansible 플레이북이 그렇습니다. 주석과 앵커 덕분에 긴 설정도 읽기 쉽게 유지됩니다.
- XML은 문서와 스키마가 정해진 교환에 씁니다. SOAP 서비스, RSS와 Atom 피드, SVG, .docx와 .xlsx 파일 내부의 구성 요소가 XML입니다. 텍스트와 마크업이 섞이거나 받는 쪽이 XSD로 검증한다면 XML을 선택합니다.
- 간단한 기준은 이렇습니다. 프로그램이 쓰고 프로그램이 읽으면 JSON, 사람이 관리하면 YAML, 표준이나 상대 시스템이 요소 이름을 정해 두었으면 XML입니다.
YAML의 타입 추론과 노르웨이 문제
YAML은 따옴표 없는 값의 타입을 표기로 판단하며, 이 규칙은 버전에 따라 다릅니다. YAML 1.1은 yes, no, on, off와 그 대문자 표기를 불리언으로 취급합니다. 그래서 국가 코드 목록에 노르웨이를 뜻하는 NO가 있으면 false로 읽힙니다. YAML 1.2는 true와 false만 남겼지만, PyYAML을 비롯해 널리 쓰이는 파서 가운데 아직 1.1 규칙을 따르는 것이 있습니다. 같은 파일이 도구에 따라 다른 뜻이 될 수 있다는 얘기입니다.
대처법은 어디서나 같습니다. 다른 타입으로 읽힐 수 있는 문자열에는 따옴표를 붙입니다. 이 사이트의 JSON to YAML 변환기는 출력할 때 이 작업을 합니다. '012', 'true', '2024-01-01' 같은 문자열은 물론 YAML 1.1의 yes, no, on, off까지 작은따옴표로 감싸므로, 결과물이 오래된 파서에서도 그대로 읽힙니다.
| 따옴표 없는 YAML | YAML 1.1 파서(PyYAML 등) | ConvertBox YAML to JSON(js-yaml, YAML 1.2 규칙) |
|---|---|---|
| country: NO | false | "NO" |
| enabled: yes | true | "yes" |
| zip: 012 | 10(8진수로 해석) | 12 |
| version: 1.20 | 1.2 | 1.2 |
| released: 2024-01-01 | 날짜 값 | "2024-01-01T00:00:00.000Z" |
JSON과 YAML: 왕복 변환에서 빠지는 것
JSON에서 YAML로 갈 때는 데이터가 손실되지 않습니다. 모든 JSON 값에 대응하는 YAML 표기가 있기 때문입니다. 달라질 수 있는 것은 부수적인 부분입니다. 이 사이트의 변환기는 먼저 브라우저의 JSON 파서로 입력을 읽으므로 1.0은 1로 쓰이고, 2^53(9007199254740991)을 넘는 정수는 끝자리가 달라지며, 중복 키는 마지막 값 하나로 합쳐지고, 정수처럼 보이는 키는 객체의 맨 앞으로 옮겨집니다.
정보가 사라지는 쪽은 YAML에서 JSON으로 가는 방향입니다. 주석은 빠집니다. 앵커(&base)와 별칭(*base)은 전체 복사본으로 풀리고 병합 키(<<: *base)는 병합된 결과로 바뀌므로, JSON 자체는 정확하지만 서비스 다섯 개가 한 블록을 공유했다는 사실은 남지 않습니다. 블록 스칼라는 일반 문자열이 되고, 문자열이 아닌 키는 문자열이 되며, .inf와 .nan은 JSON에 해당 숫자가 없어 null이 됩니다. 또한 YAML to JSON 도구는 ---로 구분된 다중 문서와 CloudFormation의 !Ref 같은 애플리케이션 전용 태그를 거부하므로 문서를 하나씩 변환해야 합니다. 원본은 YAML 파일로 관리하시기 바랍니다. JSON으로 바꿨다가 되돌리면 동등한 데이터는 얻지만 원래 파일은 돌아오지 않습니다.
JSON과 XML: 속성, 반복 요소, 타입
XML에는 배열이 없고 JSON에는 속성이 없습니다. 그래서 변환기마다 나름의 규약을 정하며, 그 규약은 도구마다 다릅니다. 표는 이 사이트의 두 변환기가 쓰는 규약입니다.
JSON to XML 방향에서는 전체를 root라는 요소로 감싸고, 속성은 만들지 않으며, 요소 이름에 쓸 수 없는 문자를 밑줄로 바꿉니다. first name이라는 키는 first_name이 되고, 한글로 쓴 키는 전부 밑줄이 됩니다. SOAP이나 RSS처럼 요소 이름, 네임스페이스, 속성이 정해진 형식에 맞추려면 결과를 직접 고치거나 매핑을 명시할 수 있는 라이브러리를 써야 합니다.
| 입력 | 출력 | 주의할 점 |
|---|---|---|
| JSON "tag": ["a", "b"] | <tag>a</tag> <tag>b</tag> | 배열은 감싸는 요소 없이 반복 요소가 됨 |
| XML <tag>a</tag>가 한 번만 나옴 | "tag": "a" | 요소가 하나면 문자열, 둘이면 배열 |
| JSON "age": 30, "ok": true | <age>30</age> <ok>true</ok> | 다시 JSON으로 바꾸면 둘 다 문자열 "30", "true" |
| JSON "items": [] | 아무것도 없음 | 빈 배열은 흔적이 남지 않음 |
| XML <user id="7">Ann</user> | "user": {"@attributes": {"id": "7"}, "#text": "Ann"} | 속성은 예약된 키 아래에 보존 |
| XML <p>Hello <b>big</b> world</p> | "p": {"b": "big"} | 자식 요소 사이의 텍스트는 버려짐 |
실제 파일을 변환하기 전에 확인할 것
- 숫자, 불리언, 날짜처럼 보이는 YAML 문자열에는 따옴표를 붙입니다. 버전 번호, 우편번호, 국가 코드, 시각이 해당합니다.
- 15자리를 넘는 식별자는 문자열로 다룹니다. 자바스크립트 기반 도구는 2^53보다 큰 정수를 반올림합니다.
- XML을 JSON으로 바꾼 뒤에는, 반복될 수 있는 요소에 대해 단일 값과 배열을 모두 처리하도록 코드를 작성합니다.
- 서명이나 체크섬이 정확한 바이트를 대상으로 한다면 포맷팅이나 변환보다 검증을 먼저 합니다. 다시 직렬화하면 바이트가 달라집니다.