YAML

Formaty serializacji danych

Serializacja danych to proces przekształcania ustrukturyzowanych danych do formatu, który można przechowywać lub przesyłać, a następnie odtworzyć. Różne formaty dokonują różnych kompromisów między czytelnością dla człowieka, parsowalnością maszynową, ekspresywnością i rozmiarem pliku. Wybór odpowiedniego formatu na wczesnym etapie projektu może znacznie ograniczyć liczbę konwersji i transformacji potrzebnych w późniejszych etapach.

JSON, YAML, TOML i XML to cztery dominujące tekstowe formaty serializacji w tworzeniu oprogramowania. Każdy z nich ma mocne strony, które czynią go najlepszym wyborem w określonych kontekstach — zrozumienie tych kompromisów pozwala wybrać właściwy format do każdego zadania. W praktyce większość systemów produkcyjnych obsługuje co najmniej dwa z tych formatów jednocześnie, dlatego znajomość narzędzi do konwersji między nimi jest niezbędna.

JSON i YAML obok siebie

JSON i YAML reprezentują ten sam model danych. YAML jest ścisłym nadzbiorem JSON — każdy prawidłowy dokument JSON jest również prawidłowym dokumentem YAML. Poniżej ta sama konfiguracja wyrażona w obu formatach:

{
  "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 używa wcięć zamiast nawiasów klamrowych i kwadratowych, a w przypadku większości wartości tekstowych pomija cudzysłowy. Sprawia to, że jest bardziej zwarty i czytelny dla plików edytowanych ręcznie, ale wprowadza wrażliwość na wcięcia. Dla dużych plików konfiguracyjnych różnica w czytelności jest szczególnie odczuwalna — YAML pozwala uniknąć nadmiernego zagnieżdżenia nawiasów, które utrudnia orientację w strukturze dokumentu.

Porównanie formatów

Pułapki YAML

YAML jest potężny, ale ma dobrze znane przypadki brzegowe, które zaskakują programistów. Oto najczęstsze z nich. Wiele z tych pułapek nie powoduje błędu parsowania — parser odczyta plik pomyślnie, ale dane będą miały inny typ lub wartość niż zamierzano, co prowadzi do trudnych do wykrycia błędów.

Funkcje unikalne dla YAML

Komentarze

YAML obsługuje komentarze za pomocą znaku #. To jedna z największych praktycznych zalet nad JSON w przypadku plików konfiguracyjnych — możesz dokumentować ustawienia bezpośrednio w pliku. Komentarze mogą pojawiać się w osobnej linii lub po wartości. W dużych zespołach komentarze inline są szczególnie cenne: pozwalają wyjaśnić powód danego ustawienia i wskazać dokumentację zewnętrzną bez konieczności sięgania po oddzielną wikię czy plik README.

Kotwice i aliasy

YAML pozwala zdefiniować węzeł raz za pomocą &nazwa-kotwicy i użyć go w dowolnym miejscu za pomocą *nazwa-kotwicy. Eliminuje to powtórzenia w złożonych konfiguracjach. Kubernetes i Docker Compose szeroko używają kotwic do wspólnych definicji usług. Dzięki temu mechanizmowi zmiana jednej wartości w definicji bazowej automatycznie propaguje się do wszystkich miejsc, które odwołują się do tej kotwicy, co znacznie zmniejsza ryzyko niespójności konfiguracji.

Ciągi wieloliniowe

YAML obsługuje skalary blokowe w dwóch trybach: blok literalny (|) zachowuje znaki nowej linii dokładnie tak, jak zostały wpisane — przydatny do skryptów i szablonów. Blok składany (>) zawija długie ciągi w jedną linię — przydatny do długich opisów prozą. Oba tryby obsługują także modyfikatory zachowania końcowego znaku nowej linii: domyślnie (bez modyfikatora) zachowywany jest jeden znak nowej linii na końcu, |- i >- usuwają go całkowicie, a |+ i >+ zachowują wszystkie końcowe znaki nowej linii.

Kiedy potrzebujesz konwersji

Często zadawane pytania