在 PHP 中使用 YAML：Symfony Yaml 库

YAML（YAML Ain't Markup Language）是一种数据序列化格式，常用于配置文件、数据结构描述以及服务间的信息交换。在 PHP 中，有多个解决方案可用于处理 YAML，但最流行且功能最强大的是 Symfony Yaml 组件。它提供了便捷的方法来解析（读取）和转储（写入）YAML 数据，支持所有 YAML 1.2 规范，并内置于许多框架中，包括 Laravel 和 Symfony。

在本文中，我们将详细介绍 Symfony Yaml 库的安装、基本操作和高级功能。您将学习如何将 YAML 转换为 PHP 数组以及反向转换，以及如何处理复杂结构。

安装库

Symfony Yaml 通过 Composer 安装。在项目根目录下执行以下命令：

composer require symfony/yaml

安装后，引入 Composer 的自动加载器并导入所需的类：

require 'vendor/autoload.php';

use Symfony\\Component\\Yaml\\Yaml;use Symfony\\Component\\Yaml\\Exception\\ParseException;

基本操作

解析 YAML 字符串

Yaml::parse() 方法将 YAML 字符串转换为 PHP 数组。以下是一个简单配置的示例：

$yamlString = "database:    host: localhost    port: 3306    name: mydb    user: admin    password: secret";

try {    $data = Yaml::parse($yamlString);    print_r($data);} catch (ParseException $e) {    echo 'YAML 解析错误：' . $e->getMessage();}

执行结果：

Array(    [database] => Array        (            [host] => localhost            [port] => 3306            [name] => mydb            [user] => admin            [password] => secret        ))

解析 YAML 文件

YAML 通常存储在文件中。要读取它们，请将 file_get_contents() 与解析器结合使用：

$yamlFile = __DIR__ . '/config.yaml';if (!file_exists($yamlFile)) {    die('未找到配置文件');}

try {    $config = Yaml::parse(file_get_contents($yamlFile));    echo '数据库主机：' . $config['database']['host'];} catch (ParseException $e) {    echo '读取文件错误：' . $e->getMessage();}

转储（写入）为 YAML

Yaml::dump() 方法将 PHP 数组转换回 YAML 字符串。这对于生成配置或导出数据非常有用：

$data = [    'app' => [        'name' => 'MyApp',        'version' => '1.0.0',        'debug' => true,        'modules' => ['auth', 'api', 'admin']    ]];

$yamlOutput = Yaml::dump($data, 3); // 第二个参数为嵌套级别file_put_contents('app_config.yaml', $yamlOutput);echo $yamlOutput;

文件中的结果：

app:    name: MyApp    version: '1.0.0'    debug: true    modules:        - auth        - api        - admin

高级功能

处理嵌套结构和特殊类型

Symfony Yaml 支持任意深度的嵌套，以及日期、null 和布尔值等特殊数据类型：

$complexYaml = "server:    host: 192.168.1.1    ports:        - 80        - 443        - 8080    settings:        timeout: 30        enabled: true        description: ~        created_at: 2024-01-15";

$parsed = Yaml::parse($complexYaml);var_dump($parsed['server']['settings']['enabled']); // bool(true)var_dump($parsed['server']['settings']['description']); // NULLvar_dump($parsed['server']['settings']['created_at']); // string(10) "2024-01-15"