Nom complet de YAMLYAML Ain't Markup Language(un acronyme récursif), est un format de sérialisation de données lisible par l'humain.

YAML est souvent utilisé pour les fichiers de configuration, l'échange de données et divers scénarios où les données doivent être stockées de manière structurée.

La syntaxe de YAML est similaire à celle d'autres langages de haut niveau et peut facilement exprimer des listes, des tables de hachage, des scalaires et d'autres formes de données.

Il utilise l'indentation par espaces et repose fortement sur l'apparence, ce qui le rend particulièrement adapté à l'expression ou à l'édition de structures de données, de divers fichiers de configuration, au vidage de contenu de débogage et aux plans de fichiers.

L'extension de fichier des fichiers de configuration YAML est.yml, par exemple :example.yml 。

Fonctionnalités et avantages de YAML

Les objectifs de conception de YAML incluent une grande lisibilité, une syntaxe concise, proche des habitudes d'écriture en langage naturel, et un besoin presque nul de symboles supplémentaires.

Par rapport à XML et JSON, YAML réduit beaucoup de crochets et de guillemets, ce qui facilite l'écriture.

Il prend en charge des structures de données complexes, peut exprimer des listes, des dictionnaires, des structures imbriquées, et prend même en charge des fonctionnalités avancées comme les références et les ancres.

Presque tous les langages de programmation courants disposent de bibliothèques pour analyser du YAML, et l'écosystème est très mature.

Comparaison de YAML avec JSON et XML

Les trois formats ont leurs propres spécificités ; le tableau ci-dessous les compare selon plusieurs dimensions :

FonctionnalitéYAMLJSONXML
LisibilitéÉlevéeMoyenneFaible
Prise en charge des commentairesPris en chargeNon pris en chargePris en charge
Complexité syntaxiqueFaibleMoyenneÉlevée
Utilisations courantesFichiers de configurationÉchange de données / APIDocument / Échange de données

Cas d'utilisation courants de YAML

YAML est presque omniprésent dans la pile de développement moderne ; voici les scénarios les plus courants :

Fichiers de configuration d'application, tels que leapplication.yml de Spring Boot。

Outils d'orchestration de conteneurs, tels que les fichiers de description de déploiement pour Docker Compose et Kubernetes.

Configuration de pipeline CI/CD, telle que les définitions de workflow pour GitHub Actions, GitLab CI et CircleCI.

Front Matter pour les générateurs de sites statiques, tels que les métadonnées de page pour Jekyll et Hugo.


Règles de syntaxe de base

Maîtrisez les règles d'écriture les plus élémentaires de YAML, y compris l'indentation, les commentaires, la structure du fichier, etc.

Règles d'indentation

YAML utilisedes espacespour l'indentation afin de représenter la hiérarchie,il ne faut pas utiliser la touche Tab。

Les éléments au même niveau doivent conserver la même quantité d'indentation ; il est généralement recommandé d'utiliser 2 espaces comme unité d'indentation.

person:
  name: 张三
  age: 25

Syntaxe de base

Voici les règles de syntaxe fondamentales de YAML que vous devez retenir :

  • Sensible à la casse
  • Utilisez l'indentation pour représenter la hiérarchie
  • L'indentation n'autorise pas les tabulations, uniquement les espaces
  • Le nombre d'espaces pour l'indentation n'a pas d'importance, tant que les éléments au même niveau sont alignés à gauche
  • #Indique un commentaire
  • :Un espace doit être ajouté après le symbole

Sensibilité à la casse

Les noms de clés, les chaînes, etc. dans YAML sont sensibles à la casse.

Nameetnameseront traités comme deux clés différentes ; vous devez faire attention à la cohérence lors de l'écriture.

Syntaxe des commentaires

Utilisez#Le contenu au début est un commentaire ; les commentaires peuvent occuper toute une ligne ou être placés après le contenu.

# 这是一行注释
name: 张三  # 这也是注释

Extensions de fichier

Les fichiers YAML utilisent généralement.yamlou.ymlcomme extension ; il n'y a pas de différence essentielle entre les deux, selon les conventions du projet.

Séparateurs de documents

---Utilisé pour marquer le début d'un nouveau document, particulièrement important dans les fichiers multi-documents.

...Utilisé pour marquer la fin d'un document, et est un marqueur facultatif.

---
doc: 第一个文档
---
doc: 第二个文档

Types de données de base

YAML prend en charge les types de données de base tels que les chaînes de caractères, les nombres, les booléens et les valeurs null ; chaque type a un style d'écriture spécifique.

Aperçu des types de données

YAML prend en charge les types de données suivants :

  • Objets : une collection de paires clé-valeur, également appelée mapping / hashes / dictionnaire
  • Tableaux : un ensemble de valeurs disposées dans l'ordre, également appelé séquence / liste
  • Scalaires : valeurs uniques et indivisibles

Scalaire

Les scalaires sont les unités de données les plus élémentaires en YAML et se divisent en les types suivants :

Chaînes de caractères

Les chaînes de caractères peuvent être écrites sans guillemets, ou entourées de guillemets doubles ou de guillemets simples.

Les guillemets doubles prennent en charge les caractères d’échappement (comme\n), tandis que les guillemets simples ne prennent pas en charge l’échappement.

name: 张三          # 不加引号
name: "张三"        # 双引号,支持转义字符
name: '张三'        # 单引号,不支持转义

Nombres

YAML reconnaît automatiquement les entiers et les nombres à virgule flottante, sans qu’il soit nécessaire de déclarer les types.

age: 25          # 整数
price: 19.99     # 浮点数

Booléens

Les booléens utilisenttrueetfalsepour les représenter.

is_active: true
is_deleted: false

Null

Null peut être représenté parnull、~ou en n’écrivant rien pour l’indiquer.

value: null
value: ~
value:            # 什么都不写也表示 null

Exemple complet de scalaires

L’exemple suivant montre comment utiliser tous les types scalaires, y compris les booléens, les nombres à virgule flottante, les entiers, null, les chaînes de caractères, les dates et les heures :

boolean:
    - TRUE  # true,True 都可以
    - FALSE  # false,False 都可以
float:
    - 3.14
    - 6.8523015e+5  # 可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    # 二进制表示
null:
    nodeName: 'node'
    parent: ~  # 使用 ~ 表示 null
string:
    - 哈哈
    - 'Hello world'  # 可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    # 字符串可以拆成多行,每一行会被转化成一个空格
date:
    - 2018-02-17    # 日期必须使用 ISO 8601 格式,即 yyyy-MM-dd
datetime:
    - 2018-02-17T15:02:31+08:00    # 时间使用 ISO 8601 格式,时间和日期之间使用 T 连接,最后使用 + 代表时区

Les dates et heures doivent utiliser le format ISO 8601. Le format de date estyyyy-MM-dd, le format d’heure estyyyy-MM-ddTHH:mm:ss+timezone, au milieuTpour les relier.

Chaînes multilignes

YAML propose deux façons d’écrire des chaînes multilignes, chacune adaptée à différents scénarios.

Style replié (>)

Utilisez le>symbole pour replier un texte multiligne sur une seule ligne ; les caractères de nouvelle ligne sont remplacés par des espaces.

description: >
  这是第一行
  这是第二行
  这是第三行

L'écriture ci-dessus équivaut à :"This is the first line This is the second line This is the third line\n"

Style littéral (|)

L'utilisation du symbole|préserve les sauts de ligne d'origine, adaptée pour écrire du texte multiligne (comme le contenu d'un script).

script: |
  echo "第一行"
  echo "第二行"
  echo "第三行"

Comparaison de | et >

Ci-dessous, en utilisant le même contenuFoo\nBarpour comparer les différences entre les deux styles :

this: |
  Foo
  Bar
that: >
  Foo
  Bar

Converti en code JavaScript comme suit :

{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }

On peut voir que|préserve les sauts de ligne, ce qui donneFoo\nBar\n; tandis que>fusionne les sauts de ligne en espaces, ce qui donneFoo Bar\n。

Choisir>ou|dépend de vos besoins : si vous devez combiner un contenu multiligne en un seul paragraphe, utilisez>; si vous devez préserver le format de saut de ligne d'origine (comme les scripts, la poésie), utilisez|。


Structures de données composites

YAML prend en charge deux structures composites : les mappages et les séquences. Elles peuvent être imbriquées librement pour exprimer des relations de données arbitrairement complexes.

Mappage / Dictionnaire

Un mappage est une collection de paires clé-valeur et est la structure de données la plus couramment utilisée dans YAML.

Syntaxe de base des paires clé-valeur

name: 张三
age: 25
city: 北京

Mappage imbriqué

Grâce à l'indentation, vous pouvez imbriquer un autre mappage dans un mappage, formant ainsi une structure hiérarchique.

person:
  name: 张三
  address:
    city: 北京
    zipcode: "100000"

Syntaxe de mappage en style flux

Vous pouvez également utiliser la syntaxe de style fluxkey:{key1: value1, key2: value2, ...}.

key: {child-key: value, child-key2: value2}

Clé complexe

Utilisez un point d'interrogation suivi d'un espace pour représenter une clé complexe, associé à un deux-points et un espace pour représenter une valeur :

?
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

Cela signifie que la propriété de l'objet est un tableau[complexkey1, complexkey2], et que la valeur correspondante est également un tableau[complexvalue1, complexvalue2]。

Séquence / Liste

notation préfixe-pour stocker des collections de données ordonnées.

Syntaxe de base des listes

fruits:
  - 苹果
  - 香蕉
  - 橙子

Listes imbriquées

matrix:
  - [1, 2, 3]
  - [4, 5, 6]
  - [7, 8, 9]

Tableaux multidimensionnels

YAML prend en charge les tableaux multidimensionnels, qui peuvent être représentés en ligne :

key: [value1, value2, ...]

Lorsqu'un sous-membre de la structure de données est un tableau, vous pouvez indenter d'un espace sous cet élément :

-
 - A
 - B
 - C

Exemple complexe avec des éléments de tableau qui sont des objets

Un scénario courant dans le monde réel : chaque élément du tableau est un objet composé de plusieurs propriétés :

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

Cela signifiecompaniesla propriété est un tableau, et chaque élément du tableau est composé deid、name、pricetrois propriétés.

Les tableaux peuvent aussi être représentés en style flow :

companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

Mélanger les mappings et les séquences

Les mappings et les séquences peuvent être combinés de manière flexible pour exprimer des structures de données complexes.

students:
  - name: 张三
    age: 20
    subjects:
      - 数学
      - 英语
  - name: 李四
    age: 22
    subjects:
      - 物理
      - 化学

Dans l'exemple ci-dessus,studentsest une séquence, chaque élément est un mapping, et lesubjectsdu mapping est à nouveau une séquence. Ce type de combinaison imbriquée est au cœur de l'expressivité de YAML.

Exemple de structure composite

Les tableaux et les objets peuvent former des structures composites. Voici un exemple qui contient à la fois une liste et un mapping :

languages:
  - Ruby
  - Perl
  - Python
websites:
  YAML: yaml.org
  Ruby: ruby-lang.org
  Python: python.org
  Perl: use.perl.org

Après conversion en JSON :

{
  languages: [ 'Ruby', 'Perl', 'Python'],
  websites: {
    YAML: 'yaml.org',
    Ruby: 'ruby-lang.org',
    Python: 'python.org',
    Perl: 'use.perl.org'
  }
}

Syntaxe de flux

En plus de la notation en bloc, YAML prend également en charge la notation de flux de type JSON, adaptée aux scénarios compacts.

Mappage de flux

Utilisez des accolades{}pour entourer les paires clé-valeur, séparées par des virgules.

person: {name: 张三, age: 25, city: 北京}

Séquence de flux

Utilisez des crochets[]pour entourer les éléments, séparés par des virgules.

fruits: [苹果, 香蕉, 橙子]

Comparaison et cas d'utilisation des styles flux et bloc

StyleFonctionnalitésScénarios applicables
BlocMeilleure lisibilité, hiérarchie claireDonnées structurellement complexes avec imbrication profonde
FluxPlus compact, exprimé sur une seule ligneDonnées simples, ou petites données intégrées dans des structures en bloc

Les deux styles peuvent également être mélangés :

users:
  - {name: 张三, age: 25}
  - {name: 李四, age: 30}

Fonctionnalités avancées

YAML fournit des fonctionnalités avancées telles que les ancres, les références et les clés de fusion pour aider à réduire le contenu dupliqué.

Ancres et références

Utilisez&pour définir une ancre, et utilisez*pour référencer l'ancre, en évitant de réécrire le même contenu.

default_settings: &defaults
  adapter: postgres
  host: localhost

development:
  <<: *defaults
  database: dev_db

test:
  <<: *defaults
  database: test_db

Dans l'exemple ci-dessus,&defaultsdéfinit une ancre,*defaultsfait référence au contenu de cette ancre,<<ce qui indique une fusion dans les données actuelles.

La configuration ci-dessus se développe en :

defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

Références d'ancres dans les listes

Les ancres peuvent également être utilisées dans les listes :

- &showell Steve
- Clark
- Brian
- Oren
- *showell

Après conversion en tableau JavaScript :

[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

Clés de fusion

<<Utilisé pour fusionner le contenu d'un mappage dans le mappage actuel, souvent utilisé conjointement avec des ancres.

La clé de fusion<<est une fonctionnalité de la spécification YAML 1.1 et est prise en charge par la plupart des parseurs YAML. Elle peut rendre les fichiers de configuration plus concis, mais notez qu'elle ne fait pas partie de la spécification JSON et sera développée en contenu réel lors de la conversion en JSON.

Prise en charge de plusieurs documents

Dans un fichier YAML, vous pouvez utiliser---pour séparer et stocker plusieurs documents indépendants, couramment rencontrés dans les fichiers de configuration Kubernetes.

---
kind: Pod
metadata:
  name: pod-1
---
kind: Pod
metadata:
  name: pod-2

Balises et conversion de type

YAML prend en charge la spécification explicite des types de données via des balises, en utilisant la déclaration de préfixe!!.

explicit_string: !!str 123
explicit_int: !!int "123"
explicit_float: !!float "3.14"

Les balises courantes incluent!!str(chaîne),!!int(entier),!!float(flottant),!!bool(booléen),!!null(null), etc.


Erreurs courantes et mises en garde

YAML est très sensible au formatage. Voici les types d'erreurs les plus courants et comment les éviter.

Échecs d'analyse causés par des erreurs d'indentation

YAML est extrêmement sensible à l'indentation. L'indentation au même niveau doit être exactement cohérente, sinon cela provoquera des erreurs d'analyse.

# 错误示例:缩进不一致
person:
  name: 张三
   age: 25   # 缩进多了一个空格,会报错

Mélange de tabulations et d'espaces

La spécification YAML indique clairement queles tabulations ne sont pas autorisées pour l'indentation, et que les espaces doivent être utilisés de manière cohérente, sinon la plupart des analyseurs syntaxiques signaleront une erreur.

Il est recommandé d'activer le paramètre « Convert Tab to Spaces » dans l'éditeur afin d'éviter de mélanger accidentellement des caractères de tabulation. La plupart des éditeurs modernes prennent en charge.yamlet.ymlen activant automatiquement ce paramètre pour les fichiers.

Échappement des caractères spéciaux

Lorsqu'une chaîne contient:、#、{、}、[、]et d'autres caractères spéciaux, il est recommandé d'entourer la chaîne de guillemets pour éviter qu'elle soit mal interprétée par l'analyseur.

title: "标题: 副标题"   # 冒号需要用引号包裹
tag: "#重要"           # 井号需要用引号包裹,否则会被当作注释

Quand faut-il mettre les chaînes entre guillemets

Dans les cas suivants, il est recommandé d'ajouter explicitement des guillemets pour éviter une inférence de type incorrecte par l'analyseur YAML :

ScénarioExempleDescription
La chaîne commence par un chiffre"100000"Sans guillemets, elle sera interprétée comme un nombre
Mots booléens facilement confondus"true"、"false"、"yes"、"no"Sans guillemets, elle sera interprétée comme un booléen
Mots null"null"、"~"Sans guillemets, elle sera interprétée comme null
Contient des symboles spéciaux"Titre : Sous-titre"Les deux-points, les dièses, etc. seront considérés à tort comme des marqueurs de syntaxe

Applications pratiques

Comprendre l’utilisation de YAML dans des projets réels à travers des exemples complets dans des scénarios concrets.

Écrire un fichier de configuration simple

Voici un fichier de configuration d’application typique, qui montre la structure courante de YAML dans des projets réels :

# 应用基本配置
app:
  name: MyApplication
  version: 1.0.0
  debug: false

# 数据库连接配置
database:
  host: localhost
  port: 5432
  username: admin
  password: "secret"

# 日志配置
logging:
  level: info
  file: /var/log/app.log

YAML dans Docker Compose

Docker Compose utilise YAML pour définir l’orchestration des services d’applications multi-conteneurs :

version: "3"
services:
  web:
    image: nginx:latest
    ports:
      - "80:80"
  db:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: example

YAML dans Kubernetes

Kubernetes utilise YAML pour définir divers objets de ressources. Voici un exemple de définition de Pod :

apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod
spec:
  containers:
    - name: nginx
      image: nginx:latest
      ports:
        - containerPort: 80

YAML dans GitHub Actions

GitHub Actions utilise YAML pour définir des workflows CI/CD :

name: CI

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run tests
        run: npm test

Outils et validation

Recommandez quelques outils et ressources YAML pratiques pour vous aider à écrire et valider des fichiers YAML plus efficacement.

Validateurs YAML en ligne

YAML Lint est l'outil de validation en ligne le plus couramment utilisé. Vous pouvez rechercher "yamllint online" pour trouver des sites Web de validation en ligne disponibles.

Divers IDE disposent également d'une vérification syntaxique YAML intégrée, fournissant des messages d'erreur en temps réel pendant la rédaction.

Bibliothèques d'analyse YAML pour les langages de programmation courants

LangageBibliothèques courantesFonctionnalités
PythonPyYAML、ruamel.yamlPyYAML est le plus populaire, ruamel.yaml prend en charge YAML 1.2
JavaScript / Node.jsjs-yamlFonctionne à la fois dans les environnements de navigateur et Node.js
JavaSnakeYAMLLa bibliothèque d'analyse YAML utilisée par défaut dans Spring Boot
Gogopkg.in/yaml.v3La bibliothèque YAML la plus couramment utilisée dans l'écosystème Go
RubyPsychIntégré à la bibliothèque standard, aucune installation supplémentaire requise

Plugins d'éditeur recommandés

ÉditeurPlugin recommandéFonctionnalités
VSCodePlugin YAML de Red HatColoration syntaxique, validation de format, validation de schéma
IntelliJ IDEA / PyCharmPrise en charge intégréeAucune installation supplémentaire requise, fonctionne immédiatement
Sublime TextPlugins liés à YAMLAméliore la coloration syntaxique et le formatage