PHP基于分隔符路径生成动态JSON树形结构教程

本教程详细介绍了如何使用php将包含分隔符路径的扁平化数据（如数据库记录）转换为符合fancytree等前端组件要求的嵌套json树形结构。通过利用php的引用机制，该方法能够高效处理任意深度的目录层级，自动合并共享路径，从而构建出清晰、可用的文件系统式树视图。

理解挑战：扁平数据与树形结构转换

在Web开发中，我们经常需要将数据库中存储的扁平化数据（例如文件路径、分类目录等）转换成具有层级关系的树形结构，以供前端树形组件（如FancyTree、jsTree等）渲染。一个常见的场景是，文件或目录的完整路径存储在一个字段中，并使用特定的分隔符（如点号.或斜杠/）来表示层级。

例如，以下是一个模拟数据库中的文件数据：

我们希望将这些数据转换成一个嵌套的JSON数组，其中URL字段中的点号.作为目录分隔符，name和type字段组合成文件名称，ID作为文件的唯一标识。

目标：FancyTree兼容的JSON格式

前端树形组件通常要求特定的JSON结构。对于FancyTree，期望的输出格式如下：

立即学习“PHP免费学习笔记（深入）”；

[
    {
        "title": "dir",
        "folder": true,
        "children": [
            {
                "title": "dir1",
                "folder": true,
                "children": [
                    {
                        "title": "test.txt",
                        "key": 1
                    }, {
                        "title": "next.txt",
                        "key": 2
                    }
                ]
            }, {
                "title": "main.txt",
                "key": 3
            }
        ]
    }
]

可以看到，目录节点包含"title"（目录名）、"folder": true和"children"数组；文件节点包含"title"（文件名）和"key"（唯一ID）。

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

30

查看详情

核心解决方案：基于引用的动态树构建

直接使用简单的循环或array_merge_recursive等方法来构建这种动态深度的树形结构，往往会遇到逻辑复杂、难以合并共享路径的问题。一个更健壮和高效的解决方案是利用PHP的引用（&）机制，模拟递归地构建目录路径，并最终将文件附加到正确的子目录中。

算法概述

1. 初始化一个空的 $result 数组，作为整个树的根。
2. 遍历从数据库获取的每一个文件（或数据项）。
3. 对于每个文件，解析其 URL 字段，通过分隔符将其拆分成一个目录层级数组。
4. 设置一个 $currentRoot 引用，最初指向 $result 数组。这个引用将随着目录层级的深入而移动。
5. 遍历目录层级数组中的每个目录名：
   • 在 $currentRoot 所指向的当前层级中，检查该目录是否已存在。
   • 如果不存在，则创建一个新的目录节点（包含 title、folder: true 和一个空的 children 数组），并将其添加到 $currentRoot 中。
   • 将 $currentRoot 引用更新为指向新创建或已存在的目录节点的 children 数组，从而深入到下一层级。
6. 当所有目录层级都处理完毕后，$currentRoot 将指向最深层目录的 children 数组。此时，将当前文件节点（包含 title 和 key）添加到 $currentRoot 中。
7. 每次处理完一个文件，解除 $currentRoot 等引用，防止意外的副作用。

PHP代码实现

假设我们已经从数据库中获取了数据，并将其存储在一个名为 $files 的数组中，其中每个元素都是一个对象或关联数组，包含 id, name, url, type 等字段。

<?php

// 模拟从数据库获取的数据
$files = [
    (object)['id' => 1, 'name' => 'test', 'url' => 'dir.dir1', 'type' => 'txt', 'code' => 'sometext'],
    (object)['id' => 2, 'name' => 'next', 'url' => 'dir.dir1', 'type' => 'txt', 'code' => 'somemoretext'],
    (object)['id' => 3, 'name' => 'main', 'url' => 'dir', 'type' => 'txt', 'code' => 'evenmoretext'],
    (object)['id' => 4, 'name' => 'another', 'url' => 'dir.dir1.subdir', 'type' => 'pdf', 'code' => 'pdfcontent'],
    (object)['id' => 5, 'name' => 'document', 'url' => 'root', 'type' => 'doc', 'code' => 'doccontent'],
];

$result = array();

foreach($files as $file)
{
    // 将URL路径按分隔符拆分为目录数组
    $directories = explode('.', $file->url);

    // 初始化当前根引用，指向最终结果数组
    $currentRoot = &$result;

    // 遍历所有目录，构建路径
    foreach($directories as $directory)
    {
        $dirFound = false;
        $dirRef = null;

        // 检查当前层级是否已存在该目录
        foreach($currentRoot as $i => $d)
        {
            // 确保是文件夹节点且标题匹配
            if(isset($d['folder']) && $d['folder'] && $d['title'] == $directory)
            {
                $dirRef = &$currentRoot[$i]; // 找到，设置引用
                $dirFound = true;
                break;
            }
        }

        // 如果目录不存在，则创建它
        if(!$dirFound)
        {
            $item = array(
                'title' => $directory,
                'folder' => true,
                'children' => array()
            );
            $currentRoot[] = $item; // 添加到当前层级
            $dirRef = &$currentRoot[count($currentRoot) - 1]; // 设置引用到新创建的目录
        }

        // 移动到下一个层级（即当前目录的children数组）
        $currentRoot = &$dirRef['children']; 
        // 解除$dirRef引用，避免其在循环外被意外修改
        unset($dirRef); 
    }

    // 路径构建完毕，将文件附加到最深层目录的children数组中
    $currentRoot[] = array(
        'title' => $file->name . '.' . $file->type, // 文件名和类型组合
        'key' => $file->id, // 文件ID作为key
    );

    // 解除$currentRoot引用，避免其在下一次循环中保留旧的引用
    unset($currentRoot);
}

// 输出JSON格式
echo json_encode($result, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);

?>

代码详解

1. $result = array();: 这是最终存储树形结构的根数组。
2. foreach($files as $file): 循环处理每一条扁平化的文件数据。
3. $directories = explode('.', $file->url);: 将文件的 url 字段按点号.分隔，得到一个目录名称数组。例如，"dir.dir1" 会变成 ['dir', 'dir1']。
4. $currentRoot = &$result;: 这一步至关重要。$currentRoot 是一个引用，它最初指向 $result 数组。在后续的循环中，它将不断更新，指向当前正在处理的目录层级的 children 数组。
5. foreach($directories as $directory): 遍历当前文件的所有目录层级。
6. 查找现有目录:
   • 内部循环 foreach($currentRoot as $i => $d) 用于在 $currentRoot 所指向的当前层级中查找名为 $directory 的文件夹。
   • if(isset($d['folder']) && $d['folder'] && $d['title'] == $directory)：确保找到的是一个文件夹节点，并且其 title 与当前要查找的目录名匹配。
   • $dirRef = &$currentRoot[$i];：如果找到了，将 $dirRef 引用指向这个已存在的目录节点，以便后续操作。
7. 创建新目录:
   • if(!$dirFound)：如果当前层级没有找到对应的目录，就创建一个新的目录节点。
   • $item = array('title' => $directory, 'folder' => true, 'children' => array());：定义新目录的结构。
   • $currentRoot[] = $item;：将新目录添加到当前层级（即 $currentRoot 所指向的数组）。
   • $dirRef = &$currentRoot[count($currentRoot) - 1];：将 $dirRef 引用指向刚刚添加的新目录，因为它是当前层级的最后一个元素。
8. 深入下一层级:
   • $currentRoot = &$dirRef['children'];：这一步是实现层级遍历的关键。$currentRoot 的引用被更新为指向当前处理的目录的 children 数组。这样，在下一次内层循环中，我们就会在这个新的 children 数组中查找或创建子目录。
   • unset($dirRef);：重要。在每次内层循环结束时，解除 $dirRef 的引用。这是为了防止它在下一次迭代中仍然指向旧的内存地址，导致意外行为。
9. 添加文件节点:
   • 当所有目录层级都处理完毕后，$currentRoot 引用将指向最深层目录的 children 数组。
   • $currentRoot[] = array('title' => $file->name . '.' . $file->type, 'key' => $file->id);：将最终的文件节点添加到这个 children 数组中。
10. 解除 $currentRoot 引用:
    • unset($currentRoot);：重要。在每次外层循环结束时，解除 $currentRoot 的引用。这确保了在处理下一个文件时，$currentRoot 会重新指向 $result 数组的根，而不是保留上一个文件的深层引用。

关键优势与注意事项

• 动态深度处理: 这种方法能够处理任意深度的目录层级，无需预知最大深度。
• 高效合并: 共享相同父目录的路径会自动合并，避免重复创建目录节点。
• 内存效率: 通过引用直接修改数组结构，而不是频繁地复制大型数组。
• FancyTree兼容: 生成的JSON结构直接符合FancyTree等前端组件的要求。

注意事项:

• 引用管理: PHP的引用功能强大但也需要谨慎使用。务必在不再需要引用时使用 unset() 解除，以避免意外的副作用和内存泄漏（尤其是在循环中）。
• 数据一致性: 确保 URL 字段的数据格式一致，分隔符使用正确。
• 性能: 对于海量数据，虽然此方法效率较高，但仍需考虑数据库查询优化和PHP脚本的执行时间。
• 错误处理: 在实际应用中，可能需要增加对 URL 格式错误、name 或 type 缺失等情况的健壮性检查。

总结

通过利用PHP的引用机制，我们可以优雅且高效地将扁平化的、包含分隔符路径的数据转换为复杂的嵌套JSON树形结构。这种方法特别适用于需要为前端树形组件（如FancyTree）提供数据的情况，它能够灵活地处理任意深度的目录层级，并确保共享路径的正确合并。理解并正确运用引用是实现这一目标的关键。

以上就是PHP基于分隔符路径生成动态JSON树形结构教程的详细内容，更多请关注php中文网其它相关文章！