Flutter列表转树形结构插件list_to_tree的使用

简介

list_to_tree 是一个用于将线性数组转换为树形结构的Dart包。

安装

要使用此插件，在您的 pubspec.yaml 文件中添加 list_to_tree 作为依赖项。

dependencies:
  list_to_tree: ^x.x.x

然后运行 flutter pub get 来安装该包。

使用方法

示例

以下是一个简单的示例，演示如何使用 list_to_tree 将一个线性数组转换为树形结构。

import 'dart:convert';

// 导入 list_to_tree 包
import 'package:list_to_tree/list_to_tree.dart';

// 定义一个基础实体类
class BaseEntity {
  final int id;
  final int? parentId;
  final List<BaseEntity> children;

  const BaseEntity({
    required this.id,
    required this.parentId,
    required this.children,
  });

  // 获取属性列表
  List<Object?> get props => [id, parentId, children];

  // 转换为JSON格式
  Map<String, dynamic> toJson() => {
        'id': id,
        'parentId': parentId,
        'children': children.map((e) => e.toJson()).toList(),
      };

  // 字符串表示
  @override
  String toString() {
    return JsonEncoder.withIndent('  ').convert(toJson());
  }

  // 创建空数组实例
  Object withArray() => BaseEntity(
        id: id,
        parentId: parentId,
        children: [],
      );
}

// 定义一个测试类继承自BaseEntity
class TestClass extends BaseEntity {
  final String title;

  const TestClass({
    required int id,
    required int? parentId,
    required List<TestClass> children,
    required this.title,
  }) : super(id: id, parentId: parentId, children: children);

  // 获取属性列表
  @override
  List<Object?> get props => [id, parentId, children, title];

  // 转换为JSON格式
  Map<String, dynamic> get toJson => {
        'id': id,
        'parentId': parentId,
        'title': title,
        'children': (children as List<TestClass>).map((e) => e.toJson).toList(),
      };

  // 字符串表示
  @override
  String toString() => JsonEncoder.withIndent('  ').convert(toJson);

  // 创建空数组实例
  @override
  Object withArray() => TestClass(
        id: id,
        parentId: parentId,
        children: [],
        title: title,
      );
}

void main() {
  // 初始化数据列表
  final items = [
    TestClass(id: 1, parentId: null, children: [], title: 'title1'),
    TestClass(id: 2, parentId: null, children: [], title: 'title2'),
    TestClass(id: 3, parentId: 1, children: [], title: 'title3'),
    TestClass(id: 4, parentId: 1, children: [], title: 'title4'),
    TestClass(id: 5, parentId: 2, children: [], title: 'title5'),
    TestClass(id: 6, parentId: 2, children: [], title: 'title6'),
    TestClass(id: 7, parentId: 3, children: [], title: 'title7'),
  ];

  // 打印原始数据
  print('原始数据:');
  print(items);

  // 将线性数组转换为树形结构
  final treeResult = ArrayToTree.instance.toTree(items);

  // 打印树形结构结果
  print('树形结构结果:');
  print(treeResult);
}

输出示例

原始数据:
[
  TestClass(
    id: 1,
    parentId: null,
    children: [
      TestClass(
        id: 3,
        parentId: 1,
        children: [
          TestClass(id: 7, parentId: 3, children: [], title: 'title7'),
        ],
        title: 'title3',
      ),
      TestClass(id: 4, parentId: 1, children: [], title: 'title4'),
    ],
    title: 'title1',
  ),
  TestClass(
    id: 2,
    parentId: null,
    children: [
      TestClass(id: 5, parentId: 2, children: [], title: 'title5'),
      TestClass(id: 6, parentId: 2, children: [], title: 'title6'),
    ],
    title: 'title2',
  )
]
树形结构结果:
[
  TestClass(
    id: 1,
    parentId: null,
    children: [
      TestClass(
        id: 3,
        parentId: 1,
        children: [
          TestClass(id: 7, parentId: 3, children: [], title: 'title7'),
        ],
        title: 'title3',
      ),
      TestClass(id: 4, parentId: 1, children: [], title: 'title4'),
    ],
    title: 'title1',
  ),
  TestClass(
    id: 2,
    parentId: null,
    children: [
      TestClass(id: 5, parentId: 2, children: [], title: 'title5'),
      TestClass(id: 6, parentId: 2, children: [], title: 'title6'),
    ],
    title: 'title2',
  )
]