YAMLフロースタイル vs ブロックスタイル：使い分け

YAMLフロースタイル vs ブロックスタイル

YAMLはデータ構造を表現する2つの基本的な表記法をサポートしています：ブロックスタイル（インデントベース）とフロースタイル（インライン、JSONのような形式）。両方を理解することはYAMLを効果的に読み書きするために不可欠です。

ブロックスタイル

ブロックスタイルはインデントを使用して構造を表現します：

database:
  host: localhost
  port: 5432
  credentials:
    username: admin
    password: secret
  options:
    - ssl
    - compression

これは最も一般的なYAMLスタイルで、可読性から設定ファイルに推奨されています。

フロースタイル

フロースタイルはマッピングに中括弧、シーケンスに角括弧を使用します：

database: {host: localhost, port: 5432, credentials: {username: admin, password: secret}, options: [ssl, compression]}

フロースタイルはコンパクトですが、複雑なネスト構造では読みにくくなります。

スタイルの混合

YAMLは同じドキュメント内でフローとブロックスタイルの混合を許可します：

servers:
  - name: web-1
    tags: [production, frontend]
    config: {memory: 4096, cpu: 2}
  - name: web-2
    tags: [production, backend]
    config: {memory: 8192, cpu: 4}

このハイブリッドアプローチは一般的で慣用的です — 短くシンプルなコレクションにはフロースタイル、複雑な構造にはブロックスタイルを使用します。

フロースタイルを使用すべき場合

• 短いリスト — tags: [web, api, v2]
• シンプルなキーバリューペア — limits: {cpu: "500m", memory: "128Mi"}
• 1行での可読性 — コレクション全体が折り返しなしで1行に収まる場合
• ブロックコンテキストへの埋め込み — ブロックスタイルドキュメント内のフローコレクション

ブロックスタイルを使用すべき場合

• 複雑なネスト構造 — 1レベルより深いもの
• 長い値 — 値が行の折り返しを引き起こす場合
• 設定ファイル — ブロックスタイルが設定ファイルの慣例
• 手動編集されるドキュメント — ブロックスタイルの方が修正しやすい

フォーマッターオプション

ほとんどのYAMLフォーマッターはフロー vs ブロックスタイルを制御するオプションを提供します：

• 常にブロック — すべてのフローコレクションをブロックスタイルに変換
• 常にフロー — すべてのブロックコレクションをフロースタイルに変換（圧縮）
• 保持 — 作者のオリジナルの選択を保持
• スマート — 短いコレクションにはフロースタイル、複雑なものにはブロックスタイルを使用