YAML語法格式

聲明：所有資料都來源于網絡上。

字典：

鍵值對 key-value 

示例： my_name: jackson

提示：以#開頭的內容表示注釋，以":"為結束符的字符串，代表了一個key鍵名，":"后面則是鍵值。“：”和value鍵值之間至少有一個空格。

YAML 入門 

QeePHP 為了方便開發者，大量使用了 YAML 格式的文件來存儲配置信息。因此掌握閱讀和書寫 YAML 格式文檔的基本知識是很有必要的。 

YAML 格式本身具有非常強大的表達能力，常用的有下面幾種： 

（1）名值對，例如 key => value，這和 PHP 中以字符串做鍵名的數組一樣； 

（2）列表，例如 value1, value2，這和 PHP 中以數字做鍵名的數組一樣； 

（3）多行文本。

1、 名值對 

（1）最簡單的名值對： 

# 這是一行注釋 

my_name: rockwell # 這也是注釋 以 # 開頭的內容則是注釋。  

以“:”為結束符的字符串，代表了一個鍵名，“:”后面則是鍵值。“:”和鍵值之間必須有至少一個空格。  

因此，上述內容 my_name 是鍵名，rockwell 是鍵值

（2）嵌套的名值對： 

#### 首頁顯示設置 homepage: 

      # 首頁內容緩存時間（秒）       cached_lifetime: 300 

      # 首頁上顯示多少條最新主題文章       topics_num: 2 

      # 首頁上顯示多少條最新社區活動       activities_num: 3 

cached_lifetime 等鍵是 homepage 鍵的次級，所以 cached_lifetime 前面有兩個空格作為縮進。使用兩個空格作為一級縮進是 YAML 的約定，不能使用制表符（Tab）來代替，務必注意這一點。 

在書寫名值對時，如果鍵名或鍵值包含非英文字母和數字，應該用引號括起來： '標題': '這是我的第一本雜志' 

這里我們使用了單引號。而雙引號和單引號的區別： '鍵名1': '文字\n文字' '鍵名2': "文字\n文字" 

使用雙引號括起來的字符串中的 \n 符號會被解析為換行符，而單引號中的 \n 符號則仍然視為兩個普通字符。  

2、 列表 

（1）簡單的列表：

-  value1 

-  value2

-  value3 

另一種寫法： 

- [value1, value2, value3] 

注意第二種寫法前面的“-”必不可少，并且要跟隨至少一個空格。

（2）名值對和列表的混用： 

名值對和列表混用是很常見的寫法，參考： # 后臺管理菜單標簽 admin_tabs:   '首頁':     - 

      title: '主題文章' 

      udi: 'admin::topics/index'     - 

      title: '社區活動' 

      udi: 'admin::activities/index'   

  '項目':     - 

      title: '項目管理' 

      udi: 'admin::projects/index'   

  '應用':     - 

      title: '應用展示管理'       udi: 'admin::cases/index' 

這個實例不但有名值對，而且有列表。所有第一個非空字符是“-”的行都代表一個列表的開始，并且后續縮進行的內容作為列表內容。: 另一個例子： username:   _ui: textbox   _validations: 

    - [is_alpha, '用戶名只能是字母組成'] 

- [min_length, 5, '用戶名最少需要 5 個字符']  

3、 多行文本 

多行文本適合在 yaml 文件中存儲一些說明文字： '簡介': > 

  快速入門教程幫助開發者了解 QeePHP 的開發模式和基本步驟，而權威指南則是開發 QeePHP 應用程序時的全面參考。 

  QeePHP 所有功能的使用方法、使用時機，以及該功能的使用技巧等內容，都會在權威指南中詳細闡述。

 權威指南按照不同的主題分為了數十篇文章。每篇文章圍繞各自的中心編寫內容，讀者可以直接選擇有針對性的文章查看。 

鍵名后面跟上“>”符號表示多行文本的開始。接下來每一個縮進的行都會被視為多行文本的一部分。 例如： text: > 

 Sammy Sosa completed another  fine season with great stats.   

   63 Home Runs 

   0.288 Batting Average   

 What a year! 

如果要結束一個多行文本，后續的內容只需要減少縮進即可，例如： settings:   text: > 

   Sammy Sosa completed another    fine season with great stats.   

     63 Home Runs 

     0.288 Batting Average   

   What a year!   

  title: first post  

書寫 YAML 文檔規范  

在書寫 YAML 文檔時，最重要的就是注意縮進。YAML 格式要求每一級縮進必須是兩個空格，不能是制表字符，也不能是更多的空格。此外對于包含空格、特殊符號或漢字的鍵名和鍵值，應該使用英文引號括起來。 

總結而言，書寫 YAML 文檔的要點如下： 

（1）注意縮進：縮進只能是兩個空格為一級，不能是其他字符。

（2）字符串應該用引號：包含空格、特殊字符以及中文的字符串應該使用英文引號括起來，不能使用中文引號。 

（3）多層嵌套要注意縮進：多層嵌套時，要注意正確的縮進。 YAML 是一種使用很方便的格式。用于存儲一般的配置，YAML 有著 XML 和 PHP 數組無法比擬的優點。加上 QeePHP 對 YAML 的緩存能力，性能也不會是問題。