YAML初心者のための一番わかりやすい解説！あなたもすぐに理解できるYAMLの基本とは？

21 October, 2023

YAMLとは何か？

YAML、その名前は"YAML Ain't Markup Language"という再帰的アクロニムで、その英語の直訳によると「YAML はマークアップ言語ではない」となります。このフレーズからでもわかるように、YAMLは従来のマークアップ言語とは一線を画した存在といえるでしょう。では、具体的にYAMLがどのようなものか、その特性を見ていきましょう。YAMLはデータ序列化のためのフォーマットであり、構造化されたデータを表現するために使用されます。ASCIIテキストをベースにしていて、インデント（字下げ）により階層構造を表現します。そのため人間にとって読み書きが非常に容易であり、さらにコンピュータが解析しやすいという特徴を持つ言語です。例えば、マークアップ言語の一つであるXMLと比較した場合、同じ内容のデータを表現するには、YAMLでは少ない行数で簡潔に記述することが可能です。また、その文法はJSONと互換性があり、JSON形式のデータをYAML形式で記述することも可能です。プログラミングにおいて、YAMLは設定ファイルやデータファイルの記述、メッセージの伝送など、パフォーマンスよりも人間が扱いやすさを優先する場合に使われます。例えば、Kubernetesというオープンソースのコンテナオーケストレーションシステムでは、YAMLがシステム設定の記述に用いられています。しかし、YAMLが万能なわけではありません。YAMLの特性上、大量のデータを扱ったり、パフォーマンスが重要な場合などは、YAMLよりもバイナリ系の言語やJSONなどを選ぶ方が良いでしょう。このように、それぞれの言語やフォーマットには得意とする領域があり、それぞれのサイトエーションに最適なツールを選ぶことが大切です。これからYAMLの詳細な記述方法や具体的な使用例について解説していきますので、ぜひ一緒に学んでみてください。

YAMLの基本構造

それでは実際にYAMLの基本構造について詳しく見ていきましょう。 YAMLの基本構造は「Key: Value」の形式で、この一組を一つのデータとして表現します。たとえば、"name: YAML"と書けば、"name"というキーに"YAML"という値が関連付けられたことになります。この他にもYAMLはインデントを利用して表現力を増やしています。インデントを用いることで、配列やオブジェクトの記述が可能です。ここで注意したいのは、インデントにはスペースを使用し、タブは使用しないという点です。これはYAMLが使用にあたり明確に規定しているため、覚えておいていただきたいポイントです。配列はハイフンを使って表現します。例えば、複数のフルーツを配列として表現したい時は次のようになります。

fruits:
  - apple
  - banana
  - cherry

これは "fruits" というキーに "apple", "banana", "cherry" という3つの値が配列として関連付けられているのがわかるでしょう。次にオブジェクトです。オブジェクトはインデントで表現します。例えば、"person"という名前のオブジェクトを表現したい時は次のように書きます。

person:
  name: John
  age: 30

これは "person" というキーに "name" および "age" という2つのプロパティが含まれるオブジェクトが関連付けられています。詳細に見ると、"name" は "John", "age" は 30 という値をそれぞれ持っています。ここでもしっかりインデントを用いて構造を作っていることがわかります。先ほどとは異なり、オブジェクトにはハイフンは必要ありません。このようにYAMLではキーと値、配列、オブジェクトという3つの要素でほとんどのデータを表現することが可能です。そして全てはインデントを用いて適切に階層構造を形成することで実現されます。忘れずにインデントにはスペースを使用することを思い出してください。以上がYAMLの基本構造となります。この基本形を通じて、より具体的な記述方法や使用例につなげていきましょう。

YAMLの役割と重要性

YAMLの役割と重要性について理解するためには、まずYAMLが何を目的として作られたのか、その背景を捉えることが必要です。YAMLは "YAML Ain't Markup Language" の略で、すなわち「マークアップ言語ではないYAML」という自己参照的な意味を持つアクロニムです。この名前にはYAMLの開発者たちが目指した思想が反映されており、それは「人間が理解しやすいデータ表現形式を提供すること」です。 YAMLの役割とは、つまりデータを表現し、そのデータを人間が理解しやすい形で交換や保存を可能にすることです。この目的により、YAMLは、設定ファイル、データ交換、メッセージ文書化などの領域で広く使用されています。そのシンプルな構文と人間が読み書きしやすい特性により、YAMLは最も友好的なデータ表現言語の一つとなるのです。この役割と目的は、YAMLの重要性につながります。その可読性と使いやすさにより、YAMLはJSONやXMLといった他のデータ表現形式に対する重要な代替手段となっています。特に、YAMLはDevOps文化の中心となるべくクラウドネイティブ技術、例えばKubernetesやAnsibleなどで幅広く採用されています。またYAMLの価値は、詳細なデータ構造と複雑な階層構造を持つデータも、簡潔で理解しやすい形で表現できるという点にもあります。これにより、開発者やシステム管理者は大規模なシステム設定や膨大なデータ管理タスクを、直感的且つ効率的に実施することが可能になり、プロジェクト全体の生産性と効率性の向上に貢献しています。以上の観点からみると、YAMLの役割と重要性は明らかです。その可読性、書きやすさ、そして複雑なデータを直感的に扱う能力により、YAMLは現代のIT業界で幅広く愛用され、その地位を確立しています。また、これらの特性により、YAMLの学習と理解は、IT技術者にとって避けて通れないスキルセットとも言えます。

YAMLの基本的な書き方

それでは、具体的にYAMLの基本的な書き方について解説していきましょう。YAMLが有用なのはその構文が人間にとって直観的に理解しやすいからですが、それが実現されるのは特有の書き方によるところが大きいです。一般的なプログラミング言語と異なり、YAMLではデータ構造を表すためにインデント（字下げ）を活用します。最もシンプルなYAMLの用途の一つはキーと値のペアを表すことです。それは一種の名前とそれに関連する情報を対の形で表現する方法で、以下のように書けます。

Name: John Doe
Age: 25
Country: Japan

ここでは`Name`、`Age`、`Country`がキー、それに続く`John Doe`、`25`、`Japan`が値です。キーと値はコロン(:)で区切られ、一行に一つのペアが表現されます。次に、リスト（配列）の表現について見ていきましょう。リストは一連の値を表し、それぞれの値はハイフン(-)から始まります。例えば、購入する食料品のリストは以下のようになります。

- Milk
- Bread
- Apples

YAMLでは、これらの単純なデータ構造を組み合わせることで、より複雑なデータ表現が可能となります。例えば、様々な人物の情報をまとめたリストは以下のように書けます。

- Name: John Doe
  Age: 25
  Country: Japan
- Name: Jane Smith
  Age: 30
  Country: USA

このリストでは各人物の情報がキーと値のペアとして表現され、それぞれのペアがインデントを用いて整形されています。リストの各要素はハイフンで示され、その下にあるキーと値のペアはその要素に属すると解釈されます。このように、YAMLではインデントを用いてデータの階層構造を表現します。以上が、YAMLの基本的な書き方となります。YAMLはその直感的な構文により、データの視覚的な理解を容易にします。しかし、この可読性は正確なインデントに依存しているため、インデントを適切に行うことが重要です。特にタブとスペースの混在はトラブルのもとなので、一貫したインデントを確保するようにしましょう。

YAMLで使用する主要な構文とその解説

それでは、YAMLで使用する主要な構文をいくつかピックアップし、具体的な解説を行います。これらの構文を理解し、使いこなすことで、より深くYAMLを利用する道が開けます。 1. マルチライン文字列： YAMLでは長い文字列を複数行にわたって記述することも可能です。それがマルチライン文字列の表現です。マルチライン文字列は`|`や`>`を使用して表現します。これらの記号の後に続く複数行のテキストは一つの長い文字列として解釈されます。具体的には次のように記述します。

Description: >
  This is a very long
  description that spans
  multiple lines.

上記の場合、`Description`の値は`"This is a very long description that spans multiple lines."`という一つの文字列になります。 2. コメント： YAMLでは`#`記号を使ってコメントを記述することができます。`#`以降の文字はYAMLパーサによって無視され、人間が読むための参考情報として扱われます。

# This is a comment
Name: John Doe  # This is also a comment

3. エイリアスとマージ： YAMLでは`&`記号と`*`記号を使用してエイリアスを表現し、データ構造を一度定義して再利用することができます。また、`<<`を使用してマッピング（キーと値のペア）を他のマッピングにマージすることが可能です。

defaults: &defaults
  Adapter:  postgres
  Host:     localhost

development:
  <<: *defaults
  Database: myapp_development

上記の例では、`defaults`という名前のエイリアスを作り、そのエイリアスを`development`の設定にマージしています。その結果、`development`の設定は`Adapter`、`Host`、`Database`の3つのキーを持つことになります。以上が、YAMLの主要な構文とその解説です。これらの知識を活かし、YAMLファイルをより効果的に読み書きできるようになることでしょう。

YAMLを用いた具体的な使用例

それでは、さっそくYAMLを使用した具体的な使用例を見ていきましょう。本節では、複雑な設定ファイルをYAMLでどのように表現できるかを学びます。具体的にはDockerを使用したマイクロサービス環境の設定ファイルの例を挙げます。Docker Composeは、複数のDockerコンテナ間の関係をYAML形式で表現します。

version: '3.1'
services:
  db:
    image: postgres
    restart: always
    environment:
      POSTGRES_PASSWORD: example
  web:
    image: nginx
    ports:
      - "80:80"
    links:
      - db

このコードが示すのは、2つのサービス（＝Dockerコンテナ）`db`と`web`を定義している点です。`db`サービスはポストグレス（Postgres）のDockerイメージを利用し、環境変数としてデータベースのパスワードを設定しています。一方、`web`サービスはnginxのDockerイメージを利用し、親ホストの80番ポートとDockerコンテナ内の80番ポートをマッピングしています。そして`db`サービスにリンクしているため、`web`サービスからは`db`サービスをネットワーク経由で利用することが可能です。このYAMLファイル一つで、マイクロサービス間の関係性や環境変数の設定、ポートのマッピングなど、複雑な設定情報を一元的に管理できるというメリットがあります。そしてYAMLの特徴である読みやすさと書きやすさにより、設定内容が直感的に理解でき、また人間が直接編集することも容易です。 YAMLの強力な表現力をより具体的なコードで体験したことで、YAMLがどのようにデータを扱い、どのように構造化するかがより具体的に理解できたのではないでしょうか。次節からは更に専門的な知識について学んでいきますので、ぜひ引き続き学習を進めてください。

YAMLの応用と専門的な知識

それでは、YAMLの応用と専門的な知識について詳しく見ていきましょう。この節では、YAMLをより広範囲で利用するための知識と、専門的な情報を提供します。まず、YAMLの応用知識として、データの複製を簡素化するための"Anchor"と"Alias"の概念を紹介します。Anchor(`&`)はYAMLのある部分で定義を宣言し、Alias(`*`)を使用してその部分を再利用できます。これにより、同じ設定が複数箇所に必要な場合でも、YAMLファイルの冗長性を大幅に減らすことが可能になります。以下に具体的な例を示します。

defaults: &defaults
  adapter: postgres
  host: localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults

この例では、最初にデータベースのデフォルト設定(`defaults`)を定義(`&defaults`)しています。そして、開発環境(`development`)とテスト環境(`test`)の設定でそのデフォルト設定を再利用(`<<: *defaults`)しています。これにより、設定の共通部分を一度だけ記述し、各環境で再利用することができます。次に、専門的な知識として、"Tagging"について触れます。YAMLではデータの型を自動で推論しますが、どのように解釈するべきか具体的に指定したい場合に、タグ(`!!`)を利用します。例えば、数値を文字列として扱いたい場合、以下のように記述します。

age: !!str 25

この例では、数値として解釈される可能性のある`25`を、明示的に文字列(`!!str`)として扱うよう‖指定しています。このような応用的な知識や専門的な知識を理解し、活用することで、YAMLをより効率的かつ確実に操作することが可能となります。次の節では、YAMLのトラブルシューティング方法とその解決策について学んでいきましょう。

YAMLに関するトラブルシューティングとその解決策

YAMLの使用中には様々なトラブルが生じる可能性があります。それらに対する一般的なトラブルシューティングのアプローチと、具体的な解決策について説明します。第一のトラブルポイントは、構文エラーです。YAMLはインデントによるブロック構造が特徴的で、その厳密さがエラーの一因となります。具体的には、余計なスペースやタブ、開放されたリストやキーなどが存在していないかチェックします。また、文字列内に特殊文字を含む場合は、適切にクオート('か")で括る必要があります。第二のトラブルポイントは、データ構造の問題です。YAMLでは重複したキーや不適切なデータ型が許可されていません。加えて、解析に成功したとしても、意図した通りのデータ構造になっているか否かを確認することが重要です。具体的には、リストの項目が想定通りの数であるか、連想配列のキーが重複していないか、データ型が意図したものになっているか等をチェックします。以上の問題を迅速に発見するための方法として、YAML Linterやバリデータを活用します。これらはYAMLファイルを構文解析し、文法エラーや矛盾点を指摘してくれます。例えば、YAMLLint、YAML Validator、Online YAML Parserなどが一般的に利用されています。また、プログラム上でYAMLを操作する際にエラーが生じた場合、先述した方法で問題を特定できない場合は、ライブラリのAPIドキュメントを確認する、フォーラムやStack Overflowで情報を検索するといった方法を取りましょう。具体的なエラーメッセージや状況に応じた解答が得られる可能性があります。トラブルシューティングはすぐ解決できない場合もありますが、構文チェックから始め、エラーメッセージをよく読むことで、問題が解決へと進むことでしょう。YAMLを理解し、正確に操作する能力と一緒に、トラブルシューティングのスキルも育てていきましょう。

まとめ

本記事では、YAMLの基本構造からその役割、基本的な書き方、主要な構文とその解説、具体的な使用例、応用と専門的な知識、最後にトラブルシューティングとその解決策までを解説しました。今までYAMLを学びたいと思っていたけど何から始めてよいか分からないという方、また既に一部経験はあるけどもっと深く専門的な知識を得たいという方へ向けて情報を整理し提供していきました。 YAMLはその人間が読みやすい構造から、設定ファイルやデータ序列化、プログラム言語間のデータ交換などに幅広く使用されています。しかし同時に、その人間が読みやすいという特性から厳密さを犠牲にしやすいという一面も持っており、そのコントロールには注意が必要であるということを本記事で学んだことでしょう。また、積極的にYAML Linterやバリデータの活用の仕方についても触れました。これらのツールは文字列の括り忘れ、余計なインデントといったシンタックスエラーや、重複したキー名、不適切なデータ型などを発見することができます。それにより、人間が見落とす可能性のあるエラーを短時間で見つけることができます。一方で、万が一エラーが起きたときには、コードやエラーメッセージをよく読むことで原因を究明する手がかりになります。そうした場合や、想定外の挙動があった場合には、公式のAPIドキュメントを読み返す、オンラインフォーラムやStack Overflowなどで情報を収集する等々の方法も有効であることも覚えておくと良いでしょう。以上の内容を通じて、YAMLの基本から応用、トラブルシューティングまでの一連の流れを理解できたことと思います。これを機にYAMLへの理解を深めてみてください。そして、その計り知れない可能性を、ぜひあなたのITにおける課題解決の一助にしてみてください。