## 什么是 YAML？ YAML（YAML Ain't Markup Language）是一種[數據序列化](https://so.csdn.net/so/search?q=%E6%95%B0%E6%8D%AE%E5%BA%8F%E5%88%97%E5%8C%96&spm=1001.2101.3001.7020)語言，它的設計目標是為了使人類可讀性更高，同時也易于編寫程序進行解析。YAML 的語法簡潔明了，適合用于配置文件、數據交換等方面。 ## Symfony YAML組件 Symfony YAML組件是一個強大的PHP庫，用于處理YAML配置文件。該組件可以輕松地將YAML數據轉換為PHP數組，并且可以方便地對PHP數組進行序列化。 ### 能做什么？ 使用 Symfony Yaml，你可以輕松地將 YAML 數據解析為 PHP 數組，也可以將 PHP 數組轉換為 YAML 字符串。這使得它在以下場景中非常有用。 * **配置文件**：YAML 文件是一種理想的配置文件格式，因為它們既清晰又易于閱讀。 * **數據交換**： 如果你需要與別的系統交換數據，YAML 提供了一種簡潔且易于理解的方式來表示結構化的數據。 * **設置對象屬性**：通過將 YAML 數據映射到 PHP 對象的屬性，可以使對象更容易配置。 ### Symfony Yaml 的特點 * **易用性**：Symfony Yaml 提供了一個簡單直接的 API，使得操作 YAML 數據變得非常容易。 * **靈活性**：Symfony Yaml 支持多種不同的 YAML 樣式和特性，包括錨點、別名、標簽等。 * **強大性**：Symfony Yaml 具有強大的錯誤處理能力，能夠捕獲并報告各種類型的解析錯誤。 * **兼容性**：Symfony Yaml 可以在 PHP 5.6+ 版本上運行，并且與大部分現代 PHP 框架兼容。 ## 基礎使用 ### 安裝 通過 Composer 來安裝 ```php composer require symfony/yaml ``` **`config.yaml` 配置文件** ``` # Redis配置 redis: master: host: '127.0.0.1' port: 6379 password: '123456' ``` **加載 YAML 文件** ``` <?php /** * @desc 加載 YAML 文件 * @author Tinywan(ShaoBo Wan) * @date 2024/6/15 10:09 */ declare(strict_types=1); require_once '../vendor/autoload.php'; use Symfony\Component\Yaml\Yaml; $yamlContent = Yaml::parseFile('../config.yaml'); var_dump($yamlContent); ``` 打印輸出 ``` array(1) { ["redis"]=> array(1) { ["master"]=> array(3) { ["host"]=> string(10) "127.0.0.1" ["port"]=> int(6379) ["password"]=> string(6) "123456" } } } ``` **解析 YAML 字符串** ``` use Symfony\Component\Yaml\Yaml; $yamlString = 'name: Tinywan'; $parsedData = Yaml::parse($yamlString); var_dump($parsedData); ``` 打印輸出 ``` array(1) { ["name"]=> string(7) "Tinywan" } ``` **將數據轉換為 YAML 并寫入文件** ``` $data = [ 'name' => 'Tinywan', 'age' => 24 ]; $yamlString = Yaml::dump($data, 3, 2); // 第二個參數是縮進級別，第三個參數是換行符數量 $yamlPath = '../tinywan.yaml'; file_put_contents(base_path() . $yamlPath, $yamlString, LOCK_EX); ``` 在這里，我們首先使用use導入Symfony YAML組件，然后使用`Yaml::parseFile`方法將`YAML`文件解析為`PHP`數組。接下來，我們使用`Yaml::dump`方法將PHP數組序列化為`YAML`格式。 ## 高級用法 高級用法主要是結合項目框架使用，不忘初衷的`webman`，那就是你了！！！ > 用法：這里嘗試使用`config.yaml`文件替換`config/redis.php` 配置文件，通過修改`config.yaml`文件而變相的修改`config/redis.php` 配置文件。 **`config.yaml`文件內容** ``` # Redis配置 redis: master: host: '127.0.0.1' port: 6379 password: '123456' ``` **`config/redis.php` 配置文件** ``` <?php /** * @desc Redis配置 * @author Tinywan(ShaoBo Wan) * @date 2024/6/15 0:09 */ declare(strict_types=1); return [ 'default' => [ 'host' => yaml('redis.master.host', '127.0.0.1'), 'port' => yaml('redis.master.port', '6379'), 'password' => yaml('redis.master.password', null), 'database' => 0, ], ]; ``` **自定義 yaml() 助手函數** 助手函數位置很重要，該助手函數需要放在`support/helpers.php`文件里，或者在`support`目錄下新建一個自定的函數，如`support/resty.php`，然后需改`composer.json`文件的`autoload`自定加載文件即可 ```json "autoload": { "files": [ "./support/helpers.php", "./support/resty.php" ] } ``` **` yaml() `助手函數文件** ```php /** * @desc 自定義 yaml 助手函數 * @param string|null $key * @param mixed|null $default * @param string|null $path * @param bool $static * @return mixed * @author Tinywan(ShaoBo Wan) */ function yaml(?string $key = null, ?string $default = null, ?string $path = null, bool $static = false) { if (!file_exists(($path = $path ?? base_path() . DIRECTORY_SEPARATOR . 'config.yaml'))) { return $default; } if ($static) { global $yaml; if (!$yaml) { $yaml = \Symfony\Component\Yaml\Yaml::parseFile($path); } $data = $yaml; } else { $data = \Symfony\Component\Yaml\Yaml::parseFile($path); } $keys = \explode('.', $key); if ($key !== null) { foreach ($keys as $k) { if (!is_array($data)) { $data = $default; break; } $data = $data[$k] ?? $default; } } return $data; } ``` > 注意區別：每次安裝`workerman/webman-framework`或者升級`workerman/webman-framework`時會自動覆蓋`start.php` 和 `helpers.php`。所以這里推薦新建一個`support/resty.php`文件。 composer.json里將此文件加入到自動加載中，類似 ``` "files": [ "./support/helpers.php", "./support/resty.php" ] ``` 執行`composer dumpautoload`這樣你的項目就可以在啟動時加載`support/check.php`了。不需要更改·`start.php`和 `helpers.php`啦！！！ **測試校驗** 讀取Redis默認配置文件 ``` $config = \config('redis.default'); var_dump($config); ``` 打印輸出 ``` array(4) { 'host' => string(9) "127.0.0.1" 'port' => int(6379) 'password' => string(6) "123456" 'database' => int(0) } ``` > 嘗試修改`config.yaml` 文件內容 ``` # Redis配置 redis: master: host: 'dnmp-redis' port: 6379 password: '123456' ``` 再次打印輸出，可以看到默認redis配置已經發生變化了，自動從`config.yaml`文件讀取了 ``` array(4) { 'host' => string(10) "dnmp-redis" 'port' => int(6379) 'password' => string(6) "123456" 'database' => int(0) } ```